Package org.hibernate.query.sqm.internal

Class QuerySqmImpl<R>

java.lang.Object

org.hibernate.query.spi.AbstractCommonQueryContract

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

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

All Implemented Interfaces:

Query, TypedQuery<R>, CommonQueryContract, SqmQueryImplementor<R>, MutationQuery, NameableQuery, Query<R>, SelectionQuery<R>, DomainQueryExecutionContext, QueryImplementor<R>, SqmQuery, SqmInterpretationsKey.CacheabilityInfluencers, SqmInterpretationsKey.InterpretationsKeySource

public class QuerySqmImpl<R>
extends AbstractSelectionQuery<R>
implements SqmQueryImplementor<R>, SqmInterpretationsKey.InterpretationsKeySource, DomainQueryExecutionContext

Query implementation based on an SQM

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuerySqmImpl.UniqueSemanticFilterQueryOption

Field Summary

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

CRITERIA_HQL_STRING

Constructor Summary

Constructors

Constructor	Description
QuerySqmImpl(String hql, HqlInterpretation hqlInterpretation, Class<R> resultType, SharedSessionContractImplementor session)	Form used for HQL queries
QuerySqmImpl(NamedCriteriaQueryMementoImpl memento, Class<R> resultType, SharedSessionContractImplementor session)
QuerySqmImpl(NamedHqlQueryMementoImpl memento, Class<R> expectedResultType, SharedSessionContractImplementor session)	Creates a Query instance from a named HQL memento
QuerySqmImpl(SqmStatement<R> criteria, Class<R> resultType, SharedSessionContractImplementor producer)	Form used for criteria queries

Method Summary

