Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.query.internal.QueryOptionsImpl

Modifier and Type	Field and Description
private CacheRetrieveMode	cacheRetrieveMode
private CacheStoreMode	cacheStoreMode
private String	comment
private List<String>	databaseHints
private Set<String>	disabledFetchProfiles
private Set<String>	enabledFetchProfiles
private Integer	fetchSize
private FlushMode	flushMode
private GraphSemantic	graphSemantic
private final Limit	limit
private final LockOptions	lockOptions
private Boolean	queryPlanCachingEnabled
private Boolean	readOnlyEnabled
private String	resultCacheRegionName
private Boolean	resultCachingEnabled
private ResultListTransformer<?>	resultListTransformer
private RootGraphImplementor<?>	rootGraph
private Integer	timeout
private TupleTransformer<?>	tupleTransformer

Constructor Summary

Access	Constructor and Description
public	QueryOptionsImpl()

Method Summary

Modifier and Type	Method and Description
public void	addDatabaseHint(String hint) Implements org.hibernate.query.spi.MutableQueryOptions.addDatabaseHint. Corollary to `getDatabaseHints()`
public void	applyGraph(RootGraphImplementor<?> rootGraph, GraphSemantic graphSemantic) Implements org.hibernate.query.spi.MutableQueryOptions.applyGraph.
public void	disableFetchProfile(String profileName) Implements org.hibernate.query.spi.MutableQueryOptions.disableFetchProfile.
public void	enableFetchProfile(String profileName) Implements org.hibernate.query.spi.MutableQueryOptions.enableFetchProfile.
public AppliedGraph	getAppliedGraph() Implements org.hibernate.query.spi.QueryOptions.getAppliedGraph. JPA `jakarta.persistence.EntityGraph` explicitly applied to the query.
public CacheRetrieveMode	getCacheRetrieveMode() Implements org.hibernate.query.spi.QueryOptions.getCacheRetrieveMode. Controls whether query results are read from the cache.
public CacheStoreMode	getCacheStoreMode() Implements org.hibernate.query.spi.QueryOptions.getCacheStoreMode. Controls whether query results are put into the cache.
public String	getComment() Implements org.hibernate.query.spi.QueryOptions.getComment. The SQL comment to apply to the interpreted SQL query, for dialects which support SQL comments
public List<String>	getDatabaseHints() Implements org.hibernate.query.spi.QueryOptions.getDatabaseHints. Hints to apply to the interpreted SQL query
public Set<String>	getDisabledFetchProfiles() Implements org.hibernate.query.spi.QueryOptions.getDisabledFetchProfiles. The explicitly disabled profiles for this query
public Set<String>	getEnabledFetchProfiles() Implements org.hibernate.query.spi.QueryOptions.getEnabledFetchProfiles. The explicitly enabled profiles for this query
public Integer	getFetchSize() Implements org.hibernate.query.spi.QueryOptions.getFetchSize. The fetch size to be applied to the JDBC query.
public FlushMode	getFlushMode() Implements org.hibernate.query.spi.QueryOptions.getFlushMode. The flush mode to use for the query execution
public @Nullable RootGraphImplementor<?>	getGraph() Implements org.hibernate.graph.spi.AppliedGraph.getGraph. The applied graph
public Limit	getLimit() Implements org.hibernate.query.spi.QueryOptions.getLimit. The limit to the query results.
public LockOptions	getLockOptions() Implements org.hibernate.query.spi.QueryOptions.getLockOptions. Describes the locking to apply to the query results
public Boolean	getQueryPlanCachingEnabled() Implements org.hibernate.query.spi.QueryOptions.getQueryPlanCachingEnabled. Should the query plan of the query be cached?
public String	getResultCacheRegionName() Implements org.hibernate.query.spi.QueryOptions.getResultCacheRegionName. The query cache region in which the results should be cached.
public ResultListTransformer<?>	getResultListTransformer() Implements org.hibernate.query.spi.QueryOptions.getResultListTransformer. Transformer applied to the query to transform the structure of the overall results
public @Nullable GraphSemantic	getSemantic() Implements org.hibernate.graph.spi.AppliedGraph.getSemantic. The semantic (fetch/load) under which the graph should be applied
public Integer	getTimeout() Implements org.hibernate.query.spi.QueryOptions.getTimeout. The timeout to apply to the query.
public TupleTransformer<?>	getTupleTransformer() Implements org.hibernate.query.spi.QueryOptions.getTupleTransformer. Transformer applied to the query to transform the structure of each "row" in the results
public Boolean	isReadOnly() Implements org.hibernate.query.spi.QueryOptions.isReadOnly. Should entities returned from the query be marked read-only.
public Boolean	isResultCachingEnabled() Implements org.hibernate.query.spi.QueryOptions.isResultCachingEnabled. Should results from the query be cached?
public void	setCacheRetrieveMode(CacheRetrieveMode retrieveMode) Implements org.hibernate.query.spi.MutableQueryOptions.setCacheRetrieveMode. Corollary to `getCacheRetrieveMode`
public void	setCacheStoreMode(CacheStoreMode storeMode) Implements org.hibernate.query.spi.MutableQueryOptions.setCacheStoreMode. Corollary to `getCacheStoreMode()`
public void	setComment(String comment) Implements org.hibernate.query.spi.MutableQueryOptions.setComment. Corollary to `getComment()`
public void	setFetchSize(Integer fetchSize)
public void	setFetchSize(int fetchSize) Implements org.hibernate.query.spi.MutableQueryOptions.setFetchSize. Corollary to `getFetchSize()`
public void	setFlushMode(FlushMode flushMode) Implements org.hibernate.query.spi.MutableQueryOptions.setFlushMode. Corollary to `getFlushMode()`
public void	setQueryPlanCachingEnabled(Boolean queryPlanCachingEnabled) Implements org.hibernate.query.spi.MutableQueryOptions.setQueryPlanCachingEnabled. Corollary to `getQueryPlanCachingEnabled()`
public void	setReadOnly(boolean readOnly) Implements org.hibernate.query.spi.MutableQueryOptions.setReadOnly. Corollary to `isReadOnly()`
public void	setResultCacheRegionName(String resultCacheRegionName) Implements org.hibernate.query.spi.MutableQueryOptions.setResultCacheRegionName. Corollary to `getResultCacheRegionName()`
public void	setResultCachingEnabled(boolean resultCachingEnabled) Implements org.hibernate.query.spi.MutableQueryOptions.setResultCachingEnabled. Corollary to `isResultCachingEnabled()`
public void	setResultListTransformer(ResultListTransformer<?> transformer) Implements org.hibernate.query.spi.MutableQueryOptions.setResultListTransformer.
public void	setTimeout(Integer timeout)
public void	setTimeout(int timeout) Implements org.hibernate.query.spi.MutableQueryOptions.setTimeout. Corollary to `getTimeout()`
public void	setTupleTransformer(TupleTransformer<?> transformer) Implements org.hibernate.query.spi.MutableQueryOptions.setTupleTransformer.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cacheRetrieveMode	back to summary
private CacheRetrieveMode cacheRetrieveMode

