Class DelegatingQueryOptions

java.lang.Object

org.hibernate.query.spi.DelegatingQueryOptions

All Implemented Interfaces:

QueryOptions

public class DelegatingQueryOptions
extends Object
implements QueryOptions

Field Summary

Fields inherited from interface QueryOptions

NONE, READ_ONLY, READ_WRITE

Constructor Summary

Constructors

Constructor	Description
DelegatingQueryOptions(QueryOptions queryOptions)

Method Summary

Modifier and Type	Method	Description
AppliedGraph	getAppliedGraph()	An EntityGraph explicitly applied to the query.
CacheMode	getCacheMode()
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.
Limit	getEffectiveLimit()	Determine the effective paging limit to apply to the query.
Set<String>	getEnabledFetchProfiles()	The explicitly enabled profiles for this query.
Integer	getFetchSize()	The fetch size to be applied to the JDBC query.
Integer	getFirstRow()	The first row from the results to return.
Limit	getLimit()	The limit to the query results.
LockOptions	getLockOptions()	Describes the locking to apply to the query results.
Integer	getMaxRows()	The maximum number of rows to return from the results.
QueryFlushMode	getQueryFlushMode()	The flush mode to use for the query execution.
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 result list.
Timeout	getTimeout()	The query execution timeout.
TupleTransformer<?>	getTupleTransformer()	Transformer applied to the query to transform the structure of each "row" of the results.
ListResultsConsumer.UniqueSemantic	getUniqueSemantic()
boolean	hasLimit()	Did the application explicitly request paging limits?
Boolean	isLimitInMemoryEnabled()	Whether top-level HQL/criteria pagination should be handled in memory instead of by the SQL query.
Boolean	isReadOnly()	Are entities returned by the query marked as read-only?
Boolean	isResultCachingEnabled()	Should results from the query be cached?
boolean	isScrollExecution()	Whether this execution goes through scroll() / getResultStream() and therefore needs SQL row ordering stable enough for scroll-style result grouping.
Limit	peekOriginalLimit()	The original Limit as set by the application, before any wrapper (SqlOmittingQueryOptions or the scroll execution context) hid it from QueryOptions.getLimit().

Methods inherited from class Object

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

Constructor Details

DelegatingQueryOptions

public DelegatingQueryOptions(@Nonnull
 QueryOptions queryOptions)

Method Details

getTimeout

@Nullable
public Timeout getTimeout()

Description copied from interface: QueryOptions

The query execution timeout. May alternatively be specified at the transaction level using Transaction.getTimeout().

Specified by:

getTimeout in interface QueryOptions

getQueryFlushMode

@Nonnull
public QueryFlushMode getQueryFlushMode()

Description copied from interface: QueryOptions

The flush mode to use for the query execution.

Specified by:

getQueryFlushMode in interface QueryOptions

isReadOnly

@Nullable
public Boolean isReadOnly()

Description copied from interface: QueryOptions

Are entities returned by the query marked as read-only?

Specified by:

isReadOnly in interface QueryOptions

getAppliedGraph

@Nullable
public AppliedGraph getAppliedGraph()

Description copied from interface: QueryOptions

An EntityGraph explicitly applied to the query.

Specified by:

getAppliedGraph in interface QueryOptions

getTupleTransformer

@Nullable
public TupleTransformer<?> getTupleTransformer()

Description copied from interface: QueryOptions

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

Specified by:

getTupleTransformer in interface QueryOptions

getResultListTransformer

@Nullable
public ResultListTransformer<?> getResultListTransformer()

Description copied from interface: QueryOptions

Transformer applied to the query to transform the structure of the overall result list.

Specified by:

getResultListTransformer in interface QueryOptions

isResultCachingEnabled

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

getCacheRetrieveMode

@Nullable
public CacheRetrieveMode getCacheRetrieveMode()

Description copied from interface: QueryOptions

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

Specified by:

getCacheRetrieveMode in interface QueryOptions

See Also:

• CacheMode

getCacheStoreMode