Modifier and Type	Method	Description
SqmQueryImplementor<R>	addQueryHint(String hint)	Add a database query hint to the SQL query.
protected void	applyAliasSpecificLockModeHint(String hintName, Object value)
protected void	applyFollowOnLockingHint(Boolean followOnLocking)
SqmQueryImplementor<R>	applyGraph(RootGraph graph, GraphSemantic semantic)	Apply the given graph using the given semantic
protected void	applyHibernateLockMode(LockMode value)
protected void	applyLockModeType(LockModeType value)
protected void	applyLockTimeoutHint(int timeout)
protected void	applyLockTimeoutHint(Integer timeout)
protected void	collectHints(Map<String,Object> hints)
protected int	doExecuteUpdate()
protected List<R>	doList()
protected ScrollableResultsImplementor	doScroll(ScrollMode scrollMode)
int	executeUpdate()	Execute an insert, update, or delete statement, and return the number of affected entities.
protected DomainQueryExecutionContext	executionContextFordoList(boolean containsCollectionFetches, boolean hasLimit, boolean needsDistinct)
DomainParameterXref	getDomainParameterXref()
FlushModeType	getFlushMode()	The JPA FlushModeType in effect for this query.
LoadQueryInfluencers	getLoadQueryInfluencers()
LockModeType	getLockMode()	Get the root LockModeType for the query
LockOptions	getLockOptions()	The LockOptions currently in effect for the query
QueryParameterBindings	getParameterBindings()
ParameterMetadataImplementor	getParameterMetadata()	Access to information about query parameters.
QueryParameterBindings	getQueryParameterBindings()	The domain parameter bindings
String	getQueryString()	The query as a string, or null in the case of a criteria query.
Class<R>	getResultType()
SqmStatement	getSqmStatement()
TupleMetadata	getTupleMetadata()
protected boolean	hasIdentifierAssigned(SqmInsertStatement<?> sqmInsert, EntityPersister entityDescriptor)
protected boolean	hasMultiValuedParameterBindings()
Supplier<Boolean>	hasMultiValuedParameterBindingsChecker()
protected boolean	isSimpleValuesInsert(SqmInsertStatement<?> sqmInsert, EntityPersister entityDescriptor)
protected void	prepareForExecution()
protected boolean	resolveJdbcParameterTypeIfNecessary()
SqmQueryImplementor<R>	setCacheable(boolean cacheable)	Enable/disable second level query (result) caching for this query.
SqmQueryImplementor<R>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect for this query.
SqmQueryImplementor<R>	setCacheRegion(String cacheRegion)	Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()).
SqmQueryImplementor<R>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
SqmQueryImplementor<R>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
SqmQueryImplementor<R>	setComment(String comment)	Set a comment for this query.
SqmQueryImplementor<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
SqmQueryImplementor<R>	setFirstResult(int startPosition)	Set the first row position to return from the query results.
SqmQueryImplementor<R>	setFlushMode(FlushModeType flushMode)	Set the FlushMode in to use for this query.
SqmQueryImplementor<R>	setHibernateFlushMode(FlushMode flushMode)	Set the current FlushMode in effect for this query.
SqmQueryImplementor<R>	setHint(String hintName, Object value)	Set a hint.
SqmQueryImplementor<R>	setLockMode(LockModeType lockMode)	Specify the root LockModeType for the query
SqmQueryImplementor<R>	setLockMode(String alias, LockMode lockMode)	Specify a LockMode to apply to a specific alias defined in the query
SqmQueryImplementor<R>	setLockOptions(LockOptions lockOptions)	Apply the given lock options to this query.
SqmQueryImplementor<R>	setMaxResults(int maxResult)	Set the max number of rows requested for the query results.
void	setOptionalEntityName(String entityName)
void	setOptionalId(Serializable id)
void	setOptionalObject(Object optionalObject)
SqmQueryImplementor<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
SqmQueryImplementor<R>	setParameter(int position, Instant value, TemporalType temporalType)	Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.
SqmQueryImplementor<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Query override
SqmQueryImplementor<R>	setParameter(int position, Date value, TemporalType temporalType)	Query override
<P> SqmQueryImplementor<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 BindableType.
<P> SqmQueryImplementor<R>	setParameter(int position, P value, BindableType<P> type)	Bind the given argument to an ordinal query parameter using the given BindableType.
SqmQueryImplementor<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Query override
SqmQueryImplementor<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Query override
<P> SqmQueryImplementor<R>	setParameter(Parameter<P> parameter, P value)	Query override
SqmQueryImplementor<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
SqmQueryImplementor<R>	setParameter(String name, Instant value, TemporalType temporalType)	Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.
SqmQueryImplementor<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Query override
SqmQueryImplementor<R>	setParameter(String name, Date value, TemporalType temporalType)	Query override
<P> SqmQueryImplementor<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 BindableType.
<P> SqmQueryImplementor<R>	setParameter(String name, P value, BindableType<P> type)	Bind the given argument to a named query parameter using the given BindableType.
<P> SqmQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> SqmQueryImplementor<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 BindableType to use.
<P> SqmQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P value, BindableType<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given BindableType.
SqmQueryImplementor<R>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
SqmQueryImplementor<R>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> SqmQueryImplementor<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 BindableType.
<P> SqmQueryImplementor<R>	setParameterList(int position, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to an ordinal query parameter using the given BindableType.
<P> SqmQueryImplementor<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 BindableType.
<P> SqmQueryImplementor<R>	setParameterList(int position, P[] values, BindableType<P> type)	Bind multiple arguments to an ordinal query parameter using the given BindableType.
SqmQueryImplementor<R>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
SqmQueryImplementor<R>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> SqmQueryImplementor<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 BindableType If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> SqmQueryImplementor<R>	setParameterList(String name, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to a named query parameter using the given BindableType.
<P> SqmQueryImplementor<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 BindableType to use.
<P> SqmQueryImplementor<R>	setParameterList(String name, P[] values, BindableType<P> type)	Bind multiple arguments to a named query parameter using the given BindableType.
<P> SqmQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmQueryImplementor<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 BindableType to use.
<P> SqmQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given BindableType.
<P> SqmQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmQueryImplementor<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 BindableType to use.
<P> SqmQueryImplementor<R>	setParameterList(QueryParameter<P> parameter, P[] values, BindableType<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the BindableType.
SqmQueryImplementor<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.
SqmQueryImplementor<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.
SqmQueryImplementor<R>	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Query.
SqmQueryImplementor<R>	setResultListTransformer(ResultListTransformer transformer)	Set a ResultListTransformer.
SqmQueryImplementor<R>	setTimeout(int timeout)	Set the query timeout in seconds.
<T> SqmQueryImplementor<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.
NamedQueryMemento	toMemento(String name)	Convert the query into the memento
static QueryOptions	uniqueSemanticQueryOptions(QueryOptions originalOptions)
<T> T	unwrap(Class<T> cls)
protected void	verifySelect()
protected void	verifyUpdate()

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

afterQuery, afterQuery, applyOptions, applyOptions, beforeQuery, buildTupleMetadata, checkQueryReturnType, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getCallback, getFetchSize, getHibernateLockMode, getSessionFactory, getSingleResult, getSingleResultOrNull, hasAppliedGraph, hasCallbackActions, hasLimit, isCacheable, isReadOnly, list, requiresTxn, resetCallback, scroll, scroll, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode, stream, uniqueElement, uniqueResult, uniqueResultOptional, verifyResultType, visitQueryReturnType

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

applyAdditionalPossibleHints, applyCacheableHint, applyCacheModeHint, applyCacheRegionHint, applyCommentHint, applyEntityGraphHint, applyFetchSizeHint, applyFirstResult, applyFlushModeHint, applyGraph, applyGraph, applyHint, applyJpaCacheRetrieveModeHint, applyJpaCacheStoreModeHint, applyJpaFlushMode, applyLockModeHint, applyMaxResults, applyResultListTransformer, applySelectionHint, applySynchronizeSpacesHint, applyTimeoutHint, applyTupleTransformer, determineType, getComment, getFirstResult, getHibernateFlushMode, getHints, getIntegerLiteral, getJpaFlushMode, getMaxResults, getMaxRows, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getQueryOptions, getSession, getTimeout, isBound, locateBinding, locateBinding, locateBinding, locateBinding, putIfNotNull, putIfNotNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.query.CommonQueryContract

getHibernateFlushMode, getTimeout

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

getCallback, getQueryOptions, getSession, hasCallbackActions

Methods inherited from interface jakarta.persistence.Query

getFirstResult, getHints, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound

Methods inherited from interface org.hibernate.query.Query

getComment, getQueryOptions, getResultList, getResultStream, getSingleResult, list, stream, uniqueResult, uniqueResultOptional

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

getSession, scroll, scroll

Methods inherited from interface org.hibernate.query.SelectionQuery

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getMaxResults, getSingleResultOrNull, isCacheable, isReadOnly, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode

Methods inherited from interface org.hibernate.query.sqm.internal.SqmInterpretationsKey.CacheabilityInfluencers

getQueryOptions

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

getQueryOptions

Methods inherited from interface org.hibernate.query.hql.spi.SqmQueryImplementor

applyFetchGraph, applyLoadGraph, setResultTransformer

Constructor Detail

QuerySqmImpl

public QuerySqmImpl(NamedHqlQueryMementoImpl memento,
                    Class<R> expectedResultType,
                    SharedSessionContractImplementor session)

Creates a Query instance from a named HQL memento

QuerySqmImpl

public QuerySqmImpl(NamedCriteriaQueryMementoImpl memento,
                    Class<R> resultType,
                    SharedSessionContractImplementor session)

QuerySqmImpl

public QuerySqmImpl(String hql,
                    HqlInterpretation hqlInterpretation,
                    Class<R> resultType,
                    SharedSessionContractImplementor session)

Form used for HQL queries

QuerySqmImpl

public QuerySqmImpl(SqmStatement<R> criteria,
                    Class<R> resultType,
                    SharedSessionContractImplementor producer)

Form used for criteria queries

Method Detail

getTupleMetadata

public TupleMetadata getTupleMetadata()

getQueryString

public String getQueryString()

Description copied from interface: Query

The query as a string, or null in the case of a criteria query.

Specified by:

getQueryString in interface Query<R>

Specified by:

getQueryString in interface SqmInterpretationsKey.CacheabilityInfluencers

Specified by:

getQueryString in interface SqmQuery

Specified by:

getQueryString in class AbstractSelectionQuery<R>

getSqmStatement

public SqmStatement getSqmStatement()

Specified by:

getSqmStatement in interface SqmQuery

Specified by:

getSqmStatement in interface SqmQueryImplementor<R>

getDomainParameterXref

public DomainParameterXref getDomainParameterXref()

getParameterMetadata

public ParameterMetadataImplementor getParameterMetadata()

Description copied from interface: Query

Access to information about query parameters.

Specified by:

getParameterMetadata in interface Query<R>

Specified by:

getParameterMetadata in interface SqmQuery

Specified by:

getParameterMetadata in interface SqmQueryImplementor<R>

Specified by:

getParameterMetadata in class AbstractCommonQueryContract

Returns:

information about query parameters.

getQueryParameterBindings

public QueryParameterBindings getQueryParameterBindings()

Description copied from interface: DomainQueryExecutionContext

The domain parameter bindings

Specified by:

getQueryParameterBindings in interface DomainQueryExecutionContext

Specified by:

getQueryParameterBindings in class AbstractCommonQueryContract

getParameterBindings

public QueryParameterBindings getParameterBindings()

Specified by:

getParameterBindings in interface QueryImplementor<R>

getResultType

public Class<R> getResultType()

Specified by:

getResultType in interface SqmInterpretationsKey.InterpretationsKeySource

getLoadQueryInfluencers

public LoadQueryInfluencers getLoadQueryInfluencers()

Specified by:

getLoadQueryInfluencers in interface SqmInterpretationsKey.CacheabilityInfluencers

resolveJdbcParameterTypeIfNecessary

protected boolean resolveJdbcParameterTypeIfNecessary()

Specified by:

resolveJdbcParameterTypeIfNecessary in class AbstractCommonQueryContract

hasMultiValuedParameterBindingsChecker

public Supplier<Boolean> hasMultiValuedParameterBindingsChecker()

Specified by:

hasMultiValuedParameterBindingsChecker in interface SqmInterpretationsKey.CacheabilityInfluencers

hasMultiValuedParameterBindings

protected boolean hasMultiValuedParameterBindings()

prepareForExecution

protected void prepareForExecution()

Specified by:

prepareForExecution in class AbstractSelectionQuery<R>

verifySelect

protected void verifySelect()

doList

protected List<R> doList()

Specified by:

doList in class AbstractSelectionQuery<R>

executionContextFordoList

protected DomainQueryExecutionContext executionContextFordoList(boolean containsCollectionFetches,
                                                                boolean hasLimit,
                                                                boolean needsDistinct)

uniqueSemanticQueryOptions

public static QueryOptions uniqueSemanticQueryOptions(QueryOptions originalOptions)

doScroll

protected ScrollableResultsImplementor doScroll(ScrollMode scrollMode)

Specified by:

doScroll in class AbstractSelectionQuery<R>

executeUpdate

public int executeUpdate()

Description copied from interface: Query

Execute an insert, update, or delete statement, and return the number of affected entities.

For use with instances of MutationQuery created using QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String), QueryProducer.createNativeMutationQuery(String), QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaUpdate), or QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaDelete).