cacheStoreMode	back to summary
private CacheStoreMode cacheStoreMode

comment	back to summary
private String comment

databaseHints	back to summary
private List<String> databaseHints

disabledFetchProfiles	back to summary
private Set<String> disabledFetchProfiles

enabledFetchProfiles	back to summary
private Set<String> enabledFetchProfiles

fetchSize	back to summary
private Integer fetchSize

flushMode	back to summary
private FlushMode flushMode

graphSemantic	back to summary
private GraphSemantic graphSemantic

limit	back to summary
private final Limit limit

lockOptions	back to summary
private final LockOptions lockOptions

queryPlanCachingEnabled	back to summary
private Boolean queryPlanCachingEnabled

readOnlyEnabled	back to summary
private Boolean readOnlyEnabled

resultCacheRegionName	back to summary
private String resultCacheRegionName

resultCachingEnabled	back to summary
private Boolean resultCachingEnabled

resultListTransformer	back to summary
private ResultListTransformer<?> resultListTransformer

rootGraph	back to summary
private RootGraphImplementor<?> rootGraph

timeout	back to summary
private Integer timeout

tupleTransformer	back to summary
private TupleTransformer<?> tupleTransformer

Constructor Detail

QueryOptionsImpl	back to summary
public QueryOptionsImpl()

