Package org.hibernate.query.sqm.spi

Class DelegatingSqmSelectionQueryImplementor<R>

java.lang.Object

org.hibernate.query.sqm.spi.DelegatingSqmSelectionQueryImplementor<R>

All Implemented Interfaces:

CommonQueryContract, SelectionQuery<R>, SqmQuery<R>, SqmSelectionQueryImplementor<R>, SqmSelectionQuery<R>

@Incubating
public abstract class DelegatingSqmSelectionQueryImplementor<R>
extends Object
implements SqmSelectionQueryImplementor<R>

Constructor Summary

Constructors

Constructor	Description
DelegatingSqmSelectionQueryImplementor()

Method Summary

Modifier and Type	Method	Description
SqmSelectionQueryImplementor<R>	disableFetchProfile(String profileName)	Disable the fetch profile with the given name in this session.
SqmSelectionQueryImplementor<R>	enableFetchProfile(String profileName)	Enable the fetch profile with the given name during execution of this query.
<T> T	executeQuery(ResultsConsumer<T,R> resultsConsumer)
CacheMode	getCacheMode()	Obtain the CacheMode in effect for this query.
String	getCacheRegion()	Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on SelectionQuery.isCacheable() for more information).
CacheRetrieveMode	getCacheRetrieveMode()
CacheStoreMode	getCacheStoreMode()
String	getComment()	Get the comment that has been set for this query, if any.
protected abstract SqmSelectionQueryImplementor<R>	getDelegate()
Integer	getFetchSize()	Obtain the JDBC fetch size hint in effect for this query.
int	getFirstResult()	The first query result row to return.
FlushModeType	getFlushMode()	Deprecated.
FlushMode	getHibernateFlushMode()	Deprecated.
LockMode	getHibernateLockMode()	Get the root LockMode for the query
KeyedResultList<R>	getKeyedResultList(KeyedPage<R> page)	Execute the query and return the results for the given page, using key-based pagination.
LockModeType	getLockMode()	Get the root LockModeType for the query
LockOptions	getLockOptions()	Deprecated.
int	getMaxResults()	The maximum number of query result rows to return.
ParameterMetadata	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
QueryFlushMode	getQueryFlushMode()	The QueryFlushMode in effect for this query.
QueryOptions	getQueryOptions()
String	getQueryString()
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.
List<R>	getResultList()	Execute the query and return the query results as a List.
Stream<R>	getResultStream()	Execute the query and return the query results as a Stream.
R	getSingleResult()	Execute the query and return the single result of the query, throwing an exception if the query returns no results.
R	getSingleResultOrNull()	Execute the query and return the single result of the query, or null if the query returns no results.
SqmStatement<R>	getSqmStatement()
Integer	getTimeout()	Obtain the query timeout in seconds.
boolean	isCacheable()	Should the results of the query be stored in the second level cache?
boolean	isQueryPlanCacheable()	Should the query plan of the query be stored in the query plan cache?
boolean	isReadOnly()	Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context i s returned instead.
List<R>	list()	Execute the query and return the query results as a List.
ScrollableResults<R>	scroll()	Returns scrollable access to the query results, using the default scroll mode of the SQL dialect.
ScrollableResults<R>	scroll(ScrollMode scrollMode)	Returns scrollable access to the query results.
SqmSelectionQueryImplementor<R>	setCacheable(boolean cacheable)	Enable/disable second level query (result) caching for this query.
SqmSelectionQueryImplementor<R>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect for this query.
SqmSelectionQueryImplementor<R>	setCacheRegion(String cacheRegion)	Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()).
SqmSelectionQueryImplementor<R>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
SqmSelectionQueryImplementor<R>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
SqmSelectionQueryImplementor<R>	setComment(String comment)	Set a comment for this query.
SqmSelectionQueryImplementor<R>	setEntityGraph(EntityGraph<? super R> graph, GraphSemantic semantic)	Apply an EntityGraph to the query.
SqmSelectionQueryImplementor<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
SqmSelectionQueryImplementor<R>	setFirstResult(int startPosition)	Set the first query result row to return.
SqmSelectionQueryImplementor<R>	setFlushMode(FlushModeType flushMode)	Deprecated.
SqmSelectionQueryImplementor<R>	setFollowOnLocking(boolean enable)	Specifies whether follow-on locking should be applied
SelectionQuery<R>	setFollowOnStrategy(Locking.FollowOn followOnStrategy)	Specifies whether follow-on locking should be applied
SqmSelectionQueryImplementor<R>	setHibernateFlushMode(FlushMode flushMode)	Deprecated.
SqmSelectionQueryImplementor<R>	setHibernateLockMode(LockMode lockMode)	Specify the root LockMode for the query
SqmSelectionQueryImplementor<R>	setHint(String hintName, Object value)	Set a hint.
SqmSelectionQueryImplementor<R>	setLockMode(LockModeType lockMode)	Specify the root LockModeType for the query
SqmSelectionQueryImplementor<R>	setLockMode(String alias, LockMode lockMode)	Specify a LockMode to apply to a specific alias defined in the query
SqmSelectionQueryImplementor<R>	setLockScope(PessimisticLockScope lockScope)	Apply a scope to any pessimistic locking applied to the query.
SelectionQuery<R>	setLockScope(Locking.Scope lockScope)	Apply a scope to any pessimistic locking applied to the query.
SqmSelectionQueryImplementor<R>	setMaxResults(int maxResults)	Set the maximum number of query result rows to return.
SqmSelectionQueryImplementor<R>	setPage(Page page)	Set the page of results to return.
SqmSelectionQueryImplementor<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
SqmSelectionQueryImplementor<R>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
SqmSelectionQueryImplementor<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQueryImplementor<R>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> SqmSelectionQueryImplementor<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> SqmSelectionQueryImplementor<R>	setParameter(int position, P value, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
SqmSelectionQueryImplementor<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQueryImplementor<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<T> SqmSelectionQueryImplementor<R>	setParameter(Parameter<T> param, T value)
SqmSelectionQueryImplementor<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
SqmSelectionQueryImplementor<R>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
SqmSelectionQueryImplementor<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQueryImplementor<R>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> SqmSelectionQueryImplementor<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> SqmSelectionQueryImplementor<R>	setParameter(String name, P value, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> SqmSelectionQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P val, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> SqmSelectionQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P value, Class<P> type)	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.
<T> SqmSelectionQueryImplementor<R>	setParameter(QueryParameter<T> parameter, T value)	Bind an argument to the query parameter represented by the given QueryParameter.
SqmSelectionQueryImplementor<R>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
SqmSelectionQueryImplementor<R>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> SqmSelectionQueryImplementor<R>	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmSelectionQueryImplementor<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> SqmSelectionQueryImplementor<R>	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmSelectionQueryImplementor<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.
SqmSelectionQueryImplementor<R>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
SqmSelectionQueryImplementor<R>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> SqmSelectionQueryImplementor<R>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmSelectionQueryImplementor<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> SqmSelectionQueryImplementor<R>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmSelectionQueryImplementor<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> SqmSelectionQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmSelectionQueryImplementor<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> SqmSelectionQueryImplementor<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> SqmSelectionQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmSelectionQueryImplementor<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> SqmSelectionQueryImplementor<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.
SqmSelectionQueryImplementor<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.
SqmSelectionQueryImplementor<R>	setProperties(Map bean)	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.
SqmSelectionQueryImplementor<R>	setQueryPlanCacheable(boolean queryPlanCacheable)	Enable/disable query plan caching for this query.
SqmSelectionQueryImplementor<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.
SqmSelectionQueryImplementor<R>	setTimeout(int timeout)	Set the query timeout in seconds.
SqmSelectionQueryImplementor<R>	setTimeout(Timeout timeout)	Apply a timeout to the corresponding database query.
<T> SqmSelectionQuery<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.
Stream<R>	stream()	Execute the query and return the query results as a Stream.
R	uniqueResult()	Execute the query and return the single result of the query, or null if the query returns no results.
Optional<R>	uniqueResultOptional()	Execute the query and return the single result of the query, as an Optional.

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingSqmSelectionQueryImplementor

public DelegatingSqmSelectionQueryImplementor()

Method Details

getDelegate

protected abstract SqmSelectionQueryImplementor<R> getDelegate()

getFlushMode

@Deprecated
public FlushModeType getFlushMode()

Deprecated.

Description copied from interface: CommonQueryContract

The JPA FlushModeType in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.

Specified by:

getFlushMode in interface CommonQueryContract

See Also:

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

setFlushMode

@Deprecated
public SqmSelectionQueryImplementor<R> setFlushMode(FlushModeType flushMode)

Deprecated.

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>

See Also:

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

getHibernateFlushMode

@Deprecated
public FlushMode getHibernateFlushMode()

Deprecated.

Description copied from interface: CommonQueryContract

The FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.

Specified by:

getHibernateFlushMode in interface CommonQueryContract

See Also:

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

getQueryFlushMode

public QueryFlushMode getQueryFlushMode()

Description copied from interface: CommonQueryContract

The QueryFlushMode in effect for this query.

By default, this is QueryFlushMode.DEFAULT, and the FlushMode of the owning Session determines whether it is flushed.

Specified by:

getQueryFlushMode in interface CommonQueryContract

See Also:

• 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>

See Also:

• Session.getHibernateFlushMode()

getTimeout

public Integer getTimeout()

Description copied from interface: CommonQueryContract

Obtain the query timeout in seconds.

This value is eventually passed along to the JDBC statement via Statement.setQueryTimeout(int).

A value of zero indicates no timeout.

Specified by:

getTimeout in interface CommonQueryContract

See Also:

• Statement.getQueryTimeout()
• Statement.setQueryTimeout(int)

getComment

public String getComment()

Description copied from interface: CommonQueryContract

Get the comment that has been set for this query, if any.

Specified by:

getComment in interface CommonQueryContract

setComment

public SqmSelectionQueryImplementor<R> setComment(String comment)

Description copied from interface: CommonQueryContract

Set a comment for this query.

Specified by:

setComment in interface CommonQueryContract

Specified by:

setComment in interface SelectionQuery<R>

See Also:

• Query.setComment(String)

setHint

public SqmSelectionQueryImplementor<R> setHint(String hintName,
 Object value)

Description copied from interface: CommonQueryContract

Set a hint. The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface SelectionQuery<R>

See Also:

• HibernateHints
• SpecHints

list

public List<R> list()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a List. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

list in interface SelectionQuery<R>

Returns:

the result list

getResultList

public List<R> getResultList()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a List. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

getResultList in interface SelectionQuery<R>

Returns:

the results as a list

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

getKeyedResultList

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

Description copied from interface: SelectionQuery

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

Specified by:

getKeyedResultList in interface SelectionQuery<R>

Parameters:

page - 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

scroll

public ScrollableResults<R> scroll()

Description copied from interface: SelectionQuery

Returns scrollable access to the query results, using the default scroll mode of the SQL dialect.

Specified by:

scroll in interface SelectionQuery<R>

See Also:

• SelectionQuery.scroll(ScrollMode)

scroll

public ScrollableResults<R> scroll(ScrollMode scrollMode)

Description copied from interface: SelectionQuery

Returns scrollable access to the query results. The capabilities of the returned ScrollableResults depend on the specified ScrollMode.

Specified by:

scroll in interface SelectionQuery<R>

getResultStream

public Stream<R> getResultStream()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

getResultStream in interface SelectionQuery<R>

Returns:

The results as a Stream

stream

public Stream<R> stream()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

stream in interface SelectionQuery<R>

Returns:

The results as a Stream

uniqueResult

public R uniqueResult()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, or null if the query returns no results.

Specified by:

uniqueResult in interface SelectionQuery<R>

Returns:

the single result or null

getSingleResult

public R getSingleResult()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, throwing an exception if the query returns no results.

Specified by:

getSingleResult in interface SelectionQuery<R>

Returns:

the single result, only if there is exactly one

getSingleResultOrNull

public R getSingleResultOrNull()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, or null if the query returns no results.

Specified by:

getSingleResultOrNull in interface SelectionQuery<R>

Returns:

the single result or null if there is no result to return

uniqueResultOptional

public Optional<R> uniqueResultOptional()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, as an Optional.

Specified by:

uniqueResultOptional in interface SelectionQuery<R>

Returns:

the single result as an Optional

setEntityGraph

public SqmSelectionQueryImplementor<R> setEntityGraph(EntityGraph<? super R> graph,
 GraphSemantic semantic)

Description copied from interface: SelectionQuery

Apply an EntityGraph to the query.

This is an alternative way to specify the associations which should be fetched as part of the initial query.

Specified by:

setEntityGraph in interface SelectionQuery<R>

enableFetchProfile

public SqmSelectionQueryImplementor<R> enableFetchProfile(String profileName)

Description copied from interface: SelectionQuery

Enable the fetch profile with the given name during execution of this query. If the requested fetch profile is already enabled, the call has no effect.

This is an alternative way to specify the associations which should be fetched as part of the initial query.

Specified by:

enableFetchProfile in interface SelectionQuery<R>

Parameters:

profileName - the name of the fetch profile to be enabled

See Also:

• FetchProfile

disableFetchProfile

public SqmSelectionQueryImplementor<R> disableFetchProfile(String profileName)

Description copied from interface: SelectionQuery

Disable the fetch profile with the given name in this session. If the fetch profile is not currently enabled, the call has no effect.

Specified by:

disableFetchProfile in interface SelectionQuery<R>

Parameters:

profileName - the name of the fetch profile to be disabled

See Also:

• FetchProfile

getFetchSize

public Integer getFetchSize()

Description copied from interface: SelectionQuery

Obtain the JDBC fetch size hint in effect for this query. This value is eventually passed along to the JDBC query via Statement.setFetchSize(int). As defined by JDBC, this value is a hint to the driver to indicate how many rows to fetch from the database when more rows are needed.

Specified by:

getFetchSize in interface SelectionQuery<R>

Returns:

The timeout in seconds

See Also:

• Statement.getFetchSize()
• Statement.setFetchSize(int)

isReadOnly

public boolean isReadOnly()

Description copied from interface: SelectionQuery

Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context i s returned instead.

Specified by:

isReadOnly in interface SelectionQuery<R>

Returns:

true if the entities and proxies loaded by the query will be put in read-only mode; false otherwise (they will be modifiable)

See Also:

• SelectionQuery.setReadOnly(boolean)
• 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.

getMaxResults

public int getMaxResults()

Description copied from interface: SelectionQuery

The maximum number of query result rows to return.

Specified by:

getMaxResults in interface SelectionQuery<R>

Returns:

the maximum length of the query result list

setMaxResults

public SqmSelectionQueryImplementor<R> setMaxResults(int maxResults)

Description copied from interface: SelectionQuery

Set the maximum number of query result rows to return.

Specified by:

setMaxResults in interface SelectionQuery<R>

Parameters:

maxResults - the maximum length of the query result list

getFirstResult

public int getFirstResult()

Description copied from interface: SelectionQuery

The first query result row to return. The very first row of the query result list is considered the zeroth row.

Specified by:

getFirstResult in interface SelectionQuery<R>

Returns:

the position of the first row to return, indexed from zero

setFirstResult

public SqmSelectionQueryImplementor<R> setFirstResult(int startPosition)

Description copied from interface: SelectionQuery

Set the first query result row to return. The very first row of the query result list is considered the zeroth row.

Specified by:

setFirstResult in interface SelectionQuery<R>

Parameters:

startPosition - the position of the first row to return, indexed from zero

setPage

@Incubating
public SqmSelectionQueryImplementor<R> setPage(Page page)

Description copied from interface: SelectionQuery

Set the page of results to return.

Specified by:

setPage in interface SelectionQuery<R>

See Also:

• Page

getCacheMode

public CacheMode getCacheMode()

Description copied from interface: SelectionQuery

Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the session from which it originates.

The CacheMode here affects the use of entity and collection caches as the query result set is processed. For caching of the actual query results, use SelectionQuery.isCacheable() and SelectionQuery.getCacheRegion().

In order for this setting to have any affect, second-level caching must be enabled and the entities and collections must be eligible for storage in the second-level cache.

Specified by:

getCacheMode in interface SelectionQuery<R>

See Also:

• Session.getCacheMode()

getCacheStoreMode

public CacheStoreMode getCacheStoreMode()

Specified by:

getCacheStoreMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.getCacheMode()

getCacheRetrieveMode

public CacheRetrieveMode getCacheRetrieveMode()

Specified by:

getCacheRetrieveMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.getCacheMode()

setCacheStoreMode

public SqmSelectionQueryImplementor<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheRetrieveMode

public SqmSelectionQueryImplementor<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

isCacheable

public boolean isCacheable()

Description copied from interface: SelectionQuery

Should the results of the query be stored in the second level cache?

This is different to second level caching of any returned entities and collections, which is controlled by SelectionQuery.getCacheMode().

The query being "eligible" for caching does not necessarily mean its results will be cached. Second-level query caching still has to be enabled on the SessionFactory for this to happen. Usually that is controlled by the configuration setting "hibernate.cache.use_query_cache".

Specified by:

isCacheable in interface SelectionQuery<R>

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 SelectionQuery<R>

setQueryPlanCacheable

public SqmSelectionQueryImplementor<R> setQueryPlanCacheable(boolean queryPlanCacheable)

Description copied from interface: SelectionQuery

Enable/disable query plan caching for this query.

Specified by:

setQueryPlanCacheable in interface SelectionQuery<R>

See Also:

• SelectionQuery.isQueryPlanCacheable()

getCacheRegion

public String getCacheRegion()

Description copied from interface: SelectionQuery

Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on SelectionQuery.isCacheable() for more information). null indicates that the default region should be used.

