Package org.hibernate.query.sqm.internal

Class SqmSelectionQueryImpl<R>

java.lang.Object

org.hibernate.query.spi.AbstractCommonQueryContract

org.hibernate.query.spi.AbstractSelectionQuery<R>

org.hibernate.query.sqm.internal.SqmSelectionQueryImpl<R>

All Implemented Interfaces:

CommonQueryContract, SelectionQuery<R>, DomainQueryExecutionContext, SqmQuery<R>, CacheabilityInfluencers, InterpretationsKeySource, SqmSelectionQueryImplementor<R>, SqmSelectionQuery<R>

public class SqmSelectionQueryImpl<R>
extends AbstractSelectionQuery<R>
implements SqmSelectionQueryImplementor<R>, InterpretationsKeySource

Field Summary

Fields inherited from class org.hibernate.query.spi.AbstractSelectionQuery

CRITERIA_HQL_STRING

Constructor Summary

Constructors

Constructor	Description
SqmSelectionQueryImpl(String hql, HqlInterpretation<R> hqlInterpretation, Class<R> expectedResultType, SharedSessionContractImplementor session)	Form used for HQL queries
SqmSelectionQueryImpl(NamedCriteriaQueryMementoImpl<?> memento, SqmSelectStatement<R> selectStatement, Class<R> expectedResultType, SharedSessionContractImplementor session)	Creates a SelectionQuery instance from a named criteria query memento.
SqmSelectionQueryImpl(NamedHqlQueryMementoImpl<?> memento, Class<R> resultType, SharedSessionContractImplementor session)	Creates a SelectionQuery instance from a named HQL memento.
SqmSelectionQueryImpl(SqmSelectStatement<R> criteria, boolean copyAst, Class<R> expectedResultType, SharedSessionContractImplementor session)	Form used for criteria queries
SqmSelectionQueryImpl(SqmSelectStatement<R> criteria, Class<R> expectedResultType, SharedSessionContractImplementor session)	Form used for criteria queries

Method Summary