Method Detail

addDatabaseHint back to summary

addDatabaseHint	back to summary
public void addDatabaseHint(String hint) Implements org.hibernate.query.spi.MutableQueryOptions.addDatabaseHint. Doc from org.hibernate.query.spi.MutableQueryOptions.addDatabaseHint. Corollary to `getDatabaseHints()` Annotations @Override

public void addDatabaseHint(String hint)

Implements org.hibernate.query.spi.MutableQueryOptions.addDatabaseHint.

Doc from org.hibernate.query.spi.MutableQueryOptions.addDatabaseHint.

Corollary to getDatabaseHints()

Annotations

@Override

applyGraph	back to summary
public void applyGraph(RootGraphImplementor<?> rootGraph, GraphSemantic graphSemantic) Implements org.hibernate.query.spi.MutableQueryOptions.applyGraph. Annotations @Override

applyGraph

back to summary

public void applyGraph(RootGraphImplementor<?> rootGraph, GraphSemantic graphSemantic)

Implements org.hibernate.query.spi.MutableQueryOptions.applyGraph.

Annotations

@Override

disableFetchProfile	back to summary
public void disableFetchProfile(String profileName) Implements org.hibernate.query.spi.MutableQueryOptions.disableFetchProfile. Annotations @Override

disableFetchProfile

back to summary

public void disableFetchProfile(String profileName)

Implements org.hibernate.query.spi.MutableQueryOptions.disableFetchProfile.

Annotations

@Override

enableFetchProfile	back to summary
public void enableFetchProfile(String profileName) Implements org.hibernate.query.spi.MutableQueryOptions.enableFetchProfile. Annotations @Override

enableFetchProfile

back to summary

public void enableFetchProfile(String profileName)

Implements org.hibernate.query.spi.MutableQueryOptions.enableFetchProfile.

Annotations

@Override

getAppliedGraph back to summary

getAppliedGraph	back to summary
public AppliedGraph getAppliedGraph() Implements org.hibernate.query.spi.QueryOptions.getAppliedGraph. Doc from org.hibernate.query.spi.QueryOptions.getAppliedGraph. JPA `jakarta.persistence.EntityGraph` explicitly applied to the query. Annotations @Override

public AppliedGraph getAppliedGraph()

Implements org.hibernate.query.spi.QueryOptions.getAppliedGraph.

Doc from org.hibernate.query.spi.QueryOptions.getAppliedGraph.

JPA jakarta.persistence.EntityGraph explicitly applied to the query.

Annotations

@Override

getCacheRetrieveMode back to summary

getCacheRetrieveMode	back to summary
public CacheRetrieveMode getCacheRetrieveMode() Implements org.hibernate.query.spi.QueryOptions.getCacheRetrieveMode. Doc from org.hibernate.query.spi.QueryOptions.getCacheRetrieveMode. Controls whether query results are read from the cache. No effect unless `isResultCachingEnabled` returns `true` Annotations @Override

public CacheRetrieveMode getCacheRetrieveMode()

Implements org.hibernate.query.spi.QueryOptions.getCacheRetrieveMode.

Doc from org.hibernate.query.spi.QueryOptions.getCacheRetrieveMode.

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

Annotations

@Override

getCacheStoreMode back to summary

getCacheStoreMode	back to summary
public CacheStoreMode getCacheStoreMode() Implements org.hibernate.query.spi.QueryOptions.getCacheStoreMode. Doc from org.hibernate.query.spi.QueryOptions.getCacheStoreMode. Controls whether query results are put into the cache. No effect unless `isResultCachingEnabled` returns `true` Annotations @Override

public CacheStoreMode getCacheStoreMode()