Specified by:

executeUpdate in interface MutationQuery

Specified by:

executeUpdate in interface Query

Specified by:

executeUpdate in interface Query<R>

Returns:

the number of affected entity instances (may differ from the number of affected rows)

See Also:

QueryProducer.createMutationQuery(java.lang.String), QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String), QueryProducer.createNativeMutationQuery(String), Query.executeUpdate(), QueryProducer.createMutationQuery(java.lang.String)

verifyUpdate

protected void verifyUpdate()

doExecuteUpdate

protected int doExecuteUpdate()

hasIdentifierAssigned

protected boolean hasIdentifierAssigned(SqmInsertStatement<?> sqmInsert,
                                        EntityPersister entityDescriptor)

isSimpleValuesInsert

protected boolean isSimpleValuesInsert(SqmInsertStatement<?> sqmInsert,
                                       EntityPersister entityDescriptor)

addQueryHint

public SqmQueryImplementor<R> addQueryHint(String hint)

Description copied from interface: Query

Add a database query hint to the SQL query.

A database hint is a completely different concept to a JPA hint specified using QueryHint or Query.getHints(). These are hints to the JPA provider.

Multiple query hints may be specified. The operation Dialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.

Specified by:

addQueryHint in interface Query<R>

Specified by:

addQueryHint in interface SqmQueryImplementor<R>

