程序包 org.hibernate.loader.plan.spi

接口 CollectionReference

所有已知子接口:

CollectionAttributeFetch, CollectionReturn

所有已知实现类:

AbstractCollectionReference, CollectionAttributeFetchImpl, CollectionReturnImpl

public interface CollectionReference

Represents a reference to a persistent collection either as a Return or as a CollectionAttributeFetch.

作者:

Steve Ebersole

方法概要

修饰符和类型	方法	说明
boolean	allowElementJoin()	Should a collection element join be allowed?
boolean	allowIndexJoin()	Should a collection index join be allowed?
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.

方法详细资料

getQuerySpaceUid

String getQuerySpaceUid()

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

返回:

The UID

getCollectionPersister

CollectionPersister getCollectionPersister()

Retrieves the CollectionPersister describing the collection associated with this CollectionReference.

返回:

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

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

返回:

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, 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.

返回:

The collection element metadata as a FetchSource, or null.

getPropertyPath

PropertyPath getPropertyPath()

Retrieve the PropertyPath to this reference.

返回:

The PropertyPath

allowElementJoin

boolean allowElementJoin()

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

返回:

true, if a collection index join is allowed.

allowIndexJoin

boolean allowIndexJoin()

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

返回:

true, if a collection index join is allowed.