Implements org.hibernate.query.spi.QueryOptions.getCacheStoreMode.

Doc from org.hibernate.query.spi.QueryOptions.getCacheStoreMode.

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

Annotations

@Override

getComment	back to summary
public String getComment() Implements org.hibernate.query.spi.QueryOptions.getComment. Doc from org.hibernate.query.spi.QueryOptions.getComment. The SQL comment to apply to the interpreted SQL query, for dialects which support SQL comments Annotations @Override

getComment

back to summary

public String getComment()

Implements org.hibernate.query.spi.QueryOptions.getComment.

Doc from org.hibernate.query.spi.QueryOptions.getComment.

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

Annotations

@Override

getDatabaseHints	back to summary
public List<String> getDatabaseHints() Implements org.hibernate.query.spi.QueryOptions.getDatabaseHints. Doc from org.hibernate.query.spi.QueryOptions.getDatabaseHints. Hints to apply to the interpreted SQL query Annotations @Override

getDatabaseHints

back to summary

public List<String> getDatabaseHints()

Implements org.hibernate.query.spi.QueryOptions.getDatabaseHints.

Doc from org.hibernate.query.spi.QueryOptions.getDatabaseHints.

Hints to apply to the interpreted SQL query

Annotations

@Override

getDisabledFetchProfiles	back to summary
public Set<String> getDisabledFetchProfiles() Implements org.hibernate.query.spi.QueryOptions.getDisabledFetchProfiles. Doc from org.hibernate.query.spi.QueryOptions.getDisabledFetchProfiles. The explicitly disabled profiles for this query Annotations @Override

getDisabledFetchProfiles

back to summary

public Set<String> getDisabledFetchProfiles()

Implements org.hibernate.query.spi.QueryOptions.getDisabledFetchProfiles.

Doc from org.hibernate.query.spi.QueryOptions.getDisabledFetchProfiles.

The explicitly disabled profiles for this query

Annotations

@Override

getEnabledFetchProfiles	back to summary
public Set<String> getEnabledFetchProfiles() Implements org.hibernate.query.spi.QueryOptions.getEnabledFetchProfiles. Doc from org.hibernate.query.spi.QueryOptions.getEnabledFetchProfiles. The explicitly enabled profiles for this query Annotations @Override

getEnabledFetchProfiles

back to summary

public Set<String> getEnabledFetchProfiles()

Implements org.hibernate.query.spi.QueryOptions.getEnabledFetchProfiles.

Doc from org.hibernate.query.spi.QueryOptions.getEnabledFetchProfiles.

The explicitly enabled profiles for this query

Annotations

@Override

getFetchSize	back to summary
public Integer getFetchSize() Implements org.hibernate.query.spi.QueryOptions.getFetchSize. Doc from org.hibernate.query.spi.QueryOptions.getFetchSize. The fetch size to be applied to the JDBC query. Annotations @Override

getFetchSize

back to summary

public Integer getFetchSize()

Implements org.hibernate.query.spi.QueryOptions.getFetchSize.

Doc from org.hibernate.query.spi.QueryOptions.getFetchSize.

The fetch size to be applied to the JDBC query.

Annotations

@Override

getFlushMode	back to summary
public FlushMode getFlushMode() Implements org.hibernate.query.spi.QueryOptions.getFlushMode. Doc from org.hibernate.query.spi.QueryOptions.getFlushMode. The flush mode to use for the query execution Annotations @Override

getFlushMode

back to summary

public FlushMode getFlushMode()

Implements org.hibernate.query.spi.QueryOptions.getFlushMode.

Doc from org.hibernate.query.spi.QueryOptions.getFlushMode.

The flush mode to use for the query execution

Annotations

@Override

getGraph	back to summary
public @Nullable RootGraphImplementor<?> getGraph() Implements org.hibernate.graph.spi.AppliedGraph.getGraph. Doc from org.hibernate.graph.spi.AppliedGraph.getGraph. The applied graph Annotations @Override

getGraph

back to summary

public @Nullable RootGraphImplementor<?> getGraph()

