Top Description Methods
org.hibernate.sql.results.graph

public Interface Fetch

extends DomainResultGraphNode
Known Direct Subinterfaces
org.hibernate.sql.results.graph.entity.EntityFetch, org.hibernate.sql.results.graph.BiDirectionalFetch
Known Direct Implementers
org.hibernate.sql.results.graph.basic.BasicFetch, org.hibernate.sql.results.graph.collection.internal.CollectionFetch, org.hibernate.sql.results.graph.embeddable.internal.AggregateEmbeddableFetchImpl, org.hibernate.sql.results.graph.embeddable.internal.EmbeddableFetchImpl, org.hibernate.metamodel.mapping.internal.DiscriminatedAssociationMapping.AnyValuedFetch
Annotations
@Incubating
Imports
org.hibernate.Incubating, org.hibernate.engine.FetchTiming, org.hibernate.spi.NavigablePath
Contract for fetches including entity, collection and composite. Acts as the producer for the DomainResultAssembler for this result as well as any Initializer instances needed
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public default FetchParent
asFetchParent()

Utility method to avoid instanceof checks.

public default boolean
containsAnyNonScalarResults()

Overrides default org.hibernate.sql.results.graph.DomainResultGraphNode.containsAnyNonScalarResults.

Does this node contain any non-scalar (sub-)results?
public DomainResultAssembler<?>
createAssembler(FetchParentAccess parentAccess, AssemblerCreationState creationState)

Create the assembler for this fetch

public Fetchable
getFetchedMapping()

The value mapping being fetched

public FetchParent
getFetchParent()

Obtain the owner of this fetch.

public NavigablePath

Returns:

The property path
getNavigablePath()

Redeclares as abstract: org.hibernate.sql.results.graph.DomainResultGraphNode.getNavigablePath.

Get the property path to this fetch
public FetchTiming
getTiming()

immediate or delayed?

public boolean
hasTableGroup()

Is the TableGroup associated with this Fetch defined?

Inherited from org.hibernate.sql.results.graph.DomainResultGraphNode:
appliesTogetResultJavaType

Method Detail

asFetchParentback to summary
public default FetchParent asFetchParent()

Utility method to avoid instanceof checks. Returns this if it's an instance of FetchParent, null otherwise.

containsAnyNonScalarResultsback to summary
public default boolean containsAnyNonScalarResults()

Overrides default org.hibernate.sql.results.graph.DomainResultGraphNode.containsAnyNonScalarResults.

Doc from org.hibernate.sql.results.graph.DomainResultGraphNode.containsAnyNonScalarResults.

Does this node contain any non-scalar (sub-)results?

Annotations
@Override
createAssemblerback to summary
public DomainResultAssembler<?> createAssembler(FetchParentAccess parentAccess, AssemblerCreationState creationState)

Create the assembler for this fetch

getFetchedMappingback to summary
public Fetchable getFetchedMapping()

The value mapping being fetched

getFetchParentback to summary
public FetchParent getFetchParent()

Obtain the owner of this fetch. Ultimately used to identify the thing that "owns" this fetched navigable for the purpose of:

* identifying the associated owner reference as we process the fetch * inject the fetched instance into the parent and potentially inject the parent reference into the fetched instance if it defines such injection (e.g. org.hibernate.annotations.Parent)

getNavigablePathback to summary
public NavigablePath getNavigablePath()

Redeclares as abstract: org.hibernate.sql.results.graph.DomainResultGraphNode.getNavigablePath.

Get the property path to this fetch

Returns:NavigablePath

The property path

getTimingback to summary
public FetchTiming getTiming()

immediate or delayed? todo (6.0) : should we also expose the fetch-style? Perhaps the fetch-options?

hasTableGroupback to summary
public boolean hasTableGroup()

Is the TableGroup associated with this Fetch defined?