Package org.hibernate.query.spi

Class AbstractSelectionQuery<R>

java.lang.Object

org.hibernate.query.spi.AbstractCommonQueryContract

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

All Implemented Interfaces:

CommonQueryContract, SelectionQuery<R>, DomainQueryExecutionContext

Direct Known Subclasses:

AbstractQuery

@Internal
public abstract class AbstractSelectionQuery<R>
extends AbstractCommonQueryContract
implements SelectionQuery<R>, DomainQueryExecutionContext

Base implementation of SelectionQuery.

API Note:

This class is now considered internal implementation and will move to an internal package in a future version. Application programs should never depend directly on this class.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRITERIA_HQL_STRING	The value used for getQueryString() for Criteria-based queries

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractSelectionQuery(SharedSessionContractImplementor session)
protected	AbstractSelectionQuery(AbstractSelectionQuery<?> original)

Method Summary

Modifier and Type	Method	Description
protected void	afterQuery()
protected void	afterQuery(boolean success)
protected void	afterQueryHandlingFetchProfiles(boolean success, HashSet<String> fetchProfiles)
protected void	applyOptions(NamedQueryMemento<?> memento)
protected void	beforeQuery()
protected HashSet<String>	beforeQueryHandlingFetchProfiles()
protected void	collectHints(Map<String,Object> hints)
SelectionQuery<R>	disableFetchProfile(String profileName)	Disable the fetch profile with the given name in this session.
protected abstract List<R>	doList()
protected abstract ScrollableResultsImplementor<R>	doScroll(ScrollMode scrollMode)
SelectionQuery<R>	enableFetchProfile(String profileName)	Enable the fetch profile with the given name during execution of this query.
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()
Callback	getCallback()	The callback reference
Integer	getFetchSize()	Obtain the JDBC fetch size hint in effect for this query.
FlushModeType	getFlushMode()	The JPA FlushModeType in effect for this query.
LockMode	getHibernateLockMode()	Get the root LockMode for the query
LockModeType	getLockMode()	Get the root LockModeType for the query
LockOptions	getLockOptions()	Deprecated.
protected abstract String	getQueryString()
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.
boolean	hasCallbackActions()
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.
protected abstract void	prepareForExecution()
protected boolean	requiresTxn(LockMode lockMode)
protected void	resetCallback()
ScrollableResultsImplementor<R>	scroll()	Returns scrollable access to the query results, using the default scroll mode of the SQL dialect.
ScrollableResultsImplementor<R>	scroll(ScrollMode scrollMode)	Returns scrollable access to the query results.
SelectionQuery<R>	setCacheable(boolean cacheable)	Enable/disable second level query (result) caching for this query.
SelectionQuery<R>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect for this query.
SelectionQuery<R>	setCacheRegion(String regionName)	Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()).
SelectionQuery<R>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
SelectionQuery<R>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
SelectionQuery<R>	setComment(String comment)	Set a comment for this query.
SelectionQuery<R>	setEntityGraph(EntityGraph<? super R> graph, GraphSemantic semantic)	Apply an EntityGraph to the query.
SelectionQuery<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
SelectionQuery<R>	setFirstResult(int startPosition)	Set the first query result row to return.
SelectionQuery<R>	setFlushMode(FlushModeType flushMode)	Set the FlushMode to use for this query.
SelectionQuery<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
SelectionQuery<R>	setHibernateFlushMode(FlushMode flushMode)	Set the current FlushMode in effect for this query.
SelectionQuery<R>	setHibernateLockMode(LockMode lockMode)	Specify the root LockMode for the query
SelectionQuery<R>	setHint(String hintName, Object value)	Set a hint.
SelectionQuery<R>	setLockMode(LockModeType lockMode)	Specify the root LockModeType for the query
SelectionQuery<R>	setLockMode(String alias, LockMode lockMode)	Specify a LockMode to apply to a specific alias defined in the query
SelectionQuery<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.
SelectionQuery<R>	setMaxResults(int maxResults)	Set the maximum number of query result rows to return.
SelectionQuery<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
SelectionQuery<R>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
SelectionQuery<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
SelectionQuery<R>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> SelectionQuery<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> SelectionQuery<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.
SelectionQuery<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
SelectionQuery<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> SelectionQuery<R>	setParameter(Parameter<P> parameter, P value)
SelectionQuery<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
SelectionQuery<R>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
SelectionQuery<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
SelectionQuery<R>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> SelectionQuery<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> SelectionQuery<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> SelectionQuery<R>	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> SelectionQuery<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> SelectionQuery<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.
SelectionQuery<R>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
SelectionQuery<R>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> SelectionQuery<R>	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SelectionQuery<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> SelectionQuery<R>	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SelectionQuery<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.
SelectionQuery<R>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
SelectionQuery<R>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> SelectionQuery<R>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SelectionQuery<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> SelectionQuery<R>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SelectionQuery<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> SelectionQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SelectionQuery<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> SelectionQuery<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> SelectionQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SelectionQuery<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> SelectionQuery<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.
SelectionQuery<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.
SelectionQuery<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.
SelectionQuery<R>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
SelectionQuery<R>	setQueryPlanCacheable(boolean queryPlanCacheable)	Enable/disable query plan caching for this query.
SelectionQuery<R>	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Query.
SelectionQuery<R>	setTimeout(int timeout)	Set the query timeout in seconds.
SelectionQuery<R>	setTimeout(Timeout timeout)	Apply a timeout to the corresponding database query.
Stream<R>	stream()	Execute the query and return the query results as a Stream.
protected static <T> T	uniqueElement(List<T> list)
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 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, getInterpretationCache, getMappingMetamodel, getMaxResults, getMaxRows, getParameter, getParameter, getParameter, getParameter, getParameterMetadata, getParameters, getParameterValue, getParameterValue, getParameterValue, getQueryFlushMode, getQueryOptions, getQueryParameter, getQueryParameterBindings, getSession, getSessionFactory, getTimeout, getTypeConfiguration, isBound, locateBinding, locateBinding, locateBinding, locateBinding, putIfNotNull, putIfNotNull, resolveJdbcParameterTypeIfNecessary

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.CommonQueryContract

