org.hibernate.loader.plan2.spi

Interface CollectionReference

All Known Subinterfaces:

CollectionFetch, CollectionReturn

All Known Implementing Classes:

AbstractCollectionReference, CollectionFetchImpl, CollectionReturnImpl

public interface CollectionReference

Represents a reference to a persistent collection either as a Return or as a Fetch

Method Summary

Methods

Modifier and Type	Method and Description
CollectionPersister	getCollectionPersister() Retrieves the CollectionPersister describing the collection associated with this Return.
CollectionFetchableElement	getElementGraph() Retrieve the metadata about the elements of this collection *as a FetchSource*.
CollectionFetchableIndex	getIndexGraph() Retrieve the metadata about the index of this collection *as a FetchSource*.
PropertyPath	getPropertyPath() Retrieve the PropertyPath to this reference.
String	getQuerySpaceUid() Obtain the UID of the QuerySpace (specifically a CollectionQuerySpace) that this CollectionReference refers to.

Method Detail

getQuerySpaceUid

String getQuerySpaceUid()

Obtain the UID of the QuerySpace (specifically a CollectionQuerySpace) that this CollectionReference refers to.

Returns:

The UID

getCollectionPersister

CollectionPersister getCollectionPersister()

Retrieves the CollectionPersister describing the collection associated with this Return.

Returns:

The CollectionPersister.

getIndexGraph

CollectionFetchableIndex getIndexGraph()

Retrieve the metadata about the index of this collection *as a FetchSource*. Will return null when:

• the collection is not indexed
• the index is not a composite or entity (cannot act as a FetchSource)

Works only for map keys, since a List index (int type) cannot act as a FetchSource.

Returns:

The collection index metadata as a FetchSource, or null.

getElementGraph

CollectionFetchableElement getElementGraph()

Retrieve the metadata about the elements of this collection *as a FetchSource*. Will return null when the element is not a composite or entity (cannot act as a FetchSource). Works only for map keys, since a List index cannot be anything other than an int which cannot be a FetchSource.

Returns:

The collection element metadata as a FetchSource, or null.

getPropertyPath

PropertyPath getPropertyPath()

Retrieve the PropertyPath to this reference.

Returns:

The PropertyPath