com.gigaspaces.internal.metadata

Class TypeDesc

java.lang.Object

com.gigaspaces.internal.metadata.TypeDesc

All Implemented Interfaces:

IDotnetTypeDescDetails, ITypeDesc, ISwapExternalizable, SpaceTypeDescriptor, Externalizable, Serializable, Cloneable

public class TypeDesc
extends Object
implements ITypeDesc

Since:

7.0

Author:

Niv Ingberg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_SUCH_PROPERTY

Constructor Summary

Constructors

Constructor and Description
TypeDesc() Default constructor for Externalizable.
TypeDesc(String typeName, String codeBase, String[] superTypesNames, PropertyInfo[] properties, boolean supportsDynamicProperties, Map<String,SpaceIndex> indexes, String idPropertyName, boolean idAutoGenerate, String defaultPropertyName, String routingPropertyName, String fifoGroupingName, Set<String> fifoGroupingIndexes, boolean systemType, FifoSupport fifoMode, boolean replicable, boolean supportsOptimisticLocking, StorageType storageType, EntryType entryType, Class<? extends Object> objectClass, Class<? extends ExternalEntry> externalEntryClass, Class<? extends SpaceDocument> documentWrapperClass, String dotnetDocumentWrapperType, byte dotnetStorageType, boolean blobstoreEnabled, String sequenceNumberPropertyName, TypeQueryExtensions queryExtensionsInfo)

Method Summary

Modifier and Type	Method and Description
boolean	anyCompoundIndex()
ITypeDesc	clone()
int	getChecksum()
String	getCodeBase()
List<SpaceIndex>	getCompoundIndexes()
String	getDefaultPropertyName()
Class<? extends SpaceDocument>	getDocumentWrapperClass() Gets the document wrapper class.
String	getDotnetDocumentWrapperTypeName()
byte	getDotnetDynamicPropertiesStorageType()
EntryTypeDesc	getEntryTypeDesc(EntryType entryType)
Set<String>	getFifoGroupingIndexesPaths() Gets the fifo grouping indexes
String	getFifoGroupingPropertyPath() Gets the fifo grouping property
FifoSupport	getFifoSupport() Gets the type's FIFO support.
PropertyInfo	getFixedProperty(int propertyID) Gets a fixed property by its position.
PropertyInfo	getFixedProperty(String propertyName) Gets a fixed property by its name.
int	getFixedPropertyPosition(String propertyName) Gets the position of a fixed property by the specified property name.
int	getIdentifierPropertyId()
String	getIdPropertyName() Gets the ID property name.
int	getIndexedPropertyID(int propertyID)
Map<String,SpaceIndex>	getIndexes() Gets the indexes of the type, mapped by their names.
SpaceIndexType	getIndexType(String indexName)
ITypeIntrospector	getIntrospector(EntryType entryType)
int	getNumOfFixedProperties() Gets the number of fixed properties of the type.
int	getNumOfIndexedProperties()
Class<? extends Object>	getObjectClass() Gets the java class which correlates to the type, if available.
EntryType	getObjectType()
String	getPrimitivePropertiesWithoutNullValues()
PropertyInfo[]	getProperties()
boolean[]	getPropertiesIndexTypes()
String[]	getPropertiesNames()
String[]	getPropertiesTypes()
TypeQueryExtensions	getQueryExtensions()
String[]	getRestrictSuperClassesNames()
int	getRoutingPropertyId()
String	getRoutingPropertyName() Gets the routing property name.
int	getSequenceNumberFixedPropertyID()
SpaceIdType	getSpaceIdType()
StorageType	getStorageType() Get the type storage type
String[]	getSuperClassesNames()
String	getSuperTypeName() Gets the super type name
String	getTypeName() Gets the type name.
String	getTypeSimpleName() Gets the type simple name.
Serializable	getVersionedSerializable()
boolean	hasSequenceNumber()
boolean	isAllPropertiesObjectStorageType()
boolean	isAutoGenerateId() Gets the autoGenerateId property
boolean	isAutoGenerateRouting()
boolean	isBlobstoreEnabled() When cache policy is "BLOB_STORE" only the indices + minimal administrative information will be kept in cache per entry, while the data will be kept as blobs.
boolean	isConcreteType() Gets if this is a concrete type, i.e representing a concrete class (Pojo).
boolean	isExternalizable()
boolean	isFifoDefault()
boolean	isFifoSupported()
boolean	isInactive()
boolean	isReplicable() Returns true if this type is replicable, false otherwise.
boolean	isSystemType()
void	readExternal(ObjectInput in)
void	readFromSwap(ObjectInput in)
boolean	supports(EntryType entryType)
boolean	supportsDynamicProperties() Returns true if this type supports dynamic properties, false otherwise.
boolean	supportsOptimisticLocking() Returns true if this type supports optimistic locking, false otherwise.
String	toString()
void	writeExternal(ObjectOutput out)
void	writeToSwap(ObjectOutput out)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_SUCH_PROPERTY

