Package org.hibernate.query.spi

Class DelegatingQueryOptions

java.lang.Object

org.hibernate.query.spi.DelegatingQueryOptions

All Implemented Interfaces:

QueryOptions

Direct Known Subclasses:

SqlOmittingQueryOptions

public class DelegatingQueryOptions
extends Object
implements QueryOptions

Field Summary

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

NONE, READ_ONLY, READ_WRITE

Constructor Summary

Constructors

Constructor	Description
DelegatingQueryOptions(QueryOptions queryOptions)

Method Summary

Modifier and Type	Method	Description
AppliedGraph	getAppliedGraph()	JPA 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
FlushMode	getFlushMode()	The flush mode to use for the query execution
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
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
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
ListResultsConsumer.UniqueSemantic	getUniqueSemantic()
boolean	hasLimit()	Did the application explicitly request paging limits?
Boolean	isReadOnly()	Should entities returned from the query be marked read-only.
Boolean	isResultCachingEnabled()	Should results from the query be cached?

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingQueryOptions

public DelegatingQueryOptions(QueryOptions queryOptions)

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

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

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

getQueryPlanCachingEnabled

public Boolean getQueryPlanCachingEnabled()

Description copied from interface: QueryOptions

Should the query plan of the query be cached?

Specified by:

getQueryPlanCachingEnabled in interface QueryOptions

getCacheMode

public CacheMode getCacheMode()

Specified by:

getCacheMode in interface QueryOptions

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

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

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

getFirstRow

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

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

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

public ListResultsConsumer.UniqueSemantic getUniqueSemantic()

Specified by:

getUniqueSemantic in interface QueryOptions