Top Methods
org.hibernate.persister.walking.spi

public Interface CollectionIndexDefinition

Imports
org.hibernate.type.Type
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public CollectionDefinition

Returns:

the collection definition.
getCollectionDefinition()

Returns the collection definition.

public Type

Returns:

the collection index type
getType()

Returns the collection index type.

public AnyMappingDefinition

Returns:

the any mapping definition for the collection index.
toAnyMappingDefinition()

If the index type returned by getType() is an org.hibernate.type.AnyType, then the any mapping definition for the collection index is returned; otherwise, IllegalStateException is thrown.

public CompositionDefinition

Returns:

the composite index definition for the collection index.
toCompositeDefinition()

If the index type returned by getType() is a org.hibernate.type.CompositeType, then the composite index definition for the collection index is returned; otherwise, IllegalStateException is thrown.

public EntityDefinition

Returns:

the entity definition for the collection index.
toEntityDefinition()

If the index type returned by getType() is an org.hibernate.type.EntityType, then the entity definition for the collection index is returned; otherwise, IllegalStateException is thrown.

Method Detail

getCollectionDefinitionback to summary
public CollectionDefinition getCollectionDefinition()

Returns the collection definition.

Returns:CollectionDefinition

the collection definition.

getTypeback to summary
public Type getType()

Returns the collection index type.

Returns:Type

the collection index type

toAnyMappingDefinitionback to summary
public AnyMappingDefinition toAnyMappingDefinition()

If the index type returned by getType() is an org.hibernate.type.AnyType, then the any mapping definition for the collection index is returned; otherwise, IllegalStateException is thrown.

Returns:AnyMappingDefinition

the any mapping definition for the collection index.

Exceptions
IllegalStateException:
if the collection index type returned by getType() is not of type org.hibernate.type.AnyType.
toCompositeDefinitionback to summary
public CompositionDefinition toCompositeDefinition()

If the index type returned by getType() is a org.hibernate.type.CompositeType, then the composite index definition for the collection index is returned; otherwise, IllegalStateException is thrown.

Returns:CompositionDefinition

the composite index definition for the collection index.

Exceptions
IllegalStateException:
if the collection index type returned by getType() is not of type org.hibernate.type.CompositeType.
toEntityDefinitionback to summary
public EntityDefinition toEntityDefinition()

If the index type returned by getType() is an org.hibernate.type.EntityType, then the entity definition for the collection index is returned; otherwise, IllegalStateException is thrown.

Returns:EntityDefinition

the entity definition for the collection index.

Exceptions
IllegalStateException:
if the collection index type returned by getType() is not of type org.hibernate.type.EntityType.