public static final int NO_SUCH_PROPERTY

See Also:

Constant Field Values

Constructor Detail

TypeDesc

public TypeDesc()

Default constructor for Externalizable.

TypeDesc

public TypeDesc(String typeName,
                String codeBase,
                String[] superTypesNames,
                PropertyInfo[] properties,
                boolean supportsDynamicProperties,
                Map<String,SpaceIndex> indexes,
                String idPropertyName,
                boolean idAutoGenerate,
                String defaultPropertyName,
                String routingPropertyName,
                String fifoGroupingName,
                Set<String> fifoGroupingIndexes,
                boolean systemType,
                FifoSupport fifoMode,
                boolean replicable,
                boolean supportsOptimisticLocking,
                StorageType storageType,
                EntryType entryType,
                Class<? extends Object> objectClass,
                Class<? extends ExternalEntry> externalEntryClass,
                Class<? extends SpaceDocument> documentWrapperClass,
                String dotnetDocumentWrapperType,
                byte dotnetStorageType,
                boolean blobstoreEnabled,
                String sequenceNumberPropertyName,
                TypeQueryExtensions queryExtensionsInfo)

Method Detail

clone

public ITypeDesc clone()

Specified by:

clone in interface ITypeDesc

Overrides:

clone in class Object

isInactive

public boolean isInactive()

Specified by:

isInactive in interface ITypeDesc

getTypeName

public String getTypeName()

Description copied from interface: SpaceTypeDescriptor

Gets the type name.

Specified by:

getTypeName in interface SpaceTypeDescriptor

getTypeSimpleName

public String getTypeSimpleName()

Description copied from interface: SpaceTypeDescriptor

Gets the type simple name.

Specified by:

getTypeSimpleName in interface SpaceTypeDescriptor

getObjectClass

public Class<? extends Object> getObjectClass()

Description copied from interface: SpaceTypeDescriptor

Gets the java class which correlates to the type, if available.

Specified by:

getObjectClass in interface SpaceTypeDescriptor

getDocumentWrapperClass

public Class<? extends SpaceDocument> getDocumentWrapperClass()

Description copied from interface: SpaceTypeDescriptor

Gets the document wrapper class. If a document wrapper class was not set, SpaceDocument class is returned.

Specified by:

getDocumentWrapperClass in interface SpaceTypeDescriptor

getCodeBase

public String getCodeBase()

Specified by:

getCodeBase in interface ITypeDesc

isExternalizable

public boolean isExternalizable()

Specified by:

isExternalizable in interface ITypeDesc

getSuperClassesNames

public String[] getSuperClassesNames()

Specified by:

getSuperClassesNames in interface ITypeDesc

getSuperTypeName

public String getSuperTypeName()

Description copied from interface: SpaceTypeDescriptor

Gets the super type name

Specified by:

getSuperTypeName in interface SpaceTypeDescriptor

getRestrictSuperClassesNames

public String[] getRestrictSuperClassesNames()

Specified by:

getRestrictSuperClassesNames in interface ITypeDesc

getProperties

public PropertyInfo[] getProperties()

Specified by:

getProperties in interface ITypeDesc

getNumOfFixedProperties

public int getNumOfFixedProperties()

Description copied from interface: SpaceTypeDescriptor

Gets the number of fixed properties of the type.

Specified by:

getNumOfFixedProperties in interface ITypeDesc

Specified by:

getNumOfFixedProperties in interface SpaceTypeDescriptor

getFixedProperty

public PropertyInfo getFixedProperty(int propertyID)

Description copied from interface: SpaceTypeDescriptor

Gets a fixed property by its position.

Specified by:

getFixedProperty in interface ITypeDesc

Specified by:

getFixedProperty in interface SpaceTypeDescriptor

Parameters:

propertyID - Position of requested fixed property.

Returns:

Space property at specified position.

getFixedPropertyPosition

public int getFixedPropertyPosition(String propertyName)

Description copied from interface: SpaceTypeDescriptor

Gets the position of a fixed property by the specified property name. If there's no fixed property with that name, -1 is returned.

Specified by:

getFixedPropertyPosition in interface SpaceTypeDescriptor

Parameters:

propertyName - Name of property to locate.

Returns:

Position of property.

getFixedProperty

public PropertyInfo getFixedProperty(String propertyName)

Description copied from interface: SpaceTypeDescriptor

Gets a fixed property by its name.

Specified by:

getFixedProperty in interface SpaceTypeDescriptor

Parameters:

propertyName - Name of requested fixes property.

Returns:

Space property with specified name.

supportsDynamicProperties

public boolean supportsDynamicProperties()

Description copied from interface: SpaceTypeDescriptor

Returns true if this type supports dynamic properties, false otherwise.

Specified by:

supportsDynamicProperties in interface SpaceTypeDescriptor

supportsOptimisticLocking

public boolean supportsOptimisticLocking()

Description copied from interface: SpaceTypeDescriptor

Returns true if this type supports optimistic locking, false otherwise.

Specified by:

supportsOptimisticLocking in interface SpaceTypeDescriptor

getNumOfIndexedProperties

public int getNumOfIndexedProperties()

Specified by:

getNumOfIndexedProperties in interface ITypeDesc

getIndexedPropertyID

public int getIndexedPropertyID(int propertyID)

Specified by:

getIndexedPropertyID in interface ITypeDesc

getIdentifierPropertyId

public int getIdentifierPropertyId()

Specified by:

getIdentifierPropertyId in interface ITypeDesc

getIdPropertyName

public String getIdPropertyName()

Description copied from interface: SpaceTypeDescriptor

Gets the ID property name.

Specified by:

getIdPropertyName in interface SpaceTypeDescriptor

getSpaceIdType

public SpaceIdType getSpaceIdType()

Specified by:

getSpaceIdType in interface ITypeDesc

isAutoGenerateId

public boolean isAutoGenerateId()

Description copied from interface: SpaceTypeDescriptor

Gets the autoGenerateId property

Specified by:

isAutoGenerateId in interface ITypeDesc

Specified by:

isAutoGenerateId in interface SpaceTypeDescriptor

isAutoGenerateRouting

public boolean isAutoGenerateRouting()

Specified by:

isAutoGenerateRouting in interface ITypeDesc

getRoutingPropertyId

public int getRoutingPropertyId()

Specified by:

getRoutingPropertyId in interface ITypeDesc

getRoutingPropertyName

public String getRoutingPropertyName()

Description copied from interface: SpaceTypeDescriptor

Gets the routing property name.

Specified by:

getRoutingPropertyName in interface SpaceTypeDescriptor

getDefaultPropertyName

public String getDefaultPropertyName()

Specified by:

getDefaultPropertyName in interface ITypeDesc

isFifoSupported

public boolean isFifoSupported()

Specified by:

isFifoSupported in interface ITypeDesc

isFifoDefault

public boolean isFifoDefault()

Specified by:

isFifoDefault in interface ITypeDesc

getFifoSupport

public FifoSupport getFifoSupport()

Description copied from interface: SpaceTypeDescriptor

Gets the type's FIFO support.

Specified by:

getFifoSupport in interface SpaceTypeDescriptor

See Also:

FifoSupport

isSystemType

public boolean isSystemType()

Specified by:

isSystemType in interface ITypeDesc

isReplicable

public boolean isReplicable()

Description copied from interface: SpaceTypeDescriptor

Returns true if this type is replicable, false otherwise.

Specified by:

isReplicable in interface SpaceTypeDescriptor

isBlobstoreEnabled

public boolean isBlobstoreEnabled()

Description copied from interface: SpaceTypeDescriptor

When cache policy is "BLOB_STORE" only the indices + minimal administrative information will be kept in cache per entry, while the data will be kept as blobs. This attribute when set to "false" disables blob-store of classes and keeping the entries entirely cached.

Specified by:

isBlobstoreEnabled in interface SpaceTypeDescriptor

Returns:

true if blobStore will be enabled

getObjectType

public EntryType getObjectType()

Specified by:

getObjectType in interface ITypeDesc

getPropertiesNames

