Package org.hibernate.query.internal

Class QueryOptionsImpl

java.lang.Object

org.hibernate.query.internal.QueryOptionsImpl

All Implemented Interfaces:

AppliedGraph, MutableQueryOptions, QueryOptions

public class QueryOptionsImpl
extends Object
implements MutableQueryOptions, AppliedGraph

Field Summary

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

NONE, READ_ONLY, READ_WRITE

Constructor Summary

Constructors

Constructor	Description
QueryOptionsImpl()

Method Summary

Modifier and Type	Method	Description
void	addDatabaseHint(String hint)	Corollary to QueryOptions.getDatabaseHints()
void	applyGraph(RootGraphImplementor<?> rootGraph, GraphSemantic graphSemantic)
void	disableFetchProfile(String profileName)
void	enableFetchProfile(String profileName)
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
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
@Nullable RootGraphImplementor<?>	getGraph()	The applied graph
Limit	getLimit()	The limit to the query results.
LockOptions	getLockOptions()	Describes the locking to apply to the query results
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
@Nullable GraphSemantic	getSemantic()	The semantic (fetch/load) under which the graph should be applied
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	isReadOnly()	Should entities returned from the query be marked read-only.
Boolean	isResultCachingEnabled()	Should results from the query be cached?
void	setCacheRetrieveMode(CacheRetrieveMode retrieveMode)	Corollary to QueryOptions.getCacheRetrieveMode()
void	setCacheStoreMode(CacheStoreMode storeMode)	Corollary to QueryOptions.getCacheStoreMode()
void	setComment(String comment)	Corollary to QueryOptions.getComment()
void	setFetchSize(int fetchSize)	Corollary to QueryOptions.getFetchSize()
void	setFetchSize(Integer fetchSize)
void	setFlushMode(FlushMode flushMode)	Corollary to QueryOptions.getFlushMode()
void	setQueryPlanCachingEnabled(Boolean queryPlanCachingEnabled)	Corollary to QueryOptions.getQueryPlanCachingEnabled()
void	setReadOnly(boolean readOnly)	Corollary to QueryOptions.isReadOnly()
void	setResultCacheRegionName(String resultCacheRegionName)	Corollary to QueryOptions.getResultCacheRegionName()
void	setResultCachingEnabled(boolean resultCachingEnabled)	Corollary to QueryOptions.isResultCachingEnabled()
void	setResultListTransformer(ResultListTransformer<?> transformer)
void	setTimeout(int timeout)	Corollary to QueryOptions.getTimeout()
void	setTimeout(Integer timeout)
void	setTupleTransformer(TupleTransformer<?> transformer)

Methods inherited from class java.lang.Object

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

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

setCacheMode

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

getCacheMode, getEffectiveLimit, getFirstRow, getMaxRows, getUniqueSemantic, hasLimit

Constructor Details

QueryOptionsImpl

public QueryOptionsImpl()

Method Details

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

setTimeout

public void setTimeout(Integer timeout)

getFlushMode

public FlushMode getFlushMode()

Description copied from interface: QueryOptions

The flush mode to use for the query execution

Specified by:

getFlushMode in interface QueryOptions

setFlushMode

public void setFlushMode(FlushMode flushMode)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getFlushMode()

Specified by:

setFlushMode in interface MutableQueryOptions

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

setComment

public void setComment(String comment)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getComment()

Specified by:

setComment in interface MutableQueryOptions

getDatabaseHints

public List<String> getDatabaseHints()

Description copied from interface: QueryOptions

Hints to apply to the interpreted SQL query

Specified by:

getDatabaseHints in interface QueryOptions

addDatabaseHint

public void addDatabaseHint(String hint)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getDatabaseHints()

Specified by:

addDatabaseHint in interface MutableQueryOptions

setTupleTransformer

public void setTupleTransformer(TupleTransformer<?> transformer)

Specified by:

setTupleTransformer in interface MutableQueryOptions

setResultListTransformer

public void setResultListTransformer(ResultListTransformer<?> transformer)

Specified by:

setResultListTransformer in interface MutableQueryOptions

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

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: QueryOptions

Describes the locking to apply to the query results

Specified by:

getLockOptions 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()

setFetchSize

public void setFetchSize(Integer fetchSize)

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

setCacheRetrieveMode

public void setCacheRetrieveMode(CacheRetrieveMode retrieveMode)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getCacheRetrieveMode()

Specified by:

setCacheRetrieveMode in interface MutableQueryOptions

setCacheStoreMode

public void setCacheStoreMode(CacheStoreMode storeMode)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getCacheStoreMode()

Specified by:

setCacheStoreMode in interface MutableQueryOptions

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()

setResultCachingEnabled

public void setResultCachingEnabled(boolean resultCachingEnabled)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.isResultCachingEnabled()

Specified by:

setResultCachingEnabled in interface MutableQueryOptions

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

getQueryPlanCachingEnabled

public Boolean getQueryPlanCachingEnabled()

Description copied from interface: QueryOptions

Should the query plan of the query be cached?

Specified by:

getQueryPlanCachingEnabled in interface QueryOptions

setQueryPlanCachingEnabled

public void setQueryPlanCachingEnabled(Boolean queryPlanCachingEnabled)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getQueryPlanCachingEnabled()

Specified by:

setQueryPlanCachingEnabled in interface MutableQueryOptions

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

setResultCacheRegionName

public void setResultCacheRegionName(String resultCacheRegionName)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getResultCacheRegionName()

Specified by:

setResultCacheRegionName in interface MutableQueryOptions

setTimeout

public void setTimeout(int timeout)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getTimeout()

Specified by:

setTimeout in interface MutableQueryOptions

setFetchSize

public void setFetchSize(int fetchSize)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.getFetchSize()

Specified by:

setFetchSize in interface MutableQueryOptions

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: MutableQueryOptions

Corollary to QueryOptions.isReadOnly()

Specified by:

setReadOnly in interface MutableQueryOptions

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

applyGraph

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

Specified by:

applyGraph in interface MutableQueryOptions

enableFetchProfile

public void enableFetchProfile(String profileName)

Specified by:

enableFetchProfile in interface MutableQueryOptions

disableFetchProfile

public void disableFetchProfile(String profileName)

Specified by:

disableFetchProfile in interface MutableQueryOptions

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

getAppliedGraph

public AppliedGraph getAppliedGraph()

Description copied from interface: QueryOptions

JPA EntityGraph explicitly applied to the query.

Specified by:

getAppliedGraph in interface QueryOptions

getGraph

public @Nullable RootGraphImplementor<?> getGraph()

Description copied from interface: AppliedGraph

The applied graph

Specified by:

getGraph in interface AppliedGraph

getSemantic

public @Nullable GraphSemantic getSemantic()

Description copied from interface: AppliedGraph

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

Specified by:

getSemantic in interface AppliedGraph