Top Fields Constructors Methods
org.hibernate.query.spi

public Class DelegatingQueryOptions

extends Object
implements QueryOptions
Class Inheritance
All Implemented Interfaces
org.hibernate.query.spi.QueryOptions
Known Direct Subclasses
org.hibernate.query.spi.SqlOmittingQueryOptions, org.hibernate.query.sqm.internal.QuerySqmImpl.UniqueSemanticFilterQueryOption
Imports
java.util.List, .Set, jakarta.persistence.CacheRetrieveMode, .CacheStoreMode, org.hibernate.CacheMode, .FlushMode, .LockOptions, org.hibernate.graph.spi.AppliedGraph, org.hibernate.query.ResultListTransformer, .TupleTransformer, org.hibernate.sql.results.spi.ListResultsConsumer
Author
Christian Beikov

Field Summary

Modifier and TypeField and Description
private final QueryOptions
queryOptions

Constructor Summary

AccessConstructor and Description
public
DelegatingQueryOptions(QueryOptions queryOptions)

Method Summary

Modifier and TypeMethod and Description
public AppliedGraph
getAppliedGraph()

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

JPA jakarta.persistence.EntityGraph explicitly applied to the query.
public CacheMode
getCacheMode()

Overrides default org.hibernate.query.spi.QueryOptions.getCacheMode.

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

Overrides default org.hibernate.query.spi.QueryOptions.getEffectiveLimit.

Determine the effective paging limit to apply to the 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 Integer
getFirstRow()

Overrides default org.hibernate.query.spi.QueryOptions.getFirstRow.

The first row from the results to return
public FlushMode
getFlushMode()

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

The flush mode to use for the query execution
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 Integer
getMaxRows()

Overrides default org.hibernate.query.spi.QueryOptions.getMaxRows.

The maximum number of rows to return from the 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 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 ListResultsConsumer.UniqueSemantic
getUniqueSemantic()

Overrides default org.hibernate.query.spi.QueryOptions.getUniqueSemantic.

public boolean
hasLimit()

Overrides default org.hibernate.query.spi.QueryOptions.hasLimit.

Did the application explicitly request paging limits?
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?
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

queryOptionsback to summary
private final QueryOptions queryOptions

Constructor Detail

DelegatingQueryOptionsback to summary
public DelegatingQueryOptions(QueryOptions queryOptions)

Method Detail

getAppliedGraphback 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
getCacheModeback to summary
public CacheMode getCacheMode()

Overrides default org.hibernate.query.spi.QueryOptions.getCacheMode.

Annotations
@Override
getCacheRetrieveModeback 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
getCacheStoreModeback 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
getCommentback 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
getDatabaseHintsback 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
getDisabledFetchProfilesback 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
getEffectiveLimitback to summary
public Limit getEffectiveLimit()

Overrides default org.hibernate.query.spi.QueryOptions.getEffectiveLimit.

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

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

Annotations
@Override
getEnabledFetchProfilesback 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
getFetchSizeback 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
getFirstRowback to summary
public Integer getFirstRow()

Overrides default org.hibernate.query.spi.QueryOptions.getFirstRow.

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

The first row from the results to return

Annotations
@Override
getFlushModeback 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
getLimitback 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
getLockOptionsback 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
getMaxRowsback to summary
public Integer getMaxRows()

Overrides default org.hibernate.query.spi.QueryOptions.getMaxRows.

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

The maximum number of rows to return from the results

Annotations
@Override
getQueryPlanCachingEnabledback 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
getResultCacheRegionNameback 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
getResultListTransformerback 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
getTimeoutback 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
getTupleTransformerback 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
getUniqueSemanticback to summary
public ListResultsConsumer.UniqueSemantic getUniqueSemantic()

Overrides default org.hibernate.query.spi.QueryOptions.getUniqueSemantic.

Annotations
@Override
hasLimitback to summary
public boolean hasLimit()

Overrides default org.hibernate.query.spi.QueryOptions.hasLimit.

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

Did the application explicitly request paging limits?

Annotations
@Override
isReadOnlyback 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
isResultCachingEnabledback 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