Interface CollectionIndexDefinition


  • public interface CollectionIndexDefinition
    • 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 by getType() is an EntityType, 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 by getType() is not of type EntityType.
      • toCompositeDefinition

        CompositionDefinition toCompositeDefinition()
        If the index type returned by getType() is a CompositeType, 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 by getType() is not of type CompositeType.
      • toAnyMappingDefinition

        AnyMappingDefinition toAnyMappingDefinition()
        If the index type returned by getType() is an AnyType, then the any mapping definition for the collection index is returned; otherwise, IllegalStateException is thrown.
        Returns:
        the any mapping definition for the collection index.
        Throws:
        java.lang.IllegalStateException - if the collection index type returned by getType() is not of type AnyType.