Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.sql.results.graph.Fetchable

Method Summary

Modifier and Type	Method and Description
public default AttributeMapping	asAttributeMapping() Overrides default org.hibernate.metamodel.mapping.ModelPart.asAttributeMapping.
public Fetch	generateFetch(FetchParent The parent of the Fetch we are generating fetchParent, NavigablePath The overall path within the graph fetchablePath, FetchTiming The requested fetch timing fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState) Generates a Fetch of this fetchable
public int	getFetchableKey() The key that identifies this Fetchable within a `FetchableContainer`.
public String	getFetchableName() The name of the fetchable.
public FetchOptions	getMappedFetchOptions() The configured fetch timing and style
public default boolean	incrementFetchDepth() Should this Fetchable affect the fetch depth?
public default boolean	isSelectable()
public default Fetch	Returns: The Fetch representing the circularity; `null` indicates the fetch is not circular resolveCircularFetch(NavigablePath The overall path within the graph fetchablePath, FetchParent fetchParent, FetchTiming fetchTiming, DomainResultCreationState creationState) Check whether this Fetchable is considered a circular fetch.

asAttributeMapping	back to summary
public default AttributeMapping asAttributeMapping() Overrides default org.hibernate.metamodel.mapping.ModelPart.asAttributeMapping.

generateFetch	back to summary
public Fetch generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState) Generates a Fetch of this fetchable Parameters fetchParent:FetchParent The parent of the Fetch we are generating fetchablePath:NavigablePath The overall path within the graph fetchTiming:FetchTiming The requested fetch timing

getFetchableKey back to summary

getFetchableKey	back to summary
public int getFetchableKey() The key that identifies this Fetchable within a `FetchableContainer`. If this Fetchable is part of `FetchableContainer#visitFetchables(IndexedConsumer, EntityMappingType)`, the values is guaranteed to be between 0 (inclusive) and `FetchableContainer#getNumberOfFetchableKeys()` (exclusive). Other Fetchable objects may have a special negative value. The main intent of this key is to index e.g. `Fetch` objects in an array.

public int getFetchableKey()

The key that identifies this Fetchable within a FetchableContainer. If this Fetchable is part of FetchableContainer#visitFetchables(IndexedConsumer, EntityMappingType), the values is guaranteed to be between 0 (inclusive) and FetchableContainer#getNumberOfFetchableKeys() (exclusive). Other Fetchable objects may have a special negative value.

The main intent of this key is to index e.g. Fetch objects in an array.

getFetchableName back to summary

getFetchableName	back to summary
public String getFetchableName() The name of the fetchable. This is the part's "local name". See Also `getNavigableRole()`, `NavigableRole#getLocalName()`

public String getFetchableName()

The name of the fetchable. This is the part's "local name".

getMappedFetchOptions	back to summary
public FetchOptions getMappedFetchOptions() The configured fetch timing and style

incrementFetchDepth back to summary

incrementFetchDepth	back to summary
public default boolean incrementFetchDepth() Should this Fetchable affect the fetch depth? E.g., composites would generally not increment the fetch depth. See Also `org.hibernate.cfg.AvailableSettings#MAX_FETCH_DEPTH`

public default boolean incrementFetchDepth()

Should this Fetchable affect the fetch depth? E.g., composites would generally not increment the fetch depth.

isSelectable	back to summary
public default boolean isSelectable()

resolveCircularFetch	back to summary
public default Fetch resolveCircularFetch(NavigablePath fetchablePath, FetchParent fetchParent, FetchTiming fetchTiming, DomainResultCreationState creationState) Check whether this Fetchable is considered a circular fetch. Parameters fetchablePath:NavigablePath The overall path within the graph Returns:Fetch The Fetch representing the circularity; `null` indicates the fetch is not circular