public interface CollectionReference
Represents a reference to a persistent collection either as a Return or as a CollectionAttributeFetch
.
Modifier and Type | Method and Description |
---|---|
boolean |
allowElementJoin()
Should a collection element join be allowed? Returning <code>true</code>
indicates that an element join can safely be added.
|
boolean |
allowIndexJoin()
Should a collection index join be allowed? Returning <code>true</code>
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. |
String getQuerySpaceUid()
Obtain the UID of the QuerySpace (specifically a CollectionQuerySpace
) that this CollectionReference
refers to.
CollectionPersister getCollectionPersister()
Retrieves the CollectionPersister describing the collection associated with this CollectionReference.
CollectionFetchableIndex getIndexGraph()
Retrieve the metadata about the index of this collection as a FetchSource. Will return
null
when:<ul>
<li>the collection is not indexed</li>
<li>the index is not a composite, entity, or "any" (cannot act as a FetchSource)</li>
</ul>
<p/>
Works only for map keys, since a List index (int type) cannot act as a FetchSource.
<p/>
null
.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.
<p/>
null
.PropertyPath getPropertyPath()
Retrieve the PropertyPath to this reference.
boolean allowElementJoin()
Should a collection element join be allowed? Returning <code>true</code> indicates that an element join can safely be added.
boolean allowIndexJoin()
Should a collection index join be allowed? Returning <code>true</code> indicates that an index join can safely be added.
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.