Package org.hibernate.loader.ast.internal

Class LoaderSqlAstCreationState

java.lang.Object

org.hibernate.loader.ast.internal.LoaderSqlAstCreationState

All Implemented Interfaces:

QueryOptions, SqlAstCreationState, SqlAstProcessingState, SqlAstQueryNodeProcessingState, SqlAstQueryPartProcessingState, DomainResultCreationState

public class LoaderSqlAstCreationState
extends Object
implements SqlAstQueryPartProcessingState, SqlAstCreationState, DomainResultCreationState, QueryOptions

Helper used when generating the database-snapshot select query

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoaderSqlAstCreationState.FetchProcessor

Field Summary

Fields inherited from interface org.hibernate.query.spi.QueryOptions

NONE, READ_ONLY, READ_WRITE

Constructor Summary

Constructors

Constructor	Description
LoaderSqlAstCreationState(QueryPart queryPart, SqlAliasBaseManager sqlAliasBaseManager, FromClauseAccess fromClauseAccess, LockOptions lockOptions, LoaderSqlAstCreationState.FetchProcessor fetchProcessor, boolean forceIdentifierSelection, LoadQueryInfluencers loadQueryInfluencers, SqlAstCreationContext sf)

Method Summary

Modifier and Type	Method	Description
boolean	applyOnlyLoadByKeyFilters()
void	applyOrdering(TableGroup tableGroup, OrderByFragment orderByFragment)
void	applyPredicate(Predicate predicate)	Apply the predicate to be used for the final statement.
boolean	forceIdentifierSelection()	Whether forcing the selection of the identifier is in effect for this creation
AppliedGraph	getAppliedGraph()	JPA EntityGraph explicitly applied to the query.
CacheRetrieveMode	getCacheRetrieveMode()	Controls whether query results are read from the cache.
CacheStoreMode	getCacheStoreMode()	Controls whether query results are put into the cache.
String	getComment()	The SQL comment to apply to the interpreted SQL query, for dialects which support SQL comments
SqlAstCreationContext	getCreationContext()
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.
SqlAstProcessingState	getCurrentProcessingState()
List<String>	getDatabaseHints()	Hints to apply to the interpreted SQL query
Set<String>	getDisabledFetchProfiles()	The explicitly disabled profiles for this query
Set<String>	getEnabledFetchProfiles()	The explicitly enabled profiles for this query
Integer	getFetchSize()	The fetch size to be applied to the JDBC query.
FlushMode	getFlushMode()	The flush mode to use for the query execution
FromClause	getFromClause()	Returns the in-flight from clause for the query node.
FromClauseAccess	getFromClauseAccess()
Map<SqmFrom<?,?>,Boolean>	getFromRegistrations()	Returns the treated SqmFroms and whether their EntityNameUse.TREAT should be downgraded to EntityNameUse.EXPRESSION.
QueryPart	getInflightQueryPart()	Get the QueryPart being processed as part of this state.
Limit	getLimit()	The limit to the query results.
LoadQueryInfluencers	getLoadQueryInfluencers()
LockOptions	getLockOptions()	Describes the locking to apply to the query results
SqlAstProcessingState	getParentState()
Boolean	getQueryPlanCachingEnabled()	Should the query plan of the query be cached?
String	getResultCacheRegionName()	The query cache region in which the results should be cached.
ResultListTransformer<?>	getResultListTransformer()	Transformer applied to the query to transform the structure of the overall results
SqlAliasBaseGenerator	getSqlAliasBaseGenerator()
SqlAstCreationState	getSqlAstCreationState()	The underlying state for SQL AST creation
SqlExpressionResolver	getSqlExpressionResolver()
Integer	getTimeout()	The timeout to apply to the query.
TupleTransformer<?>	getTupleTransformer()	Transformer applied to the query to transform the structure of each "row" in the results
boolean	isAssociationKeyVisited(AssociationKey associationKey)	Checks whether the given circularityKey is registered
Boolean	isReadOnly()	Should entities returned from the query be marked read-only.
boolean	isRegisteringVisitedAssociationKeys()	Is this state accepting circularity detection keys?
boolean	isResolvingCircularFetch()
Boolean	isResultCachingEnabled()	Should results from the query be cached?
void	registerFromUsage(SqmFrom<?,?> sqmFrom, boolean downgradeTreatUses)	Registers that the given SqmFrom was used in an expression and whether to downgrade EntityNameUse.TREAT of it.
void	registerLockMode(String identificationVariable, LockMode explicitLockMode)
void	registerTreatedFrom(SqmFrom<?,?> sqmFrom)	Registers that the given SqmFrom is treated.
boolean	registerVisitedAssociationKey(AssociationKey associationKey)	Registers a circularity detection key
void	removeVisitedAssociationKey(AssociationKey associationKey)	Removes the registration of a circularity detection key
ModelPart	resolveModelPart(NavigablePath navigablePath)	Resolve the ModelPart associated with a given NavigablePath.
void	setCurrentlyResolvingForeignKeyPart(ForeignKeyDescriptor.Nature currentlyResolvingForeignKeySide)
void	setResolvingCircularFetch(boolean resolvingCircularFetch)
ImmutableFetchList	visitFetches(FetchParent fetchParent)	Visit fetches for the given parent.
<R> R	withNestedFetchParent(FetchParent fetchParent, Function<FetchParent,R> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.sql.results.graph.DomainResultCreationState

getSqlAliasBaseManager, visitDiscriminatorFetch, visitEmbeddableDiscriminatorFetch, visitIdentifierFetch, visitNestedFetches

Methods inherited from interface org.hibernate.query.spi.QueryOptions

getCacheMode, getEffectiveLimit, getFirstRow, getMaxRows, getUniqueSemantic, hasLimit

Methods inherited from interface org.hibernate.sql.ast.spi.SqlAstCreationState

getSqmCreationContext, isProcedureOrNativeQuery, registerEntityNameUsage, supportsEntityNameUsage

Methods inherited from interface org.hibernate.sql.ast.spi.SqlAstProcessingState

isTopLevel

Constructor Details

LoaderSqlAstCreationState

public LoaderSqlAstCreationState(QueryPart queryPart,
 SqlAliasBaseManager sqlAliasBaseManager,
 FromClauseAccess fromClauseAccess,
 LockOptions lockOptions,
 LoaderSqlAstCreationState.FetchProcessor fetchProcessor,
 boolean forceIdentifierSelection,
 LoadQueryInfluencers loadQueryInfluencers,
 SqlAstCreationContext sf)

Method Details

applyOrdering

public void applyOrdering(TableGroup tableGroup,
 OrderByFragment orderByFragment)

Specified by:

applyOrdering in interface SqlAstCreationState

getCreationContext

public SqlAstCreationContext getCreationContext()

Specified by:

getCreationContext in interface SqlAstCreationState

getCurrentProcessingState

public SqlAstProcessingState getCurrentProcessingState()

Specified by:

getCurrentProcessingState in interface SqlAstCreationState

getInflightQueryPart

public QueryPart getInflightQueryPart()

Description copied from interface: SqlAstQueryPartProcessingState

Get the QueryPart being processed as part of this state. It is considered in-flight as it is probably still being built.

Specified by:

getInflightQueryPart in interface SqlAstQueryPartProcessingState

getFromClause

public FromClause getFromClause()

Description copied from interface: SqlAstQueryNodeProcessingState

Returns the in-flight from clause for the query node.

Specified by:

getFromClause in interface SqlAstQueryNodeProcessingState

applyPredicate

public void applyPredicate(Predicate predicate)

Description copied from interface: SqlAstQueryNodeProcessingState

Apply the predicate to be used for the final statement.

Specified by:

applyPredicate in interface SqlAstQueryNodeProcessingState

registerTreatedFrom

public void registerTreatedFrom(SqmFrom<?,?> sqmFrom)

Description copied from interface: SqlAstQueryNodeProcessingState

Registers that the given SqmFrom is treated.

Specified by:

registerTreatedFrom in interface SqlAstQueryNodeProcessingState

registerFromUsage

public void registerFromUsage(SqmFrom<?,?> sqmFrom,
 boolean downgradeTreatUses)

Description copied from interface: SqlAstQueryNodeProcessingState

Registers that the given SqmFrom was used in an expression and whether to downgrade EntityNameUse.TREAT of it.

Specified by:

registerFromUsage in interface SqlAstQueryNodeProcessingState

getFromRegistrations

public Map<SqmFrom<?,?>,Boolean> getFromRegistrations()

Description copied from interface: SqlAstQueryNodeProcessingState

Returns the treated SqmFroms and whether their EntityNameUse.TREAT should be downgraded to EntityNameUse.EXPRESSION.

Specified by:

getFromRegistrations in interface SqlAstQueryNodeProcessingState

getSqlExpressionResolver

public SqlExpressionResolver getSqlExpressionResolver()

Specified by:

getSqlExpressionResolver in interface SqlAstCreationState

Specified by:

getSqlExpressionResolver in interface SqlAstProcessingState

getFromClauseAccess

public FromClauseAccess getFromClauseAccess()

Specified by:

getFromClauseAccess in interface SqlAstCreationState

getSqlAliasBaseGenerator

public SqlAliasBaseGenerator getSqlAliasBaseGenerator()

Specified by:

getSqlAliasBaseGenerator in interface SqlAstCreationState

getLoadQueryInfluencers

public LoadQueryInfluencers getLoadQueryInfluencers()

Specified by:

getLoadQueryInfluencers in interface SqlAstCreationState

applyOnlyLoadByKeyFilters

public boolean applyOnlyLoadByKeyFilters()

Specified by:

applyOnlyLoadByKeyFilters in interface SqlAstCreationState

registerLockMode

public void registerLockMode(String identificationVariable,
 LockMode explicitLockMode)

Specified by:

registerLockMode in interface SqlAstCreationState

visitFetches

public ImmutableFetchList visitFetches(FetchParent fetchParent)

Description copied from interface: DomainResultCreationState

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)

