org.hibernate.loader.plan.build.internal.returns

Class AbstractCollectionReference

java.lang.Object

org.hibernate.loader.plan.build.internal.returns.AbstractCollectionReference

All Implemented Interfaces:

CollectionReference

Direct Known Subclasses:

CollectionAttributeFetchImpl, CollectionReturnImpl

public abstract class AbstractCollectionReference
extends Object
implements CollectionReference

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCollectionReference(ExpandingCollectionQuerySpace collectionQuerySpace, PropertyPath propertyPath, boolean shouldIncludeJoins)

Method Summary

Modifier and Type	Method and Description
boolean	allowElementJoin() Should a collection element join be allowed? Returning true indicates that an element join can safely be added.
boolean	allowIndexJoin() Should a collection index join be allowed? Returning true indicates that an index join can safely be added.
CollectionPersister	getCollectionPersister() Retrieves the CollectionPersister describing the collection associated with this CollectionReference.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractCollectionReference

protected AbstractCollectionReference(ExpandingCollectionQuerySpace collectionQuerySpace,
                                      PropertyPath propertyPath,
                                      boolean shouldIncludeJoins)

Method Detail

allowElementJoin

public boolean allowElementJoin()

Description copied from interface: CollectionReference

Should a collection element join be allowed? Returning true indicates that an element join can safely be added.

Specified by:

allowElementJoin in interface CollectionReference

Returns:

true, if a collection index join is allowed.

allowIndexJoin

public boolean allowIndexJoin()

Description copied from interface: CollectionReference

Should a collection index join be allowed? Returning true indicates that an index join can safely be added.

Specified by:

allowIndexJoin in interface CollectionReference

Returns:

true, if a collection index join is allowed.

getQuerySpaceUid

public String getQuerySpaceUid()

Description copied from interface: CollectionReference

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

Specified by:

getQuerySpaceUid in interface CollectionReference

Returns:

The UID

getCollectionPersister

public CollectionPersister getCollectionPersister()

Description copied from interface: CollectionReference

Retrieves the CollectionPersister describing the collection associated with this CollectionReference.

Specified by:

getCollectionPersister in interface CollectionReference

Returns:

The CollectionPersister.

getIndexGraph

public CollectionFetchableIndex getIndexGraph()

Description copied from interface: CollectionReference

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, entity, or "any" (cannot act as a FetchSource)

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

Specified by:

getIndexGraph in interface CollectionReference

Returns:

The collection index metadata as a FetchSource, or null.

getElementGraph

public CollectionFetchableElement getElementGraph()

Description copied from interface: CollectionReference

Retrieve the metadata about the elements of this collection *as a FetchSource*. Will return null when the element is not a composite, entity, or "any" (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.

Specified by:

getElementGraph in interface CollectionReference

Returns:

The collection element metadata as a FetchSource, or null.

getPropertyPath

public PropertyPath getPropertyPath()

Description copied from interface: CollectionReference

Retrieve the PropertyPath to this reference.

Specified by:

getPropertyPath in interface CollectionReference

Returns:

The PropertyPath