@Nullable
public CacheStoreMode getCacheStoreMode()

Description copied from interface: QueryOptions

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

Specified by:

getCacheStoreMode in interface QueryOptions

See Also:

• CacheMode

getQueryPlanCachingEnabled

@Nullable
public Boolean getQueryPlanCachingEnabled()

Description copied from interface: QueryOptions

Should the query plan of the query be cached?

Specified by:

getQueryPlanCachingEnabled in interface QueryOptions

isLimitInMemoryEnabled

@Nullable
public Boolean isLimitInMemoryEnabled()

Description copied from interface: QueryOptions

Whether top-level HQL/criteria pagination should be handled in memory instead of by the SQL query.

Specified by:

isLimitInMemoryEnabled in interface QueryOptions

getCacheMode

@Nullable
public CacheMode getCacheMode()

Specified by:

getCacheMode in interface QueryOptions

getResultCacheRegionName

@Nullable
public String getResultCacheRegionName()

Description copied from interface: QueryOptions

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

Specified by:

getResultCacheRegionName in interface QueryOptions

getLockOptions

@Nonnull
public LockOptions getLockOptions()

Description copied from interface: QueryOptions

Describes the locking to apply to the query results.

Specified by:

getLockOptions in interface QueryOptions

getComment

@Nullable
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

@Nonnull
public List<String> getDatabaseHints()

Description copied from interface: QueryOptions

Hints to apply to the interpreted SQL query.

Specified by:

getDatabaseHints in interface QueryOptions

getFetchSize

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

getEnabledFetchProfiles

@Nullable
public Set<String> getEnabledFetchProfiles()

Description copied from interface: QueryOptions

The explicitly enabled profiles for this query.

Specified by:

getEnabledFetchProfiles in interface QueryOptions

getDisabledFetchProfiles

@Nullable
public Set<String> getDisabledFetchProfiles()

Description copied from interface: QueryOptions

The explicitly disabled profiles for this query.

Specified by:

getDisabledFetchProfiles in interface QueryOptions

getLimit

@Nonnull
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

peekOriginalLimit

@Nonnull
public Limit peekOriginalLimit()

Description copied from interface: QueryOptions

The original Limit as set by the application, before any wrapper (SqlOmittingQueryOptions or the scroll execution context) hid it from QueryOptions.getLimit(). Used by runtime parameter binders that the SQM-to-SQL converter pushed into the SQL AST so they can bind the original value even when QueryOptions.getLimit() has been intentionally suppressed for SQL rendering.

Specified by:

peekOriginalLimit in interface QueryOptions

getFirstRow

@Nullable
public Integer getFirstRow()

Description copied from interface: QueryOptions

The first row from the results to return.

Specified by:

getFirstRow in interface QueryOptions

See Also:

• QueryOptions.getLimit()

getMaxRows

@Nullable
public Integer getMaxRows()

Description copied from interface: QueryOptions

The maximum number of rows to return from the results.

Specified by:

getMaxRows in interface QueryOptions

See Also:

• QueryOptions.getLimit()

getEffectiveLimit

@Nonnull
public Limit getEffectiveLimit()

Description copied from interface: QueryOptions

Determine the effective paging limit to apply to the query. If the application did not explicitly specify paging limits, Limit.NONE is returned.

Specified by:

getEffectiveLimit in interface QueryOptions

See Also:

• QueryOptions.getLimit()

hasLimit

public boolean hasLimit()

Description copied from interface: QueryOptions

Did the application explicitly request paging limits?

Specified by:

hasLimit in interface QueryOptions

See Also:

• QueryOptions.getLimit()

getUniqueSemantic

@Nullable
public ListResultsConsumer.UniqueSemantic getUniqueSemantic()

Specified by:

getUniqueSemantic in interface QueryOptions

isScrollExecution

public boolean isScrollExecution()

Description copied from interface: QueryOptions

Whether this execution goes through scroll() / getResultStream() and therefore needs SQL row ordering stable enough for scroll-style result grouping.

Specified by:

isScrollExecution in interface QueryOptions