org.hibernate.loader.plan.spi

Interface FetchSource

All Known Subinterfaces:

AnyAttributeFetch, BidirectionalEntityReference, CollectionFetchableElement, CollectionFetchableIndex, CompositeAttributeFetch, CompositeFetch, EntityFetch, EntityReference, EntityReturn, ExpandingEntityIdentifierDescription, ExpandingFetchSource

All Known Implementing Classes:

AbstractAnyReference, AbstractCompositeEntityIdentifierDescription, AbstractCompositeFetch, AbstractCompositeReference, AbstractEntityReference, AbstractExpandingFetchSource, AnyAttributeFetchImpl, BidirectionalEntityReferenceImpl, CollectionFetchableElementAnyGraph, CollectionFetchableElementCompositeGraph, CollectionFetchableElementEntityGraph, CollectionFetchableIndexAnyGraph, CollectionFetchableIndexCompositeGraph, CollectionFetchableIndexEntityGraph, CompositeAttributeFetchImpl, EncapsulatedEntityIdentifierDescription, EntityAttributeFetchImpl, EntityReturnImpl, NestedCompositeAttributeFetchImpl, NonEncapsulatedEntityIdentifierDescription

public interface FetchSource

Contract for a FetchSource (aka, the thing that owns the fetched attribute).

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
BidirectionalEntityReference[]	getBidirectionalEntityReferences() Retrieve the bidirectional entity references owned by this fetch source.
Fetch[]	getFetches() Retrieve the fetches owned by this fetch source.
PropertyPath	getPropertyPath() Get the property path to this fetch source
String	getQuerySpaceUid() Get the UID for this fetch source's query space.
EntityReference	resolveEntityReference() Resolve the "current" EntityReference, or null if none.

Method Detail

getPropertyPath

PropertyPath getPropertyPath()

Get the property path to this fetch source

Returns:

The property path

getQuerySpaceUid

String getQuerySpaceUid()

Get the UID for this fetch source's query space.

Returns:

The query space UID.

getFetches

Fetch[] getFetches()

Retrieve the fetches owned by this fetch source.

Returns:

The owned fetches.

getBidirectionalEntityReferences

BidirectionalEntityReference[] getBidirectionalEntityReferences()

Retrieve the bidirectional entity references owned by this fetch source.

Returns:

The owned bidirectional entity references.

resolveEntityReference

EntityReference resolveEntityReference()

Resolve the "current" EntityReference, or null if none. If this object is an EntityReference, then this object is returned; otherwise, if this object is a Fetch, then the nearest EntityReference will be resolved from its source, if possible. If no EntityReference can be resolved, null is return.

Returns:

the "current" EntityReference or null if none. .

See Also:

Fetch.getSource().