Top Description Methods

org.hibernate.sql.results.graph

public Interface DomainResultCreationState

Known Direct Implementers

org.hibernate.loader.ast.internal.LoaderSqlAstCreationState, org.hibernate.query.results.DomainResultCreationStateImpl, org.hibernate.query.sqm.sql.BaseSqmToSqlAstConverter

Annotations

@Incubating

Imports

org.hibernate.Incubating, org.hibernate.engine.FetchTiming, org.hibernate.metamodel.mapping.AssociationKey, .EntityDiscriminatorMapping, .EntityIdentifierMapping, .EntityMappingType, .ForeignKeyDescriptor, .ModelPart, org.hibernate.spi.EntityIdentifierNavigablePath, .NavigablePath, org.hibernate.sql.ast.spi.SqlAliasBaseManager, .SqlAstCreationState, org.hibernate.sql.results.graph.basic.BasicFetch, org.hibernate.sql.results.graph.entity.EntityResultGraphNode, org.hibernate.sql.results.graph.internal.ImmutableFetchList

Contains state related to building DomainResult and Fetch graphs

Author: Steve Ebersole

Method Summary

Modifier and Type	Method and Description
public default boolean	forceIdentifierSelection() Whether forcing the selection of the identifier is in effect for this creation
public ForeignKeyDescriptor.Nature	getCurrentlyResolvingForeignKeyPart() Returns the part of the foreign key that is currently being resolved, or `null` if no foreign key is currently being resolved.
public default SqlAliasBaseManager	getSqlAliasBaseManager() Access to the SQL alias helper
public SqlAstCreationState	getSqlAstCreationState() The underlying state for SQL AST creation
public default boolean	isAssociationKeyVisited(AssociationKey circularityKey) Checks whether the given circularityKey is registered
public default boolean	isRegisteringVisitedAssociationKeys() Is this state accepting circularity detection keys?
public boolean	isResolvingCircularFetch()
public default boolean	registerVisitedAssociationKey(AssociationKey circularityKey) Registers a circularity detection key
public default void	removeVisitedAssociationKey(AssociationKey circularityKey) Removes the registration of a circularity detection key
public ModelPart	resolveModelPart(NavigablePath navigablePath) Resolve the ModelPart associated with a given NavigablePath.
public void	setCurrentlyResolvingForeignKeyPart(ForeignKeyDescriptor.Nature currentlyResolvingForeignKeySide)
public void	setResolvingCircularFetch(boolean resolvingCircularFetch)
public default BasicFetch<?>	visitDiscriminatorFetch(EntityResultGraphNode fetchParent)
public ImmutableFetchList	visitFetches(FetchParent fetchParent) Visit fetches for the given parent.
public default Fetch	visitIdentifierFetch(EntityResultGraphNode fetchParent)
public ImmutableFetchList	visitNestedFetches(FetchParent fetchParent)

Method Detail

forceIdentifierSelection	back to summary
public default boolean forceIdentifierSelection() Whether forcing the selection of the identifier is in effect for this creation

getCurrentlyResolvingForeignKeyPart	back to summary
public ForeignKeyDescriptor.Nature getCurrentlyResolvingForeignKeyPart() Returns the part of the foreign key that is currently being resolved, or `null` if no foreign key is currently being resolved.

getSqlAliasBaseManager	back to summary
public default SqlAliasBaseManager getSqlAliasBaseManager() Access to the SQL alias helper

getSqlAstCreationState	back to summary
public SqlAstCreationState getSqlAstCreationState() The underlying state for SQL AST creation

isAssociationKeyVisited	back to summary
public default boolean isAssociationKeyVisited(AssociationKey circularityKey) Checks whether the given circularityKey is registered

isRegisteringVisitedAssociationKeys	back to summary
public default boolean isRegisteringVisitedAssociationKeys() Is this state accepting circularity detection keys?

isResolvingCircularFetch	back to summary
public boolean isResolvingCircularFetch()

registerVisitedAssociationKey	back to summary
public default boolean registerVisitedAssociationKey(AssociationKey circularityKey) Registers a circularity detection key

removeVisitedAssociationKey	back to summary
public default void removeVisitedAssociationKey(AssociationKey circularityKey) Removes the registration of a circularity detection key

resolveModelPart	back to summary
public ModelPart resolveModelPart(NavigablePath navigablePath) Resolve the ModelPart associated with a given NavigablePath. More specific ModelParts should be preferred - e.g. the SingularAssociationAttributeMapping rather than just the EntityTypeMapping for the associated type

setCurrentlyResolvingForeignKeyPart	back to summary
public void setCurrentlyResolvingForeignKeyPart(ForeignKeyDescriptor.Nature currentlyResolvingForeignKeySide)

setResolvingCircularFetch	back to summary
public void setResolvingCircularFetch(boolean resolvingCircularFetch)

visitDiscriminatorFetch	back to summary
public default BasicFetch<?> visitDiscriminatorFetch(EntityResultGraphNode fetchParent)

visitFetches	back to summary
public ImmutableFetchList visitFetches(FetchParent fetchParent) Visit fetches for the given parent. We walk fetches via the SqlAstCreationContext because each "context" will define differently what should be fetched (HQL versus load)

visitIdentifierFetch	back to summary
public default Fetch visitIdentifierFetch(EntityResultGraphNode fetchParent)

visitNestedFetches	back to summary
public ImmutableFetchList visitNestedFetches(FetchParent fetchParent)