Implements org.hibernate.graph.spi.AppliedGraph.getGraph.

Doc from org.hibernate.graph.spi.AppliedGraph.getGraph.

The applied graph

Annotations

@Override

getLimit back to summary

getLimit	back to summary
public Limit getLimit() Implements org.hibernate.query.spi.QueryOptions.getLimit. Doc from org.hibernate.query.spi.QueryOptions.getLimit. The limit to the query results. May also be accessed via `getFirstRow` and `getMaxRows` Annotations @Override

public Limit getLimit()

Implements org.hibernate.query.spi.QueryOptions.getLimit.

Doc from org.hibernate.query.spi.QueryOptions.getLimit.

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

Annotations

@Override

getLockOptions	back to summary
public LockOptions getLockOptions() Implements org.hibernate.query.spi.QueryOptions.getLockOptions. Doc from org.hibernate.query.spi.QueryOptions.getLockOptions. Describes the locking to apply to the query results Annotations @Override

getLockOptions

back to summary

public LockOptions getLockOptions()

Implements org.hibernate.query.spi.QueryOptions.getLockOptions.

Doc from org.hibernate.query.spi.QueryOptions.getLockOptions.

Describes the locking to apply to the query results

Annotations

@Override

getQueryPlanCachingEnabled	back to summary
public Boolean getQueryPlanCachingEnabled() Implements org.hibernate.query.spi.QueryOptions.getQueryPlanCachingEnabled. Doc from org.hibernate.query.spi.QueryOptions.getQueryPlanCachingEnabled. Should the query plan of the query be cached? Annotations @Override

getQueryPlanCachingEnabled

back to summary

public Boolean getQueryPlanCachingEnabled()

Implements org.hibernate.query.spi.QueryOptions.getQueryPlanCachingEnabled.

Doc from org.hibernate.query.spi.QueryOptions.getQueryPlanCachingEnabled.

Should the query plan of the query be cached?

Annotations

@Override

getResultCacheRegionName back to summary

getResultCacheRegionName	back to summary
public String getResultCacheRegionName() Implements org.hibernate.query.spi.QueryOptions.getResultCacheRegionName. Doc from org.hibernate.query.spi.QueryOptions.getResultCacheRegionName. The query cache region in which the results should be cached. No effect unless `isResultCachingEnabled` returns `true` Annotations @Override

public String getResultCacheRegionName()

Implements org.hibernate.query.spi.QueryOptions.getResultCacheRegionName.

Doc from org.hibernate.query.spi.QueryOptions.getResultCacheRegionName.

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

Annotations

@Override

getResultListTransformer	back to summary
public ResultListTransformer<?> getResultListTransformer() Implements org.hibernate.query.spi.QueryOptions.getResultListTransformer. Doc from org.hibernate.query.spi.QueryOptions.getResultListTransformer. Transformer applied to the query to transform the structure of the overall results Annotations @Override

getResultListTransformer

back to summary

public ResultListTransformer<?> getResultListTransformer()

Implements org.hibernate.query.spi.QueryOptions.getResultListTransformer.

Doc from org.hibernate.query.spi.QueryOptions.getResultListTransformer.

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

Annotations

@Override

getSemantic	back to summary
public @Nullable GraphSemantic getSemantic() Implements org.hibernate.graph.spi.AppliedGraph.getSemantic. Doc from org.hibernate.graph.spi.AppliedGraph.getSemantic. The semantic (fetch/load) under which the graph should be applied Annotations @Override

getSemantic

back to summary

public @Nullable GraphSemantic getSemantic()

Implements org.hibernate.graph.spi.AppliedGraph.getSemantic.

Doc from org.hibernate.graph.spi.AppliedGraph.getSemantic.

The semantic (fetch/load) under which the graph should be applied

Annotations

@Override

getTimeout back to summary

getTimeout	back to summary
public Integer getTimeout() Implements org.hibernate.query.spi.QueryOptions.getTimeout. Doc from org.hibernate.query.spi.QueryOptions.getTimeout. The timeout to apply to the query. May also be defined at the transaction level using `org.hibernate.Transaction#getTimeout` Annotations @Override