Parameters:

hint - The database specific query hint to add.

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: SelectionQuery

The LockOptions currently in effect for the query

Specified by:

getLockOptions in interface Query<R>

Specified by:

getLockOptions in interface SelectionQuery<R>

Overrides:

getLockOptions in class AbstractSelectionQuery<R>

Returns:

The LockOptions currently in effect

See Also:

LockOptions

setLockOptions

public SqmQueryImplementor<R> setLockOptions(LockOptions lockOptions)

Description copied from interface: Query

Apply the given lock options to this query. Alias-specific lock modes in the given lock options are merged with any alias-specific lock mode which have already been set. If a lock mode has already been specified for an alias that is among the aliases in the given lock options, the lock mode specified in the given lock options overrides the lock mode that was already set.

Specified by:

setLockOptions in interface Query<R>

Specified by:

setLockOptions in interface SqmQueryImplementor<R>

Parameters:

lockOptions - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

Query.getLockOptions()

setLockMode

public SqmQueryImplementor<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 Query<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Specified by:

setLockMode in interface SqmQueryImplementor<R>

Overrides:

setLockMode in class AbstractSelectionQuery<R>

Parameters:

alias - A query alias

lockMode - The lock mode to apply

Returns:

this, for method chaining

See Also:

Query.getLockOptions()