Specified by:

visitFetches in interface DomainResultCreationState

withNestedFetchParent

public <R> R withNestedFetchParent(FetchParent fetchParent,
 Function<FetchParent,R> action)

Specified by:

withNestedFetchParent in interface DomainResultCreationState

isResolvingCircularFetch

public boolean isResolvingCircularFetch()

Specified by:

isResolvingCircularFetch in interface DomainResultCreationState

setResolvingCircularFetch

public void setResolvingCircularFetch(boolean resolvingCircularFetch)

Specified by:

setResolvingCircularFetch in interface DomainResultCreationState

getCurrentlyResolvingForeignKeyPart

public ForeignKeyDescriptor.Nature getCurrentlyResolvingForeignKeyPart()

Description copied from interface: DomainResultCreationState

Returns the part of the foreign key that is currently being resolved, or null if no foreign key is currently being resolved.

Specified by:

getCurrentlyResolvingForeignKeyPart in interface DomainResultCreationState

setCurrentlyResolvingForeignKeyPart

public void setCurrentlyResolvingForeignKeyPart(ForeignKeyDescriptor.Nature currentlyResolvingForeignKeySide)

Specified by:

setCurrentlyResolvingForeignKeyPart in interface DomainResultCreationState

forceIdentifierSelection

public boolean forceIdentifierSelection()