Specified by:

getCacheRegion in interface SelectionQuery<R>

getLockOptions

@Deprecated
public LockOptions getLockOptions()

Deprecated.

Description copied from interface: SelectionQuery

The LockOptions currently in effect for the query

Specified by:

getLockOptions in interface SelectionQuery<R>

getLockMode

public LockModeType getLockMode()

Description copied from interface: SelectionQuery

Get the root LockModeType for the query

Specified by:

getLockMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.getHibernateLockMode()

setLockMode

public SqmSelectionQueryImplementor<R> setLockMode(LockModeType lockMode)

Description copied from interface: SelectionQuery

Specify the root LockModeType for the query

Specified by:

setLockMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.setHibernateLockMode(org.hibernate.LockMode)

getHibernateLockMode

public LockMode getHibernateLockMode()

Description copied from interface: SelectionQuery

Get the root LockMode for the query

Specified by:

getHibernateLockMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.getLockMode()

setHibernateLockMode

public SqmSelectionQueryImplementor<R> setHibernateLockMode(LockMode lockMode)

Description copied from interface: SelectionQuery

Specify the root LockMode for the query

Specified by:

setHibernateLockMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.setLockMode(LockModeType)

setLockMode

public SqmSelectionQueryImplementor<R> setLockMode(String alias,
 LockMode lockMode)