setTupleTransformer

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

Description copied from interface: Query

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface Query<R>

Specified by:

setTupleTransformer in interface QueryImplementor<R>

Specified by:

setTupleTransformer in interface SqmQueryImplementor<R>

setResultListTransformer

public SqmQueryImplementor<R> setResultListTransformer(ResultListTransformer transformer)

Description copied from interface: Query

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface Query<R>

Specified by:

setResultListTransformer in interface QueryImplementor<R>

Specified by:

setResultListTransformer in interface SqmQueryImplementor<R>

setMaxResults

public SqmQueryImplementor<R> setMaxResults(int maxResult)

Description copied from interface: SelectionQuery

Set the max number of rows requested for the query results. Applied to the SQL query

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<R>

Specified by:

setMaxResults in interface SelectionQuery<R>

Specified by:

setMaxResults in interface SqmQueryImplementor<R>

Specified by:

setMaxResults in interface TypedQuery<R>

Overrides:

setMaxResults in class AbstractSelectionQuery<R>

setFirstResult

public SqmQueryImplementor<R> setFirstResult(int startPosition)

Description copied from interface: SelectionQuery

Set the first row position to return from the query results. Applied to the SQL query

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<R>

Specified by:

setFirstResult in interface SelectionQuery<R>

Specified by:

setFirstResult in interface SqmQueryImplementor<R>

Specified by:

setFirstResult in interface TypedQuery<R>

Overrides:

setFirstResult in class AbstractSelectionQuery<R>

setHibernateFlushMode

public SqmQueryImplementor<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 MutationQuery

Specified by:

setHibernateFlushMode in interface Query<R>

Specified by:

setHibernateFlushMode in interface SelectionQuery<R>

Specified by:

setHibernateFlushMode in interface SqmQuery

Specified by:

setHibernateFlushMode in interface SqmQueryImplementor<R>

Overrides:

setHibernateFlushMode in class AbstractSelectionQuery<R>

See Also:

CommonQueryContract.getHibernateFlushMode(), Session.getHibernateFlushMode()

setFlushMode

public SqmQueryImplementor<R> setFlushMode(FlushModeType flushMode)

Description copied from interface: CommonQueryContract

Set the FlushMode in to use for this query.

Specified by:

setFlushMode in interface CommonQueryContract

Specified by:

setFlushMode in interface MutationQuery

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface SelectionQuery<R>

Specified by:

setFlushMode in interface SqmQueryImplementor<R>

Specified by:

setFlushMode in interface TypedQuery<R>

Overrides:

setFlushMode in class AbstractSelectionQuery<R>

See Also:

CommonQueryContract.getHibernateFlushMode(), Session.getHibernateFlushMode()

setLockMode

public SqmQueryImplementor<R> setLockMode(LockModeType lockMode)

Description copied from class: AbstractSelectionQuery

Specify the root LockModeType for the query

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Specified by:

setLockMode in interface SqmQueryImplementor<R>

Specified by:

setLockMode in interface TypedQuery<R>

Overrides:

setLockMode in class AbstractSelectionQuery<R>

See Also:

AbstractSelectionQuery.setHibernateLockMode(org.hibernate.LockMode)

getLockMode

public LockModeType getLockMode()

Description copied from interface: SelectionQuery

Get the root LockModeType for the query

Specified by:

getLockMode in interface Query

Specified by:

getLockMode in interface SelectionQuery<R>

Overrides:

getLockMode in class AbstractSelectionQuery<R>

See Also:

SelectionQuery.getHibernateLockMode()

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

Specified by:

getFlushMode in interface Query

Overrides:

getFlushMode in class AbstractSelectionQuery<R>

See Also:

CommonQueryContract.getHibernateFlushMode(), Session.getHibernateFlushMode()

collectHints

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

Overrides:

collectHints in class AbstractSelectionQuery<R>

setHint

public SqmQueryImplementor<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 MutationQuery

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface SelectionQuery<R>

Specified by:

setHint in interface SqmQueryImplementor<R>

Specified by:

setHint in interface TypedQuery<R>

Overrides:

setHint in class AbstractSelectionQuery<R>

See Also:

HibernateHints, SpecHints

applyLockTimeoutHint

protected void applyLockTimeoutHint(Integer timeout)

Overrides:

applyLockTimeoutHint in class AbstractCommonQueryContract

applyLockTimeoutHint

protected void applyLockTimeoutHint(int timeout)

Overrides:

applyLockTimeoutHint in class AbstractCommonQueryContract

applyHibernateLockMode

protected void applyHibernateLockMode(LockMode value)

Overrides:

applyHibernateLockMode in class AbstractCommonQueryContract

applyLockModeType

protected void applyLockModeType(LockModeType value)

Overrides:

applyLockModeType in class AbstractCommonQueryContract

applyAliasSpecificLockModeHint

protected void applyAliasSpecificLockModeHint(String hintName,
                                              Object value)

Overrides:

applyAliasSpecificLockModeHint in class AbstractCommonQueryContract

applyFollowOnLockingHint

protected void applyFollowOnLockingHint(Boolean followOnLocking)

Overrides:

applyFollowOnLockingHint in class AbstractCommonQueryContract

applyGraph

public SqmQueryImplementor<R> applyGraph(RootGraph graph,
                                         GraphSemantic semantic)

Description copied from interface: Query

Apply the given graph using the given semantic

Specified by:

applyGraph in interface Query<R>

Specified by:

applyGraph in interface SqmQueryImplementor<R>

Parameters:

graph - The graph to apply.

semantic - The semantic to use when applying the graph

toMemento

public NamedQueryMemento toMemento(String name)

Description copied from interface: NameableQuery

Convert the query into the memento

Specified by:

toMemento in interface NameableQuery

Specified by:

toMemento in interface SqmQueryImplementor<R>

unwrap

public <T> T unwrap(Class<T> cls)

Specified by:

unwrap in interface Query

setComment

public SqmQueryImplementor<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 MutationQuery

Specified by:

setComment in interface Query<R>

Specified by:

setComment in interface SelectionQuery<R>

Specified by:

setComment in interface SqmQueryImplementor<R>

Overrides:

setComment in class AbstractSelectionQuery<R>

Parameters:

comment - The human-readable comment

Returns:

this, for method chaining

See Also:

Query.setComment(String)

setCacheMode

public SqmQueryImplementor<R> setCacheMode(CacheMode cacheMode)

Description copied from interface: SelectionQuery

Set the current CacheMode in effect for this query.

Specified by:

setCacheMode in interface Query<R>

Specified by:

setCacheMode in interface SelectionQuery<R>

Specified by:

setCacheMode in interface SqmQueryImplementor<R>