public String[] getPropertiesNames()

Specified by:

getPropertiesNames in interface SpaceTypeDescriptor

getPropertiesTypes

public String[] getPropertiesTypes()

Specified by:

getPropertiesTypes in interface SpaceTypeDescriptor

getPropertiesIndexTypes

public boolean[] getPropertiesIndexTypes()

Specified by:

getPropertiesIndexTypes in interface SpaceTypeDescriptor

getChecksum

public int getChecksum()

Specified by:

getChecksum in interface ITypeDesc

isConcreteType

public boolean isConcreteType()

Description copied from interface: SpaceTypeDescriptor

Gets if this is a concrete type, i.e representing a concrete class (Pojo).

Specified by:

isConcreteType in interface SpaceTypeDescriptor

supports

public boolean supports(EntryType entryType)

Specified by:

supports in interface ITypeDesc

getEntryTypeDesc

public EntryTypeDesc getEntryTypeDesc(EntryType entryType)

Specified by:

getEntryTypeDesc in interface ITypeDesc

getIntrospector

public ITypeIntrospector getIntrospector(EntryType entryType)

Specified by:

getIntrospector in interface ITypeDesc

getIndexes

public Map<String,SpaceIndex> getIndexes()

Description copied from interface: SpaceTypeDescriptor

Gets the indexes of the type, mapped by their names.

Specified by:

getIndexes in interface ITypeDesc

Specified by:

getIndexes in interface SpaceTypeDescriptor

See Also:

SpaceIndex

getQueryExtensions

public TypeQueryExtensions getQueryExtensions()

Specified by:

getQueryExtensions in interface SpaceTypeDescriptor

getIndexType

public SpaceIndexType getIndexType(String indexName)

Specified by:

getIndexType in interface ITypeDesc

getDotnetDynamicPropertiesStorageType

public byte getDotnetDynamicPropertiesStorageType()

Specified by:

getDotnetDynamicPropertiesStorageType in interface IDotnetTypeDescDetails

getDotnetDocumentWrapperTypeName

public String getDotnetDocumentWrapperTypeName()

Specified by:

getDotnetDocumentWrapperTypeName in interface IDotnetTypeDescDetails

getPrimitivePropertiesWithoutNullValues

public String getPrimitivePropertiesWithoutNullValues()

Specified by:

getPrimitivePropertiesWithoutNullValues in interface ITypeDesc

hasSequenceNumber

public boolean hasSequenceNumber()

Specified by:

hasSequenceNumber in interface SpaceTypeDescriptor

getSequenceNumberFixedPropertyID

public int getSequenceNumberFixedPropertyID()

Specified by:

getSequenceNumberFixedPropertyID in interface SpaceTypeDescriptor

toString

public String toString()

Overrides:

toString in class Object

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

readFromSwap

public void readFromSwap(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readFromSwap in interface ISwapExternalizable

Throws:

IOException

ClassNotFoundException

isAllPropertiesObjectStorageType

public boolean isAllPropertiesObjectStorageType()

Specified by:

isAllPropertiesObjectStorageType in interface ITypeDesc

getStorageType

public StorageType getStorageType()

Description copied from interface: SpaceTypeDescriptor

Get the type storage type

Specified by:

getStorageType in interface SpaceTypeDescriptor

getFifoGroupingPropertyPath

public String getFifoGroupingPropertyPath()

Description copied from interface: SpaceTypeDescriptor

Gets the fifo grouping property

Specified by:

getFifoGroupingPropertyPath in interface SpaceTypeDescriptor

getFifoGroupingIndexesPaths

public Set<String> getFifoGroupingIndexesPaths()

Description copied from interface: SpaceTypeDescriptor

Gets the fifo grouping indexes

Specified by:

getFifoGroupingIndexesPaths in interface SpaceTypeDescriptor

getCompoundIndexes

public List<SpaceIndex> getCompoundIndexes()

Specified by:

getCompoundIndexes in interface ITypeDesc

anyCompoundIndex

public boolean anyCompoundIndex()

Specified by:

anyCompoundIndex in interface ITypeDesc

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

writeToSwap

public void writeToSwap(ObjectOutput out)
                 throws IOException

Specified by:

writeToSwap in interface ISwapExternalizable

Throws:

IOException

getVersionedSerializable

public Serializable getVersionedSerializable()

Specified by:

getVersionedSerializable in interface ITypeDesc