接口 CollectionIndexDefinition
-
public interface CollectionIndexDefinition- 作者:
- Steve Ebersole
-
-
方法概要
所有方法 实例方法 抽象方法 修饰符和类型 方法 说明 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.
-
-
-
方法详细资料
-
getCollectionDefinition
CollectionDefinition getCollectionDefinition()
Returns the collection definition.- 返回:
- the collection definition.
-
getType
Type getType()
Returns the collection index type.- 返回:
- 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.- 返回:
- the entity definition for the collection index.
- 抛出:
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.- 返回:
- the composite index definition for the collection index.
- 抛出:
IllegalStateException- if the collection index type returned bygetType()is not of typeCompositeType.
-
toAnyMappingDefinition
AnyMappingDefinition toAnyMappingDefinition()
If the index type returned bygetType()is anAnyType, then the any mapping definition for the collection index is returned; otherwise, IllegalStateException is thrown.- 返回:
- the any mapping definition for the collection index.
- 抛出:
IllegalStateException- if the collection index type returned bygetType()is not of typeAnyType.
-
-