Overrides:

setCacheMode in class AbstractSelectionQuery<R>

See Also:

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

setCacheRetrieveMode

public SqmQueryImplementor<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface Query<R>

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

Overrides:

setCacheRetrieveMode in class AbstractSelectionQuery<R>

See Also:

SelectionQuery.setCacheMode(CacheMode)

setCacheStoreMode

public SqmQueryImplementor<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface Query<R>

Specified by:

setCacheStoreMode in interface SelectionQuery<R>

Overrides:

setCacheStoreMode in class AbstractSelectionQuery<R>

See Also:

SelectionQuery.setCacheMode(CacheMode)

setCacheable

public SqmQueryImplementor<R> setCacheable(boolean cacheable)

Description copied from interface: SelectionQuery

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

Specified by:

setCacheable in interface Query<R>

Specified by:

setCacheable in interface SelectionQuery<R>

Specified by:

setCacheable in interface SqmQueryImplementor<R>

Overrides:

setCacheable in class AbstractSelectionQuery<R>

See Also:

SelectionQuery.isCacheable()

setCacheRegion

public SqmQueryImplementor<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 Query<R>

Specified by:

setCacheRegion in interface SelectionQuery<R>

Specified by:

setCacheRegion in interface SqmQueryImplementor<R>

Overrides:

setCacheRegion in class AbstractSelectionQuery<R>

See Also:

SelectionQuery.getCacheRegion()

setTimeout

public SqmQueryImplementor<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.

A value of zero indicates no timeout.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface MutationQuery

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface SelectionQuery<R>

Specified by:

setTimeout in interface SqmQueryImplementor<R>

Overrides:

setTimeout in class AbstractSelectionQuery<R>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

CommonQueryContract.getTimeout()

setFetchSize

public SqmQueryImplementor<R> setFetchSize(int fetchSize)

Description copied from interface: SelectionQuery

Sets a JDBC fetch size hint for the query.

Specified by:

setFetchSize in interface Query<R>

Specified by:

setFetchSize in interface SelectionQuery<R>

Specified by:

setFetchSize in interface SqmQueryImplementor<R>

Overrides:

setFetchSize in class AbstractSelectionQuery<R>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

SelectionQuery.getFetchSize()

setReadOnly

public SqmQueryImplementor<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 Query<R>

Specified by:

setReadOnly in interface SelectionQuery<R>

Specified by:

setReadOnly in interface SqmQueryImplementor<R>

Overrides:

setReadOnly in class AbstractSelectionQuery<R>

Parameters:

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

Returns:

this, for method chaining

setProperties

public SqmQueryImplementor<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 MutationQuery

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Specified by:

setProperties in interface SelectionQuery<R>

Specified by:

setProperties in interface SqmQuery

Specified by:

setProperties in interface SqmQueryImplementor<R>

Overrides:

setProperties in class AbstractSelectionQuery<R>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

public SqmQueryImplementor<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 MutationQuery

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Specified by:

setProperties in interface SelectionQuery<R>

Specified by:

setProperties in interface SqmQuery

Specified by:

setProperties in interface SqmQueryImplementor<R>

Overrides:

setProperties in class AbstractSelectionQuery<R>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setParameter

public SqmQueryImplementor<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 forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

CommonQueryContract.setParameter(String, Object, Class), CommonQueryContract.setParameter(String, Object, BindableType)

setParameter