getComment, getHibernateFlushMode, getParameterMetadata, getQueryFlushMode, getTimeout

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

getQueryOptions, getQueryParameterBindings, getResultType, getSession

Methods inherited from interface org.hibernate.query.SelectionQuery

getFirstResult, getKeyedResultList, getMaxResults, getResultCount, getResultList, setPage, setResultListTransformer, setTupleTransformer

Field Details

CRITERIA_HQL_STRING

public static final String CRITERIA_HQL_STRING

The value used for getQueryString() for Criteria-based queries

See Also:

• Constant Field Values

Constructor Details

AbstractSelectionQuery

public AbstractSelectionQuery(SharedSessionContractImplementor session)

AbstractSelectionQuery

protected AbstractSelectionQuery(AbstractSelectionQuery<?> original)

Method Details

applyOptions

protected void applyOptions(NamedQueryMemento<?> memento)

getQueryString

protected abstract String getQueryString()

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

beforeQueryHandlingFetchProfiles

protected HashSet<String> beforeQueryHandlingFetchProfiles()

beforeQuery

protected void beforeQuery()

prepareForExecution

protected abstract void prepareForExecution()

afterQueryHandlingFetchProfiles

protected void afterQueryHandlingFetchProfiles(boolean success,
 HashSet<String> fetchProfiles)

afterQuery

protected void afterQuery(boolean success)

afterQuery

protected void afterQuery()

requiresTxn

protected boolean requiresTxn(LockMode lockMode)

doList

protected abstract List<R> doList()

scroll

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

doScroll

protected abstract ScrollableResultsImplementor<R> doScroll(ScrollMode scrollMode)

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

uniqueElement

protected static <T> T uniqueElement(List<T> list)
                              throws NonUniqueResultException

Throws:

NonUniqueResultException

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

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

getCallback

public Callback getCallback()

Description copied from interface: DomainQueryExecutionContext

The callback reference

Specified by:

getCallback in interface DomainQueryExecutionContext

hasCallbackActions

public boolean hasCallbackActions()

Specified by:

hasCallbackActions in interface DomainQueryExecutionContext

resetCallback

protected void resetCallback()

getFlushMode

public FlushModeType getFlushMode()

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

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

See Also:

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

setMaxResults

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

setFirstResult

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

setHint

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

Overrides:

setHint in class AbstractCommonQueryContract

See Also:

• HibernateHints
• SpecHints

setEntityGraph

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

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 SelectionQuery<R> setLockMode(LockModeType lockMode)

Specify the root LockModeType for the query

Specified by:

setLockMode in interface SelectionQuery<R>

See Also:

• setHibernateLockMode(org.hibernate.LockMode)

setLockMode

public SelectionQuery<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)

getHibernateLockMode

public LockMode getHibernateLockMode()

Get the root LockMode for the query

Specified by:

getHibernateLockMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.getLockMode()

setHibernateLockMode

public SelectionQuery<R> setHibernateLockMode(LockMode lockMode)

Specify the root LockMode for the query

Specified by:

setHibernateLockMode in interface SelectionQuery<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

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

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>

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>

setFollowOnLocking

public SelectionQuery<R> setFollowOnLocking(boolean enable)

Specifies whether follow-on locking should be applied?

Specified by:

setFollowOnLocking in interface SelectionQuery<R>

collectHints

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

Overrides:

collectHints in class AbstractCommonQueryContract

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)
• JdbcSettings.STATEMENT_FETCH_SIZE

setFetchSize

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

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()
• JdbcSettings.STATEMENT_FETCH_SIZE

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.

setReadOnly

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

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

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

setCacheMode

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

See Also:

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

setCacheRetrieveMode

public SelectionQuery<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheStoreMode

public SelectionQuery<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

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

setCacheable

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

See Also:

• SelectionQuery.isCacheable()

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

setCacheRegion

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

See Also:

• SelectionQuery.getCacheRegion()

setHibernateFlushMode

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

Overrides:

setHibernateFlushMode in class AbstractCommonQueryContract

See Also:

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

setQueryFlushMode

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

Overrides:

setQueryFlushMode in class AbstractCommonQueryContract

See Also:

• Session.getHibernateFlushMode()

setTimeout

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

Overrides:

setTimeout in class AbstractCommonQueryContract

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

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

setComment

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

Overrides:

setComment in class AbstractCommonQueryContract

See Also:

• Query.setComment(String)

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

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

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• CommonQueryContract.setParameter(String, Object, Type)

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

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

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

setParameter

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

Overrides:

setParameter in class AbstractCommonQueryContract

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

Overrides:

setParameter in class AbstractCommonQueryContract

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

Overrides:

setParameter in class AbstractCommonQueryContract

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> SelectionQuery<R> setParameter(Parameter<P> parameter,
 P value)

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• Query.setParameter(Parameter, Object)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractCommonQueryContract

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Overrides:

setParameterList in class AbstractCommonQueryContract

Returns:

this, for method chaining

setProperties

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

Overrides:

setProperties in class AbstractCommonQueryContract

Parameters:

map - a Map of names to arguments

Returns:

this, for method chaining

setProperties

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

Overrides:

setProperties in class AbstractCommonQueryContract

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining