Interface CollectionIndexDefinition
-
public interface CollectionIndexDefinition
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CollectionDefinitiongetCollectionDefinition()Returns the collection definition.TypegetType()Returns the collection index type.AnyMappingDefinitiontoAnyMappingDefinition()CompositionDefinitiontoCompositeDefinition()If the index type returned bygetType()is aCompositeType, then the composite index definition for the collection index is returned; otherwise, IllegalStateException is thrown.EntityDefinitiontoEntityDefinition()If the index type returned bygetType()is anEntityType, then the entity definition for the collection index is returned; otherwise, IllegalStateException is thrown.
-
-
-
Method Detail
-
getCollectionDefinition
CollectionDefinition getCollectionDefinition()
Returns the collection definition.- Returns:
- the collection definition.
-
getType
Type getType()
Returns the collection index type.- Returns:
- the collection index type
-
toEntityDefinition
EntityDefinition toEntityDefinition()
If the index type returned bygetType()is anEntityType, then the entity definition for the collection index is returned; otherwise, IllegalStateException is thrown.- Returns:
- the entity definition for the collection index.
- Throws:
java.lang.IllegalStateException- if the collection index type returned bygetType()is not of typeEntityType.
-
toCompositeDefinition
CompositionDefinition toCompositeDefinition()
If the index type returned bygetType()is aCompositeType, then the composite index definition for the collection index is returned; otherwise, IllegalStateException is thrown.- Returns:
- the composite index definition for the collection index.
- Throws:
java.lang.IllegalStateException- if the collection index type returned bygetType()is not of typeCompositeType.
-
toAnyMappingDefinition
AnyMappingDefinition toAnyMappingDefinition()
-
-