Description copied from interface: DomainResultCreationState

Whether forcing the selection of the identifier is in effect for this creation

Specified by:

forceIdentifierSelection in interface DomainResultCreationState

getSqlAstCreationState

public SqlAstCreationState getSqlAstCreationState()

Description copied from interface: DomainResultCreationState

The underlying state for SQL AST creation

Specified by:

getSqlAstCreationState in interface DomainResultCreationState

Specified by:

getSqlAstCreationState in interface SqlAstProcessingState

registerVisitedAssociationKey

public boolean registerVisitedAssociationKey(AssociationKey associationKey)

Description copied from interface: DomainResultCreationState

Registers a circularity detection key

Specified by:

registerVisitedAssociationKey in interface DomainResultCreationState

removeVisitedAssociationKey

public void removeVisitedAssociationKey(AssociationKey associationKey)

Description copied from interface: DomainResultCreationState

Removes the registration of a circularity detection key

Specified by:

removeVisitedAssociationKey in interface DomainResultCreationState

isAssociationKeyVisited

public boolean isAssociationKeyVisited(AssociationKey associationKey)

Description copied from interface: DomainResultCreationState

Checks whether the given circularityKey is registered

Specified by:

isAssociationKeyVisited in interface DomainResultCreationState

isRegisteringVisitedAssociationKeys

public boolean isRegisteringVisitedAssociationKeys()

Description copied from interface: DomainResultCreationState

Is this state accepting circularity detection keys?

Specified by:

isRegisteringVisitedAssociationKeys in interface DomainResultCreationState

resolveModelPart

public ModelPart resolveModelPart(NavigablePath navigablePath)

