Top Description Methods
org.hibernate.loader.plan.spi

public Interface CollectionReference

Known Direct Subinterfaces
org.hibernate.loader.plan.spi.CollectionReturn, org.hibernate.loader.plan.spi.CollectionAttributeFetch
Known Direct Implementers
org.hibernate.loader.plan.build.internal.returns.AbstractCollectionReference
Imports
org.hibernate.loader.PropertyPath, org.hibernate.persister.collection.CollectionPersister
Represents a reference to a persistent collection either as a Return or as a CollectionAttributeFetch.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true, if a collection index join is allowed.
allowElementJoin()

Should a collection element join be allowed?

public boolean

Returns:

true, if a collection index join is allowed.
allowIndexJoin()

Should a collection index join be allowed?

public CollectionPersister

Returns:

The CollectionPersister.
getCollectionPersister()

Retrieves the CollectionPersister describing the collection associated with this CollectionReference.

public CollectionFetchableElement

Returns:

The collection element metadata as a FetchSource, or null.
getElementGraph()

Retrieve the metadata about the elements of this collection *as a FetchSource*.

public CollectionFetchableIndex

Returns:

The collection index metadata as a FetchSource, or null.
getIndexGraph()

Retrieve the metadata about the index of this collection *as a FetchSource*.

public PropertyPath

Returns:

The PropertyPath
getPropertyPath()

Retrieve the PropertyPath to this reference.

public String

Returns:

The UID
getQuerySpaceUid()

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

Method Detail

allowElementJoinback to summary
public boolean allowElementJoin()

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

Returns:boolean

true, if a collection index join is allowed.

allowIndexJoinback to summary
public boolean allowIndexJoin()

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

Returns:boolean

true, if a collection index join is allowed.

getCollectionPersisterback to summary
public CollectionPersister getCollectionPersister()

Retrieves the CollectionPersister describing the collection associated with this CollectionReference.

Returns:CollectionPersister

The CollectionPersister.

getElementGraphback to summary
public CollectionFetchableElement getElementGraph()

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.

Returns:CollectionFetchableElement

The collection element metadata as a FetchSource, or null.

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

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

Returns:CollectionFetchableIndex

The collection index metadata as a FetchSource, or null.

getPropertyPathback to summary
public PropertyPath getPropertyPath()

Retrieve the PropertyPath to this reference.

Returns:PropertyPath

The PropertyPath

getQuerySpaceUidback to summary
public String getQuerySpaceUid()

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

Returns:String

The UID