SpaceTypeDescriptor (GigaSpaces 16.4.0 API)

All Known Subinterfaces:

ITypeDesc

All Known Implementing Classes:

InactiveTypeDesc, TypeDesc
```
public interface SpaceTypeDescriptor
```
Encapsulates information about a space type.

Since:

8.0

Author:

Niv Ingberg

See Also:

SpaceTypeDescriptorBuilder, SpacePropertyDescriptor, SpaceIndex

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
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.
`default int`	`getFixedPropertyPositionIgnoreCase(String name)`
`List<String>`	`getIdPropertiesNames()` Gets the ID properties names.
`default String`	`getIdPropertyName()` Deprecated. since 16.2 - use `getIdPropertiesNames()` instead.
`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.
`boolean[]`	`getPropertiesIndexTypes()`
`String[]`	`getPropertiesNames()`
`String[]`	`getPropertiesNames(boolean isPrimaryKeyFirst)`
`String[]`	`getPropertiesTypes()`
`TypeQueryExtensions`	`getQueryExtensions()`
`String`	`getRoutingPropertyName()` Gets the routing property name.
`int`	`getSequenceNumberFixedPropertyID()`
`StorageType`	`getStorageType()` Get the type storage type
`String`	`getSuperTypeName()` Gets the super type name
`TieredStorageTableConfig`	`getTieredStorageTableConfig()`
`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`	`isBroadcast()`
`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, case-insensitive
    
    Returns:
    
    Position of property.
  - getFixedPropertyPositionIgnoreCase
```
default int getFixedPropertyPositionIgnoreCase(String name)
```
  - 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
```
@Deprecated
default String getIdPropertyName()
```
    Deprecated. since 16.2 - use getIdPropertiesNames() instead.
    
    Gets the ID property name.
  - getIdPropertiesNames
```
List<String> getIdPropertiesNames()
```
    Gets the ID properties names.
  - 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
  - isBroadcast
```
boolean isBroadcast()
```
  - hasSequenceNumber
```
boolean hasSequenceNumber()
```
  - getSequenceNumberFixedPropertyID
```
int getSequenceNumberFixedPropertyID()
```
  - getQueryExtensions
```
TypeQueryExtensions getQueryExtensions()
```
  - getPropertiesNames
```
String[] getPropertiesNames()
```
  - getPropertiesNames
```
String[] getPropertiesNames(boolean isPrimaryKeyFirst)
```
  - getPropertiesTypes
```
String[] getPropertiesTypes()
```
  - getPropertiesIndexTypes
```
boolean[] getPropertiesIndexTypes()
```
  - getTieredStorageTableConfig
```
TieredStorageTableConfig getTieredStorageTableConfig()
```

Interface SpaceTypeDescriptor

Method Summary

Method Detail

getTypeName

getTypeSimpleName

getObjectClass

getDocumentWrapperClass

getFifoSupport

isReplicable

getNumOfFixedProperties

getFixedProperty

getFixedProperty

getFixedPropertyPosition

getFixedPropertyPositionIgnoreCase

supportsDynamicProperties

supportsOptimisticLocking

getIdPropertyName

getIdPropertiesNames

getRoutingPropertyName

getFifoGroupingPropertyPath

getFifoGroupingIndexesPaths

getIndexes

getStorageType

isConcreteType

isAutoGenerateId

getSuperTypeName

isBlobstoreEnabled

isBroadcast

hasSequenceNumber

getSequenceNumberFixedPropertyID

getQueryExtensions

getPropertiesNames

getPropertiesNames

getPropertiesTypes

getPropertiesIndexTypes

getTieredStorageTableConfig