public Integer getTimeout()

Implements org.hibernate.query.spi.QueryOptions.getTimeout.

Doc from org.hibernate.query.spi.QueryOptions.getTimeout.

The timeout to apply to the query. May also be defined at the transaction level using org.hibernate.Transaction#getTimeout

Annotations

@Override

getTupleTransformer	back to summary
public TupleTransformer<?> getTupleTransformer() Implements org.hibernate.query.spi.QueryOptions.getTupleTransformer. Doc from org.hibernate.query.spi.QueryOptions.getTupleTransformer. Transformer applied to the query to transform the structure of each "row" in the results Annotations @Override

getTupleTransformer

back to summary

public TupleTransformer<?> getTupleTransformer()

Implements org.hibernate.query.spi.QueryOptions.getTupleTransformer.

Doc from org.hibernate.query.spi.QueryOptions.getTupleTransformer.

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

Annotations

@Override

isReadOnly	back to summary
public Boolean isReadOnly() Implements org.hibernate.query.spi.QueryOptions.isReadOnly. Doc from org.hibernate.query.spi.QueryOptions.isReadOnly. Should entities returned from the query be marked read-only. Annotations @Override

isReadOnly

back to summary

public Boolean isReadOnly()

Implements org.hibernate.query.spi.QueryOptions.isReadOnly.

Doc from org.hibernate.query.spi.QueryOptions.isReadOnly.

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

Annotations

@Override

isResultCachingEnabled	back to summary
public Boolean isResultCachingEnabled() Implements org.hibernate.query.spi.QueryOptions.isResultCachingEnabled. Doc from org.hibernate.query.spi.QueryOptions.isResultCachingEnabled. Should results from the query be cached? Annotations @Override

isResultCachingEnabled

back to summary

public Boolean isResultCachingEnabled()

Implements org.hibernate.query.spi.QueryOptions.isResultCachingEnabled.

Doc from org.hibernate.query.spi.QueryOptions.isResultCachingEnabled.

Should results from the query be cached?

Annotations

@Override

setCacheRetrieveMode back to summary

setCacheRetrieveMode	back to summary
public void setCacheRetrieveMode(CacheRetrieveMode retrieveMode) Implements org.hibernate.query.spi.MutableQueryOptions.setCacheRetrieveMode. Doc from org.hibernate.query.spi.MutableQueryOptions.setCacheRetrieveMode. Corollary to `getCacheRetrieveMode` Annotations @Override

public void setCacheRetrieveMode(CacheRetrieveMode retrieveMode)

Implements org.hibernate.query.spi.MutableQueryOptions.setCacheRetrieveMode.

Doc from org.hibernate.query.spi.MutableQueryOptions.setCacheRetrieveMode.

Corollary to getCacheRetrieveMode

Annotations

@Override

setCacheStoreMode back to summary

setCacheStoreMode	back to summary
public void setCacheStoreMode(CacheStoreMode storeMode) Implements org.hibernate.query.spi.MutableQueryOptions.setCacheStoreMode. Doc from org.hibernate.query.spi.MutableQueryOptions.setCacheStoreMode. Corollary to `getCacheStoreMode()` Annotations @Override

public void setCacheStoreMode(CacheStoreMode storeMode)

Implements org.hibernate.query.spi.MutableQueryOptions.setCacheStoreMode.

Doc from org.hibernate.query.spi.MutableQueryOptions.setCacheStoreMode.

Corollary to getCacheStoreMode()

Annotations

@Override

setComment back to summary

setComment	back to summary
public void setComment(String comment) Implements org.hibernate.query.spi.MutableQueryOptions.setComment. Doc from org.hibernate.query.spi.MutableQueryOptions.setComment. Corollary to `getComment()` Annotations @Override

public void setComment(String comment)

Implements org.hibernate.query.spi.MutableQueryOptions.setComment.

Doc from org.hibernate.query.spi.MutableQueryOptions.setComment.

Corollary to getComment()

Annotations