com.gigaspaces.metadata

Interface SpaceTypeDescriptor

public interface SpaceTypeDescriptor

Encapsulates information about a space type.

Since:

8.0

Author:

Niv Ingberg

See Also:

SpaceTypeDescriptorBuilder, SpacePropertyDescriptor, SpaceIndex

Method Summary

Modifier and Type	Method and Description
Class<? extends SpaceDocument>	getDocumentWrapperClass() Gets the document wrapper class.
Set<String>	getFifoGroupingIndexesPaths() Gets the fifo grouping indexes
String	getFifoGroupingPropertyPath() Gets the fifo grouping property
FifoSupport	getFifoSupport() Gets the type's FIFO support.
SpacePropertyDescriptor	getFixedProperty(int position) Gets a fixed property by its position.
SpacePropertyDescriptor	getFixedProperty(String name) Gets a fixed property by its name.
int	getFixedPropertyPosition(String propertyName) Gets the position of a fixed property by the specified property name.
String	getIdPropertyName() Gets the ID property name.
Map<String,SpaceIndex>	getIndexes() Gets the indexes of the type, mapped by their names.
int	getNumOfFixedProperties() Gets the number of fixed properties of the type.
Class<? extends Object>	getObjectClass() Gets the java class which correlates to the type, if available.
String	getRoutingPropertyName() Gets the routing property name.
int	getSequenceNumberFixedPropertyID()
StorageType	getStorageType() Get the type storage type
String	getSuperTypeName() Gets the super type name
String	getTypeName() Gets the type name.
String	getTypeSimpleName() Gets the type simple name.
boolean	hasSequenceNumber()
boolean	isAutoGenerateId() Gets the autoGenerateId property
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	isReplicable() Returns true if this type is replicable, false otherwise.
boolean	supportsDynamicProperties() Returns true if this type supports dynamic properties, false otherwise.
boolean	supportsOptimisticLocking() Returns true if this type supports optimistic locking, false otherwise.

Method Detail

getTypeName

String getTypeName()

Gets the type name.

getTypeSimpleName

String getTypeSimpleName()

Gets the type simple name.

Since:

9.0.1

getObjectClass

Class<? extends Object> getObjectClass()

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

getDocumentWrapperClass

Class<? extends SpaceDocument> getDocumentWrapperClass()

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

getFifoSupport

FifoSupport getFifoSupport()

Gets the type's FIFO support.

See Also:

FifoSupport

isReplicable

boolean isReplicable()

Returns true if this type is replicable, false otherwise.

getNumOfFixedProperties

int getNumOfFixedProperties()

Gets the number of fixed properties of the type.

getFixedProperty

SpacePropertyDescriptor getFixedProperty(int position)

Gets a fixed property by its position.

Parameters:

position - Position of requested fixed property.

Returns:

Space property at specified position.

getFixedProperty

SpacePropertyDescriptor getFixedProperty(String name)

Gets a fixed property by its name.

Parameters:

name - Name of requested fixes property.

Returns:

Space property with specified name.

getFixedPropertyPosition

int getFixedPropertyPosition(String propertyName)

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

Parameters:

propertyName - Name of property to locate.

Returns:

Position of property.

supportsDynamicProperties

boolean supportsDynamicProperties()

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

supportsOptimisticLocking

boolean supportsOptimisticLocking()

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

getIdPropertyName

String getIdPropertyName()

Gets the ID property name.

getRoutingPropertyName

String getRoutingPropertyName()

Gets the routing property name.

getFifoGroupingPropertyPath

String getFifoGroupingPropertyPath()

Gets the fifo grouping property

getFifoGroupingIndexesPaths

Set<String> getFifoGroupingIndexesPaths()

Gets the fifo grouping indexes

getIndexes

Map<String,SpaceIndex> getIndexes()

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

See Also:

SpaceIndex

getStorageType

StorageType getStorageType()

Get the type storage type

isConcreteType

boolean isConcreteType()

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

isAutoGenerateId

boolean isAutoGenerateId()

Gets the autoGenerateId property

getSuperTypeName

String getSuperTypeName()

Gets the super type name

isBlobstoreEnabled

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. This attribute when set to "false" disables blob-store of classes and keeping the entries entirely cached.

Returns:

true if blobStore will be enabled

hasSequenceNumber

boolean hasSequenceNumber()

getSequenceNumberFixedPropertyID

int getSequenceNumberFixedPropertyID()