Description copied from interface: SelectionQuery

Specify a LockMode to apply to a specific alias defined in the query

Specified by:

setLockMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.setHibernateLockMode(org.hibernate.LockMode)
• SelectionQuery.setLockScope(Locking.Scope)

setTimeout

public SqmSelectionQueryImplementor<R> setTimeout(Timeout timeout)

Description copied from interface: CommonQueryContract

Apply a timeout to the corresponding database query.

Specified by:

setTimeout in interface CommonQueryContract

Parameters:

timeout - The timeout to apply

Returns:

this, for method chaining

setLockScope

public SelectionQuery<R> setLockScope(Locking.Scope lockScope)

Description copied from interface: SelectionQuery

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

Specified by:

setLockScope in interface SelectionQuery<R>

Parameters:

lockScope - The lock scope to apply

Returns:

this, for method chaining

setFollowOnStrategy

public SelectionQuery<R> setFollowOnStrategy(Locking.FollowOn followOnStrategy)

Description copied from interface: SelectionQuery

Specifies whether follow-on locking should be applied

Specified by:

setFollowOnStrategy in interface SelectionQuery<R>

setLockScope

public SqmSelectionQueryImplementor<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>

Parameters:

lockScope - The lock scope to apply

Returns:

this, for method chaining

setFollowOnLocking