public <P> SqmQueryImplementor<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 BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameter(String, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

CommonQueryContract.setParameter(String, Object, BindableType)

setParameter

public <P> SqmQueryImplementor<R> setParameter(String name,
                                               P value,
                                               BindableType<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

public SqmQueryImplementor<R> setParameter(String name,
                                           Instant value,
                                           TemporalType temporalType)

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 MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

public SqmQueryImplementor<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 forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

CommonQueryContract.setParameter(int, Object, Class), CommonQueryContract.setParameter(int, Object, BindableType)

setParameter

public <P> SqmQueryImplementor<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 BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameter(int, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

CommonQueryContract.setParameter(int, Object, BindableType)

setParameter

public <P> SqmQueryImplementor<R> setParameter(int position,
                                               P value,
                                               BindableType<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

public SqmQueryImplementor<R> setParameter(int position,
                                           Instant value,
                                           TemporalType temporalType)

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 MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

setParameter

public <P> SqmQueryImplementor<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 forms which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameter(QueryParameter, Object, BindableType)

setParameter

public <P> SqmQueryImplementor<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 BindableType to use. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameter(QueryParameter, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

javaType - a BindableType representing the type of the parameter

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameter(QueryParameter, Object, BindableType)

setParameter

public <P> SqmQueryImplementor<R> setParameter(QueryParameter<P> parameter,
                                               P value,
                                               BindableType<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a BindableType representing the type of the parameter

Returns:

this, for method chaining

setParameter

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

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

Query.setParameter(Parameter, Object)

setParameter

public SqmQueryImplementor<R> setParameter(Parameter<Calendar> param,
                                           Calendar value,
                                           TemporalType temporalType)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

public SqmQueryImplementor<R> setParameter(Parameter<Date> param,
                                           Date value,
                                           TemporalType temporalType)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

Query.setParameter(Parameter, Date, TemporalType)

setParameter

public SqmQueryImplementor<R> setParameter(String name,
                                           Calendar value,
                                           TemporalType temporalType)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

Query.setParameter(String, Calendar, TemporalType)

setParameter

public SqmQueryImplementor<R> setParameter(String name,
                                           Date value,
                                           TemporalType temporalType)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

Query.setParameter(String, Date, TemporalType)

setParameter

public SqmQueryImplementor<R> setParameter(int position,
                                           Calendar value,
                                           TemporalType temporalType)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

Query.setParameter(int, Calendar, TemporalType)

setParameter

public SqmQueryImplementor<R> setParameter(int position,
                                           Date value,
                                           TemporalType temporalType)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery

Specified by:

setParameter in interface SqmQueryImplementor<R>

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractSelectionQuery<R>

See Also:

Query.setParameter(int, Date, TemporalType)

setParameterList

public SqmQueryImplementor<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 MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, BindableType)

setParameterList

public <P> SqmQueryImplementor<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 BindableType If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, BindableType)

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public SqmQueryImplementor<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 MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmQueryImplementor<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 BindableType to use. If unable to determine an appropriate BindableType, CommonQueryContract.setParameterList(String, Collection) is used

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

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

setParameterList

public <P> SqmQueryImplementor<R> setParameterList(String name,
                                                   P[] values,
                                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public SqmQueryImplementor<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 MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmQueryImplementor<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 BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(int, Collection, BindableType)

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public SqmQueryImplementor<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 MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmQueryImplementor<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 BindableType. If unable to infer an appropriate BindableType, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(int, Object[], BindableType)

setParameterList

public <P> SqmQueryImplementor<R> setParameterList(int position,
                                                   P[] values,
                                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmQueryImplementor<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 MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> SqmQueryImplementor<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 BindableType to use. If unable to infer an appropriate BindableType, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, BindableType)

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setParameterList

public <P> SqmQueryImplementor<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 MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

public <P> SqmQueryImplementor<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 BindableType to use. If unable to infer an appropriate BindableType, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

See Also:

CommonQueryContract.setParameterList(QueryParameter, Object[], BindableType)

setParameterList

public <P> SqmQueryImplementor<R> setParameterList(QueryParameter<P> parameter,
                                                   P[] values,
                                                   BindableType<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface MutationQuery

Specified by:

setParameterList in interface Query<R>

Specified by:

setParameterList in interface QueryImplementor<R>

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery

Specified by:

setParameterList in interface SqmQueryImplementor<R>

Overrides:

setParameterList in class AbstractSelectionQuery<R>

Returns:

this, for method chaining

setOptionalId

public void setOptionalId(Serializable id)

Specified by:

setOptionalId in interface QueryImplementor<R>

setOptionalEntityName

public void setOptionalEntityName(String entityName)

Specified by:

setOptionalEntityName in interface QueryImplementor<R>

setOptionalObject

public void setOptionalObject(Object optionalObject)

Specified by:

setOptionalObject in interface QueryImplementor<R>