Description copied from interface: DomainResultCreationState

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

Specified by:

resolveModelPart in interface DomainResultCreationState

getParentState

public SqlAstProcessingState getParentState()

Specified by:

getParentState in interface SqlAstProcessingState

getTimeout

public Integer getTimeout()

Description copied from interface: QueryOptions

The timeout to apply to the query. May also be defined at the transaction level using Transaction.getTimeout()

Specified by:

getTimeout in interface QueryOptions

getFlushMode

public FlushMode getFlushMode()

Description copied from interface: QueryOptions

The flush mode to use for the query execution

Specified by:

getFlushMode in interface QueryOptions

isReadOnly

public Boolean isReadOnly()

Description copied from interface: QueryOptions

Should entities returned from the query be marked read-only.

Specified by:

isReadOnly in interface QueryOptions

getAppliedGraph

public AppliedGraph getAppliedGraph()

Description copied from interface: QueryOptions

JPA EntityGraph explicitly applied to the query.

Specified by:

getAppliedGraph in interface QueryOptions

getTupleTransformer

public TupleTransformer<?> getTupleTransformer()

Description copied from interface: QueryOptions

Transformer applied to the query to transform the structure of each "row" in the results

Specified by:

getTupleTransformer in interface QueryOptions

getResultListTransformer

public ResultListTransformer<?> getResultListTransformer()

Description copied from interface: QueryOptions

Transformer applied to the query to transform the structure of the overall results

Specified by:

getResultListTransformer in interface QueryOptions

isResultCachingEnabled

public Boolean isResultCachingEnabled()

Description copied from interface: QueryOptions

Should results from the query be cached?

Specified by:

isResultCachingEnabled in interface QueryOptions

See Also:

• QueryOptions.getCacheMode()
• QueryOptions.getResultCacheRegionName()

getQueryPlanCachingEnabled

public Boolean getQueryPlanCachingEnabled()

Description copied from interface: QueryOptions

Should the query plan of the query be cached?

Specified by:

getQueryPlanCachingEnabled in interface QueryOptions

getCacheRetrieveMode

public CacheRetrieveMode getCacheRetrieveMode()

Description copied from interface: QueryOptions

Controls whether query results are read from the cache. No effect unless QueryOptions.isResultCachingEnabled() returns true

Specified by:

getCacheRetrieveMode in interface QueryOptions

See Also:

• CacheMode

getCacheStoreMode

public CacheStoreMode getCacheStoreMode()

Description copied from interface: QueryOptions

Controls whether query results are put into the cache. No effect unless QueryOptions.isResultCachingEnabled() returns true

Specified by:

getCacheStoreMode in interface QueryOptions

See Also:

• CacheMode

getResultCacheRegionName

public String getResultCacheRegionName()

Description copied from interface: QueryOptions

The query cache region in which the results should be cached. No effect unless QueryOptions.isResultCachingEnabled() returns true

Specified by:

getResultCacheRegionName in interface QueryOptions

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: QueryOptions

Describes the locking to apply to the query results

Specified by:

getLockOptions in interface QueryOptions

getComment

public String getComment()

Description copied from interface: QueryOptions

The SQL comment to apply to the interpreted SQL query, for dialects which support SQL comments

Specified by:

getComment in interface QueryOptions

getDatabaseHints

public List<String> getDatabaseHints()

Description copied from interface: QueryOptions

Hints to apply to the interpreted SQL query

Specified by:

getDatabaseHints in interface QueryOptions

getFetchSize

public Integer getFetchSize()

Description copied from interface: QueryOptions

The fetch size to be applied to the JDBC query.

Specified by:

getFetchSize in interface QueryOptions

See Also:

• Statement.getFetchSize()

getLimit

public Limit getLimit()

Description copied from interface: QueryOptions

The limit to the query results. May also be accessed via QueryOptions.getFirstRow() and QueryOptions.getMaxRows()

Specified by:

getLimit in interface QueryOptions

getEnabledFetchProfiles

public Set<String> getEnabledFetchProfiles()

Description copied from interface: QueryOptions

The explicitly enabled profiles for this query

Specified by:

getEnabledFetchProfiles in interface QueryOptions

getDisabledFetchProfiles

public Set<String> getDisabledFetchProfiles()

Description copied from interface: QueryOptions

The explicitly disabled profiles for this query

Specified by:

getDisabledFetchProfiles in interface QueryOptions