public SqmSelectionQueryImplementor<R> setFollowOnLocking(boolean enable)

Description copied from interface: SelectionQuery

Specifies whether follow-on locking should be applied

Specified by:

setFollowOnLocking in interface SelectionQuery<R>

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface SqmQuery<R>

getSqmStatement

public SqmStatement<R> getSqmStatement()

Specified by:

getSqmStatement in interface SqmQuery<R>

getParameterMetadata

public ParameterMetadata 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>

getQueryOptions

public QueryOptions getQueryOptions()

Specified by:

getQueryOptions in interface SqmQuery<R>

setParameter

public SqmSelectionQueryImplementor<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>

See Also:

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

setParameter

public <P> SqmSelectionQueryImplementor<R> setParameter(String name,
 P value,
 Class<P> type)

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>

See Also:

• CommonQueryContract.setParameter(String, Object, Type)

setParameter

public <P> SqmSelectionQueryImplementor<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>

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

public SqmSelectionQueryImplementor<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>

See Also:

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

setParameter

public <P> SqmSelectionQueryImplementor<R> setParameter(int position,
 P value,
 Class<P> type)

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>

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

public <P> SqmSelectionQueryImplementor<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>

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

public <T> SqmSelectionQueryImplementor<R> setParameter(QueryParameter<T> parameter,
 T 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>

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> SqmSelectionQueryImplementor<R> setParameter(QueryParameter<P> parameter,
 P value,
 Class<P> type)

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>

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

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> SqmSelectionQueryImplementor<R> setParameter(QueryParameter<P> parameter,
 P val,
 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>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

public <T> SqmSelectionQueryImplementor<R> setParameter(Parameter<T> param,
 T 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>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated
public SqmSelectionQueryImplementor<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>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

public SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

See Also:

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

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

See Also:

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

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

See Also:

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

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

See Also:

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

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

See Also:

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

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

See Also:

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

setParameterList

public <P> SqmSelectionQueryImplementor<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>

Returns:

this, for method chaining

setProperties

public SqmSelectionQueryImplementor<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>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

public SqmSelectionQueryImplementor<R> setProperties(Map bean)

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>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setHibernateFlushMode

@Deprecated
public SqmSelectionQueryImplementor<R> setHibernateFlushMode(FlushMode flushMode)

Deprecated.

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>

See Also:

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

setCacheMode

public SqmSelectionQueryImplementor<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>

See Also:

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

setCacheable

public SqmSelectionQueryImplementor<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>

See Also:

• SelectionQuery.isCacheable()

setCacheRegion

public SqmSelectionQueryImplementor<R> setCacheRegion(String cacheRegion)

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>

See Also:

• SelectionQuery.getCacheRegion()

setTimeout

public SqmSelectionQueryImplementor<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>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

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

setFetchSize

public SqmSelectionQueryImplementor<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>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()

setReadOnly

public SqmSelectionQueryImplementor<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>

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

executeQuery

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

Specified by:

executeQuery in interface SqmSelectionQueryImplementor<R>

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>