Modifier and Type	Method	Description
protected void	applySqmOptions(NamedSqmQueryMemento<?> memento)
protected <T> void	bindCriteriaParameter(SqmJpaCriteriaParameterWrapper<T> sqmParameter)
protected SelectQueryPlan<R>	buildConcreteQueryPlan(SqmSelectStatement<R> concreteSqmStatement)
protected <T> ConcreteSqmSelectQueryPlan<T>	buildConcreteQueryPlan(SqmSelectStatement<T> concreteSqmStatement, Class<T> expectedResultType, TupleMetadata tupleMetadata, QueryOptions queryOptions)
protected SelectQueryPlan<R>	buildSelectQueryPlan()
protected TupleMetadata	buildTupleMetadata(SqmStatement<?> statement, Class<R> resultType)
protected void	collectHints(Map<String,Object> hints)
protected void	copyParameterBindings(QueryParameterBindings oldParameterBindings)
protected List<R>	doList()
protected ScrollableResultsImplementor<R>	doScroll(ScrollMode scrollMode)
protected void	errorOrLogForPaginationWithCollectionFetch()
<T> T	executeQuery(ResultsConsumer<T,R> resultsConsumer)
protected int	first(boolean hasLimit, SqmSelectStatement<?> sqmStatement)
DomainParameterXref	getDomainParameterXref()
Class<R>	getExpectedResultType()
KeyedResultList<R>	getKeyedResultList(KeyedPage<R> keyedPage)	Execute the query and return the results for the given page, using key-based pagination.
LoadQueryInfluencers	getLoadQueryInfluencers()
ParameterMetadataImplementor	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
QueryParameterBindings	getQueryParameterBindings()	The domain parameter bindings
String	getQueryString()
Object	getQueryStringCacheKey()
long	getResultCount()	Determine the size of the query result list that would be returned by calling SelectionQuery.getResultList() with no offset or limit applied to the query.
Class<?>	getResultType()
SqmSelectStatement<R>	getSqmStatement()
TupleMetadata	getTupleMetadata()
protected static boolean	hasAppliedGraph(MutableQueryOptions queryOptions)
protected static boolean	hasLimit(SqmSelectStatement<?> sqm, MutableQueryOptions queryOptions)
protected boolean	hasMultiValuedParameterBindings()
BooleanSupplier	hasMultiValuedParameterBindingsChecker()
protected static <T> HqlInterpretation<T>	interpretation(NamedSqmQueryMemento<?> memento, Class<T> expectedResultType, SharedSessionContractImplementor session)
boolean	isQueryPlanCacheable()	Should the query plan of the query be stored in the query plan cache?
protected int	max(boolean hasLimit, SqmSelectStatement<?> sqmStatement, List<R> list)
protected boolean	needsDistinct(boolean containsCollectionFetches, boolean hasLimit, SqmSelectStatement<?> sqmStatement)
protected void	prepareForExecution()
protected boolean	resolveJdbcParameterTypeIfNecessary()
SqmSelectionQuery<R>	setCacheable(boolean cacheable)	Enable/disable second level query (result) caching for this query.
SqmSelectionQuery<R>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect for this query.
SqmSelectionQuery<R>	setCacheRegion(String regionName)	Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()).
SqmSelectionQuery<R>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
SqmSelectionQuery<R>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
SqmSelectionQuery<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
SqmSelectionQuery<R>	setFlushMode(FlushModeType flushMode)	Set the FlushMode to use for this query.
SqmSelectionQuery<R>	setFollowOnLocking(boolean enable)	Specifies whether follow-on locking should be applied?
SqmSelectionQuery<R>	setHibernateFlushMode(FlushMode flushMode)	Set the current FlushMode in effect for this query.
SqmSelectionQuery<R>	setHibernateLockMode(LockMode lockMode)	Specify the root LockMode for the query
SqmSelectionQuery<R>	setLockMode(LockModeType lockMode)	Specify the root LockModeType for the query
SelectionQuery<R>	setLockScope(PessimisticLockScope lockScope)	Apply a scope to any pessimistic locking applied to the query.
SelectionQuery<R>	setPage(Page page)	Set the page of results to return.
SqmSelectionQuery<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
SqmSelectionQuery<R>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> SqmSelectionQuery<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameter(int position, P value, Class<P> javaType)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
SqmSelectionQuery<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> SqmSelectionQuery<R>	setParameter(Parameter<P> parameter, P value)
SqmSelectionQuery<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
SqmSelectionQuery<R>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> SqmSelectionQuery<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameter(String name, P value, Class<P> javaType)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> SqmSelectionQuery<R>	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> SqmSelectionQuery<R>	setParameter(QueryParameter<P> parameter, P value, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> SqmSelectionQuery<R>	setParameter(QueryParameter<P> parameter, P value, Class<P> javaType)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use.
SqmSelectionQuery<R>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
SqmSelectionQuery<R>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> SqmSelectionQuery<R>	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(int position, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
<P> SqmSelectionQuery<R>	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(int position, P[] values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
SqmSelectionQuery<R>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
SqmSelectionQuery<R>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> SqmSelectionQuery<R>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(String name, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> SqmSelectionQuery<R>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(String name, P[] values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
SqmSelectionQuery<R>	setProperties(Object bean)	Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
SqmSelectionQuery<R>	setProperties(Map map)	Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
SqmSelectionQuery<R>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
SqmSelectionQuery<R>	setQueryPlanCacheable(boolean queryPlanCacheable)	Enable/disable query plan caching for this query.
SqmSelectionQuery<R>	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Query.
SqmSelectionQuery<R>	setResultListTransformer(ResultListTransformer<R> transformer)	Set a ResultListTransformer.
protected void	setSqmStatement(SqmSelectStatement<R> sqm)
SqmSelectionQuery<R>	setTimeout(int timeout)	Set the query timeout in seconds.
SelectionQuery<R>	setTimeout(Timeout timeout)	Apply a timeout to the corresponding database query.
<T> SqmSelectionQuery<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.

Methods inherited from class org.hibernate.query.spi.AbstractSelectionQuery

afterQuery, afterQuery, afterQueryHandlingFetchProfiles, applyOptions, beforeQuery, beforeQueryHandlingFetchProfiles, disableFetchProfile, enableFetchProfile, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getCallback, getFetchSize, getFlushMode, getHibernateLockMode, getLockMode, getLockOptions, getResultStream, getSingleResult, getSingleResultOrNull, hasCallbackActions, isCacheable, isReadOnly, list, requiresTxn, resetCallback, scroll, scroll, setComment, setEntityGraph, setFirstResult, setFollowOnStrategy, setHint, setLockMode, setLockScope, setMaxResults, stream, uniqueElement, uniqueResult, uniqueResultOptional

Methods inherited from class org.hibernate.query.spi.AbstractCommonQueryContract

applyCommentHint, applyDatabaseHint, applyEntityGraphHint, applyFlushModeHint, applyFollowOnLockingHint, applyFollowOnStrategyHint, applyGraph, applyGraph, applyHibernateLockMode, applyHint, applyLockModeHint, applyLockModeType, applyLockTimeoutHint, applyLockTimeoutHint, applySelectionHint, applySynchronizeSpacesHint, applyTimeoutHint, determineType, getComment, getExceptionConverter, getFirstResult, getHibernateFlushMode, getHints, getIntegerLiteral, getMaxResults, getMaxRows, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getQueryFlushMode, getQueryOptions, getSession, getSessionFactory, getTimeout, getTypeConfiguration, isBound, locateBinding, locateBinding, locateBinding, locateBinding, putIfNotNull, putIfNotNull

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.sqm.spi.CacheabilityInfluencers

getQueryOptions

Methods inherited from interface org.hibernate.query.CommonQueryContract

getComment, getFlushMode, getHibernateFlushMode, getQueryFlushMode, getTimeout

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

getQueryOptions, getSession

Methods inherited from interface org.hibernate.query.SelectionQuery

disableFetchProfile, enableFetchProfile, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getKeyedResultList, getLockMode, getLockOptions, getMaxResults, getResultList, getResultStream, getSingleResult, getSingleResultOrNull, isCacheable, isReadOnly, list, scroll, scroll, setComment, setEntityGraph, setFirstResult, setFollowOnStrategy, setHint, setLockMode, setLockScope, setMaxResults, setPage, stream, uniqueResult, uniqueResultOptional

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

getQueryOptions

Constructor Details

SqmSelectionQueryImpl

public SqmSelectionQueryImpl(String hql,
 HqlInterpretation<R> hqlInterpretation,
 Class<R> expectedResultType,
 SharedSessionContractImplementor session)

Form used for HQL queries

SqmSelectionQueryImpl

public SqmSelectionQueryImpl(NamedHqlQueryMementoImpl<?> memento,
 Class<R> resultType,
 SharedSessionContractImplementor session)

Creates a SelectionQuery instance from a named HQL memento. Form used from NamedHqlQueryMementoImpl.

SqmSelectionQueryImpl

public SqmSelectionQueryImpl(NamedCriteriaQueryMementoImpl<?> memento,
 SqmSelectStatement<R> selectStatement,
 Class<R> expectedResultType,
 SharedSessionContractImplementor session)

Creates a SelectionQuery instance from a named criteria query memento. Form used from NamedCriteriaQueryMementoImpl

SqmSelectionQueryImpl

public SqmSelectionQueryImpl(SqmSelectStatement<R> criteria,
 Class<R> expectedResultType,
 SharedSessionContractImplementor session)

Form used for criteria queries

SqmSelectionQueryImpl

public SqmSelectionQueryImpl(SqmSelectStatement<R> criteria,
 boolean copyAst,
 Class<R> expectedResultType,
 SharedSessionContractImplementor session)

Form used for criteria queries

Method Details

getTupleMetadata

public TupleMetadata getTupleMetadata()

getSqmStatement

public SqmSelectStatement<R> getSqmStatement()

Specified by:

getSqmStatement in interface CacheabilityInfluencers

Specified by:

getSqmStatement in interface SqmQuery<R>

setSqmStatement

protected void setSqmStatement(SqmSelectStatement<R> sqm)

getDomainParameterXref

public DomainParameterXref getDomainParameterXref()

getParameterMetadata

public ParameterMetadataImplementor getParameterMetadata()

Description copied from interface: CommonQueryContract

Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.

Specified by:

getParameterMetadata in interface CommonQueryContract

Specified by:

getParameterMetadata in interface SqmQuery<R>

Specified by:

getParameterMetadata in class AbstractCommonQueryContract

getQueryParameterBindings

public QueryParameterBindings getQueryParameterBindings()

Description copied from interface: DomainQueryExecutionContext

The domain parameter bindings

Specified by:

getQueryParameterBindings in interface DomainQueryExecutionContext

Specified by:

getQueryParameterBindings in class AbstractCommonQueryContract

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface CacheabilityInfluencers

Specified by:

getQueryString in interface SqmQuery<R>

Specified by:

getQueryString in class AbstractSelectionQuery<R>

getQueryStringCacheKey

public Object getQueryStringCacheKey()

Specified by:

getQueryStringCacheKey in interface CacheabilityInfluencers

setTupleTransformer

public <T> SqmSelectionQuery<T> setTupleTransformer(TupleTransformer<T> transformer)

Description copied from interface: SelectionQuery

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface SelectionQuery<R>

Specified by:

setTupleTransformer in interface SqmSelectionQuery<R>

setResultListTransformer

public SqmSelectionQuery<R> setResultListTransformer(ResultListTransformer<R> transformer)

Description copied from interface: SelectionQuery

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface SelectionQuery<R>

Specified by:

setResultListTransformer in interface SqmSelectionQuery<R>

prepareForExecution

protected void prepareForExecution()

Specified by:

prepareForExecution in class AbstractSelectionQuery<R>

getResultCount

public long getResultCount()

Description copied from interface: SelectionQuery

Determine the size of the query result list that would be returned by calling SelectionQuery.getResultList() with no offset or limit applied to the query.

Specified by:

getResultCount in interface SelectionQuery<R>

Returns:

the size of the list that would be returned

doList

protected List<R> doList()

Specified by:

doList in class AbstractSelectionQuery<R>

doScroll

protected ScrollableResultsImplementor<R> doScroll(ScrollMode scrollMode)

Specified by:

doScroll in class AbstractSelectionQuery<R>

executeQuery

public <T> T executeQuery(ResultsConsumer<T,R> resultsConsumer)

Specified by:

executeQuery in interface SqmSelectionQueryImplementor<R>

getExpectedResultType

public Class<R> getExpectedResultType()

getResultType

public Class<?> getResultType()

Specified by:

getResultType in interface DomainQueryExecutionContext

Specified by:

getResultType in interface InterpretationsKeySource

getLoadQueryInfluencers

public LoadQueryInfluencers getLoadQueryInfluencers()

Specified by:

getLoadQueryInfluencers in interface CacheabilityInfluencers

hasMultiValuedParameterBindingsChecker

public BooleanSupplier hasMultiValuedParameterBindingsChecker()

Specified by:

hasMultiValuedParameterBindingsChecker in interface CacheabilityInfluencers

hasMultiValuedParameterBindings

protected boolean hasMultiValuedParameterBindings()

resolveJdbcParameterTypeIfNecessary

protected boolean resolveJdbcParameterTypeIfNecessary()

Specified by:

resolveJdbcParameterTypeIfNecessary in class AbstractCommonQueryContract

setFlushMode

public SqmSelectionQuery<R> setFlushMode(FlushModeType flushMode)

Description copied from interface: CommonQueryContract

Set the FlushMode to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use CommonQueryContract.setHibernateFlushMode(org.hibernate.FlushMode) passing FlushMode.MANUAL instead to indicate that no automatic flushing should occur.

Specified by:

setFlushMode in interface CommonQueryContract

Specified by:

setFlushMode in interface SelectionQuery<R>

Overrides:

setFlushMode in class AbstractSelectionQuery<R>

See Also:

• CommonQueryContract.getQueryFlushMode()
• CommonQueryContract.getHibernateFlushMode()
• Session.getHibernateFlushMode()

setLockMode

public SqmSelectionQuery<R> setLockMode(LockModeType lockMode)

Specify the root LockModeType for the query

Specified by:

setLockMode in interface SelectionQuery<R>

Overrides:

setLockMode in class AbstractSelectionQuery<R>

See Also:

• setHibernateLockMode(org.hibernate.LockMode)

setHibernateLockMode

public SqmSelectionQuery<R> setHibernateLockMode(LockMode lockMode)

Specify the root LockMode for the query

Specified by:

setHibernateLockMode in interface SelectionQuery<R>

Overrides:

setHibernateLockMode in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.setLockMode(LockModeType)

setTimeout

public SelectionQuery<R> setTimeout(Timeout timeout)

Description copied from interface: CommonQueryContract

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Overrides:

setTimeout in class AbstractSelectionQuery<R>

Parameters:

timeout - The timeout to apply

Returns:

this, for method chaining

setLockScope

public SelectionQuery<R> setLockScope(PessimisticLockScope lockScope)

Description copied from interface: SelectionQuery

Apply a scope to any pessimistic locking applied to the query.

Specified by:

setLockScope in interface SelectionQuery<R>

Overrides:

setLockScope in class AbstractSelectionQuery<R>

Parameters:

lockScope - The lock scope to apply

Returns:

this, for method chaining

setFollowOnLocking

public SqmSelectionQuery<R> setFollowOnLocking(boolean enable)

Specifies whether follow-on locking should be applied?

Specified by:

setFollowOnLocking in interface SelectionQuery<R>

Overrides:

setFollowOnLocking in class AbstractSelectionQuery<R>

setFetchSize

public SqmSelectionQuery<R> setFetchSize(int fetchSize)

Description copied from interface: SelectionQuery

Sets a JDBC fetch size hint for the query.

Specified by:

setFetchSize in interface SelectionQuery<R>

Specified by:

setFetchSize in interface SqmSelectionQuery<R>

Overrides:

setFetchSize in class AbstractSelectionQuery<R>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()

setReadOnly

public SqmSelectionQuery<R> setReadOnly(boolean readOnly)

Description copied from interface: SelectionQuery

Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context, Session.isDefaultReadOnly().

To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session, use Session.setDefaultReadOnly(boolean).

Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted.

When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting.

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session beforeQuery the query was executed.

Specified by:

setReadOnly in interface SelectionQuery<R>

Specified by:

setReadOnly in interface SqmSelectionQuery<R>

Overrides:

setReadOnly in class AbstractSelectionQuery<R>

Parameters:

readOnly - true indicates that entities and proxies loaded by the query are to be put in read-only mode; false indicates that entities and proxies loaded by the query will be put in modifiable mode

Returns:

this, for method chaining

setCacheMode

public SqmSelectionQuery<R> setCacheMode(CacheMode cacheMode)

Description copied from interface: SelectionQuery

Set the current CacheMode in effect for this query.

Set it to null to indicate that the CacheMode of the session should be used.

Specified by:

setCacheMode in interface SelectionQuery<R>

Specified by:

setCacheMode in interface SqmSelectionQuery<R>

Overrides:

setCacheMode in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.getCacheMode()
• Session.setCacheMode(CacheMode)

setCacheRetrieveMode

public SqmSelectionQuery<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

Overrides:

setCacheRetrieveMode in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheStoreMode

public SqmSelectionQuery<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface SelectionQuery<R>

Overrides:

setCacheStoreMode in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheable

public SqmSelectionQuery<R> setCacheable(boolean cacheable)

Description copied from interface: SelectionQuery

Enable/disable second level query (result) caching for this query.

Specified by:

setCacheable in interface SelectionQuery<R>

Specified by:

setCacheable in interface SqmSelectionQuery<R>

Overrides:

setCacheable in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.isCacheable()

setCacheRegion

public SqmSelectionQuery<R> setCacheRegion(String regionName)

Description copied from interface: SelectionQuery

Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()). null indicates to use the default region.

Specified by:

setCacheRegion in interface SelectionQuery<R>

Specified by:

setCacheRegion in interface SqmSelectionQuery<R>

Overrides:

setCacheRegion in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.getCacheRegion()

setQueryPlanCacheable

public SqmSelectionQuery<R> setQueryPlanCacheable(boolean queryPlanCacheable)

Description copied from interface: SelectionQuery

Enable/disable query plan caching for this query.

Specified by:

setQueryPlanCacheable in interface SelectionQuery<R>

Overrides:

setQueryPlanCacheable in class AbstractSelectionQuery<R>

See Also:

• SelectionQuery.isQueryPlanCacheable()

isQueryPlanCacheable

public boolean isQueryPlanCacheable()

Description copied from interface: SelectionQuery

Should the query plan of the query be stored in the query plan cache?

Specified by:

isQueryPlanCacheable in interface CacheabilityInfluencers

Specified by:

isQueryPlanCacheable in interface SelectionQuery<R>

Overrides:

isQueryPlanCacheable in class AbstractSelectionQuery<R>

collectHints

protected void collectHints(Map<String,Object> hints)

Overrides:

collectHints in class AbstractSelectionQuery<R>

setHibernateFlushMode

public SqmSelectionQuery<R> setHibernateFlushMode(FlushMode flushMode)

Description copied from interface: CommonQueryContract

Set the current FlushMode in effect for this query.

Specified by:

setHibernateFlushMode in interface CommonQueryContract

Specified by:

setHibernateFlushMode in interface SelectionQuery<R>

Specified by:

setHibernateFlushMode in interface SqmQuery<R>

Specified by:

setHibernateFlushMode in interface SqmSelectionQuery<R>

Overrides:

setHibernateFlushMode in class AbstractSelectionQuery<R>

See Also:

• CommonQueryContract.getQueryFlushMode()
• CommonQueryContract.getHibernateFlushMode()
• Session.getHibernateFlushMode()

setQueryFlushMode

public SqmSelectionQuery<R> setQueryFlushMode(QueryFlushMode queryFlushMode)

Description copied from interface: CommonQueryContract

Set the QueryFlushMode to use for this query.

Specified by:

setQueryFlushMode in interface CommonQueryContract

Specified by:

setQueryFlushMode in interface SelectionQuery<R>

Specified by:

setQueryFlushMode in interface SqmQuery<R>

Specified by:

setQueryFlushMode in interface SqmSelectionQuery<R>

Overrides:

setQueryFlushMode in class AbstractSelectionQuery<R>

See Also:

• Session.getHibernateFlushMode()

setTimeout

public SqmSelectionQuery<R> setTimeout(int timeout)

Description copied from interface: CommonQueryContract

Set the query timeout in seconds.

Any value set here is eventually passed directly along to the JDBC statement, which expressly disallows negative values. So negative values should be avoided as a general rule, although certain "magic values" are handled - see Timeouts.NO_WAIT.

A value of zero indicates no timeout.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface SelectionQuery<R>

Specified by:

setTimeout in interface SqmSelectionQuery<R>

Overrides:

setTimeout in class AbstractSelectionQuery<R>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

• Timeouts
• CommonQueryContract.setTimeout(Timeout)
• CommonQueryContract.getTimeout()

setParameter

public SqmSelectionQuery<R> setParameter(String name,
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• CommonQueryContract.setParameter(String, Object, Class)
• CommonQueryContract.setParameter(String, Object, Type)
• TypedParameterValue

setParameter

public <P> SqmSelectionQuery<R> setParameter(String name,
 P value,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(String, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• CommonQueryContract.setParameter(String, Object, Type)

setParameter

public <P> SqmSelectionQuery<R> setParameter(String name,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(String name,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

public SqmSelectionQuery<R> setParameter(int position,
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Class)
• CommonQueryContract.setParameter(int, Object, Type)
• TypedParameterValue

setParameter

public <P> SqmSelectionQuery<R> setParameter(int position,
 P value,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(int, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

public <P> SqmSelectionQuery<R> setParameter(int position,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(int position,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

public <P> SqmSelectionQuery<R> setParameter(QueryParameter<P> parameter,
 P value)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> SqmSelectionQuery<R> setParameter(QueryParameter<P> parameter,
 P value,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(QueryParameter, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

javaType - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> SqmSelectionQuery<R> setParameter(QueryParameter<P> parameter,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

public <P> SqmSelectionQuery<R> setParameter(Parameter<P> parameter,
 P value)

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(Parameter<Calendar> param,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(Parameter<Date> param,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(String name,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(String name,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(int position,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

@Deprecated
public SqmSelectionQuery<R> setParameter(int position,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Specified by:

setParameter in interface SqmSelectionQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameterList

public SqmSelectionQuery<R> setParameterList(String name,
 Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(String name,
 Collection<? extends P> values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(String name,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public SqmSelectionQuery<R> setParameterList(String name,
 Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(String name,
 P[] values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use. If unable to determine an appropriate Type, CommonQueryContract.setParameterList(String, Collection) is used

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, Object[], Type)

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(String name,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public SqmSelectionQuery<R> setParameterList(int position,
 Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(int position,
 Collection<? extends P> values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(int position,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public SqmSelectionQuery<R> setParameterList(int position,
 Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(int position,
 P[] values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Object[], Type)

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(int position,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, Type)

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 P[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, Object[], Type)

setParameterList

public <P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Specified by:

setParameterList in interface SqmSelectionQuery<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setProperties

public SqmSelectionQuery<R> setProperties(Map map)

Description copied from interface: CommonQueryContract

Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.

Specified by:

setProperties in interface CommonQueryContract

Specified by:

setProperties in interface SelectionQuery<R>

Specified by:

setProperties in interface SqmQuery<R>

Specified by:

setProperties in interface SqmSelectionQuery<R>

Overrides:

setProperties in class AbstractSelectionQuery<R>

Parameters:

map - a Map of names to arguments

Returns:

this, for method chaining

setProperties

public SqmSelectionQuery<R> setProperties(Object bean)

Description copied from interface: CommonQueryContract

Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.

Specified by:

setProperties in interface CommonQueryContract

Specified by:

setProperties in interface SelectionQuery<R>

Specified by:

setProperties in interface SqmQuery<R>

Specified by:

setProperties in interface SqmSelectionQuery<R>

Overrides:

setProperties in class AbstractSelectionQuery<R>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

max

protected int max(boolean hasLimit,
 SqmSelectStatement<?> sqmStatement,
 List<R> list)

first

protected int first(boolean hasLimit,
 SqmSelectStatement<?> sqmStatement)

hasLimit

protected static boolean hasLimit(SqmSelectStatement<?> sqm,
 MutableQueryOptions queryOptions)

needsDistinct

protected boolean needsDistinct(boolean containsCollectionFetches,
 boolean hasLimit,
 SqmSelectStatement<?> sqmStatement)

hasAppliedGraph

protected static boolean hasAppliedGraph(MutableQueryOptions queryOptions)

errorOrLogForPaginationWithCollectionFetch

protected void errorOrLogForPaginationWithCollectionFetch()

copyParameterBindings

protected void copyParameterBindings(QueryParameterBindings oldParameterBindings)

bindCriteriaParameter

protected <T> void bindCriteriaParameter(SqmJpaCriteriaParameterWrapper<T> sqmParameter)

setPage

public SelectionQuery<R> setPage(Page page)

Description copied from interface: SelectionQuery

Set the page of results to return.

See Also:

• Page

getKeyedResultList

public KeyedResultList<R> getKeyedResultList(KeyedPage<R> keyedPage)

Description copied from interface: SelectionQuery

Execute the query and return the results for the given page, using key-based pagination.

Parameters:

keyedPage - the key-based specification of the page as an instance of KeyedPage

Returns:

the query results and the key of the next page as an instance of KeyedResultList

See Also:

• KeyedPage
• KeyedResultList

buildSelectQueryPlan

protected SelectQueryPlan<R> buildSelectQueryPlan()

buildConcreteQueryPlan

protected SelectQueryPlan<R> buildConcreteQueryPlan(SqmSelectStatement<R> concreteSqmStatement)

buildConcreteQueryPlan

protected <T> ConcreteSqmSelectQueryPlan<T> buildConcreteQueryPlan(SqmSelectStatement<T> concreteSqmStatement,
 Class<T> expectedResultType,
 TupleMetadata tupleMetadata,
 QueryOptions queryOptions)

applySqmOptions

protected void applySqmOptions(NamedSqmQueryMemento<?> memento)

buildTupleMetadata

protected TupleMetadata buildTupleMetadata(SqmStatement<?> statement,
 Class<R> resultType)

interpretation

protected static <T> HqlInterpretation<T> interpretation(NamedSqmQueryMemento<?> memento,
 Class<T> expectedResultType,
 SharedSessionContractImplementor session)