Package org.hibernate.query.hql.spi

Interface SqmQueryImplementor<R>

All Superinterfaces:

CommonQueryContract, MutationQuery, NameableQuery, Query, Query<R>, QueryImplementor<R>, SelectionQuery<R>, SqmQuery, TypedQuery<R>

All Known Implementing Classes:

QuerySqmImpl

public interface SqmQueryImplementor<R>
extends QueryImplementor<R>, SqmQuery, NameableQuery

QueryImplementor specialization for SQM-based Query references

Method Summary

Modifier and Type	Method	Description
SqmQueryImplementor<R>	addQueryHint(String hint)	Add a database query hint to the SQL query.
default SqmQueryImplementor<R>	applyFetchGraph(RootGraph graph)	Apply the given graph using fetch semantics.
SqmQueryImplementor<R>	applyGraph(RootGraph graph, GraphSemantic semantic)	Apply the given graph using the given semantic
default SqmQueryImplementor<R>	applyLoadGraph(RootGraph graph)	Apply the given graph using load semantics.
ParameterMetadataImplementor	getParameterMetadata()	Access to information about query parameters.
SqmStatement<R>	getSqmStatement()
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>	setComment(String comment)	Set the 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)	Deprecated.
SqmQueryImplementor<R>	setHibernateFlushMode(FlushMode flushMode)	Deprecated.
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)	Set the LockMode to use for particular alias defined in the FROM clause of 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.
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 value to the 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> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine the BindableType to use.
<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
<T> SqmQueryImplementor<R>	setParameter(Parameter<T> param, T 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 value 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> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to determine the BindableType to use.
<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, Class<P> type)	Bind an argument to the query parameter represented by the given QueryParameter using the given Class reference to attempt to determine the BindableType to use.
<P> SqmQueryImplementor<R>	setParameter(QueryParameter<P> parameter, P val, BindableType<P> type)	Bind an argument to the query parameter represented by the given QueryParameter using the given BindableType.
<T> SqmQueryImplementor<R>	setParameter(QueryParameter<T> parameter, T value)	Bind an argument to the query parameter represented by the given QueryParameter.
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 determine the BindableType to use.
<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 determine the BindableType to use.
<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 determine the BindableType to use.
<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 determine 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, inferring the 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 determine 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, inferring 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 for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
SqmQueryImplementor<R>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
SqmQueryImplementor<R>	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Query.
SqmQueryImplementor<R>	setResultListTransformer(ResultListTransformer<R> transformer)	Set a ResultListTransformer.
default <T> SqmQueryImplementor<T>	setResultTransformer(ResultTransformer<T> transformer)	Deprecated.
SqmQueryImplementor<R>	setTimeout(int timeout)	Set the query timeout in seconds.
<T> SqmQueryImplementor<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.
NamedSqmQueryMemento<R>	toMemento(String name)	Convert the query into the memento

Methods inherited from interface org.hibernate.query.CommonQueryContract

getFlushMode, getHibernateFlushMode, getQueryFlushMode, getTimeout

Methods inherited from interface jakarta.persistence.Query

getCacheRetrieveMode, getCacheStoreMode, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getTimeout, isBound, unwrap

Methods inherited from interface org.hibernate.query.Query

disableFetchProfile, enableFetchProfile, executeUpdate, getComment, getLockOptions, getQueryOptions, getQueryString, getResultList, getResultStream, getSingleResult, list, setCacheRetrieveMode, setCacheStoreMode, setEntityGraph, setOrder, setOrder, setPage, stream, uniqueResult, uniqueResultOptional

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

getParameterBindings, getSession, scroll, scroll, setOptionalEntityName, setOptionalId, setOptionalObject

Methods inherited from interface org.hibernate.query.SelectionQuery

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getKeyedResultList, getLockMode, getMaxResults, getResultCount, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, setFollowOnLocking, setHibernateLockMode, setQueryPlanCacheable

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

getQueryOptions, getQueryString

Methods inherited from interface jakarta.persistence.TypedQuery

getSingleResultOrNull, setTimeout

Method Details

toMemento

NamedSqmQueryMemento<R> toMemento(String name)

Description copied from interface: NameableQuery

Convert the query into the memento

Specified by:

toMemento in interface NameableQuery

getParameterMetadata

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

Returns:

information about query parameters.

getSqmStatement

SqmStatement<R> getSqmStatement()

Specified by:

getSqmStatement in interface SqmQuery

setCacheMode

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

Specified by:

setCacheMode in interface SelectionQuery<R>

See Also:

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

setCacheable

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>

See Also:

• SelectionQuery.isCacheable()

setCacheRegion

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>

See Also:

• SelectionQuery.getCacheRegion()

setTimeout

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>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

• CommonQueryContract.getTimeout()

setFetchSize

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>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• SelectionQuery.getFetchSize()

setReadOnly

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>

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

applyGraph

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>

Parameters:

graph - The graph to apply.

semantic - The semantic to use when applying the graph

applyFetchGraph

default SqmQueryImplementor<R> applyFetchGraph(RootGraph graph)

Description copied from interface: Query

Apply the given graph using fetch semantics.

Specified by:

applyFetchGraph in interface Query<R>

applyLoadGraph

default SqmQueryImplementor<R> applyLoadGraph(RootGraph graph)

Description copied from interface: Query

Apply the given graph using load semantics.

Specified by:

applyLoadGraph in interface Query<R>

setComment

SqmQueryImplementor<R> setComment(String comment)

Description copied from interface: Query

Set the comment for this query.

If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.

SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".

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>

Parameters:

comment - The human-readable comment

Returns:

this, for method chaining

See Also:

• Query.getComment()

addQueryHint

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>

Parameters:

hint - The database specific query hint to add.

setLockOptions

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>

Parameters:

lockOptions - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

• Query.getLockOptions()

setLockMode

SqmQueryImplementor<R> setLockMode(String alias,
 LockMode lockMode)

Description copied from interface: Query

Set the LockMode to use for particular alias defined in the FROM clause of the query.

The alias-specific lock modes specified here are added to the LockOptions.

The effect of alias-specific locking is quite dependent on the driver and database. For maximum portability, the given lock mode should be LockMode.PESSIMISTIC_WRITE.

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Parameters:

alias - A query alias

lockMode - The lock mode to apply

Returns:

this, for method chaining

See Also:

• Query.getLockOptions()

setTupleTransformer

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

setResultListTransformer

SqmQueryImplementor<R> setResultListTransformer(ResultListTransformer<R> transformer)

Description copied from interface: Query

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface Query<R>

Specified by:

setResultListTransformer in interface QueryImplementor<R>

setResultTransformer

@Deprecated(since="5.2")
default <T> SqmQueryImplementor<T> setResultTransformer(ResultTransformer<T> transformer)

Deprecated.

Specified by:

setResultTransformer in interface Query<R>

Specified by:

setResultTransformer in interface QueryImplementor<R>

setHibernateFlushMode

@Deprecated(since="7")
SqmQueryImplementor<R> setHibernateFlushMode(FlushMode flushMode)

Deprecated.

Description copied from interface: CommonQueryContract

Set the current FlushMode in effect for this query.

Specified by:

setHibernateFlushMode in interface CommonQueryContract

Specified by:

setHibernateFlushMode in interface MutationQuery

Specified by:

setHibernateFlushMode in interface Query<R>

Specified by:

setHibernateFlushMode in interface SelectionQuery<R>

Specified by:

setHibernateFlushMode in interface SqmQuery

See Also:

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

setQueryFlushMode

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

Specified by:

setQueryFlushMode in interface Query<R>

Specified by:

setQueryFlushMode in interface SelectionQuery<R>

Specified by:

setQueryFlushMode in interface SqmQuery

See Also:

• Session.getHibernateFlushMode()

setMaxResults

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

setFirstResult

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

setHint

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

See Also:

• HibernateHints
• SpecHints

setFlushMode

@Deprecated(since="7")
SqmQueryImplementor<R> setFlushMode(FlushModeType flushMode)

Deprecated.

Description copied from interface: CommonQueryContract

Set the FlushMode to use for this query.

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

Specified by:

setFlushMode in interface CommonQueryContract

Specified by:

setFlushMode in interface 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 TypedQuery<R>

See Also:

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

setLockMode

SqmQueryImplementor<R> setLockMode(LockModeType lockMode)

Description copied from interface: SelectionQuery

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

See Also:

• SelectionQuery.setHibernateLockMode(org.hibernate.LockMode)

setParameter

SqmQueryImplementor<R> setParameter(String name,
 Object value)

Description copied from interface: Query

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 accept 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 TypedQuery<R>

See Also:

• Query.setParameter(String, Object, Class)
• Query.setParameter(String, Object, BindableType)

setParameter

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

Description copied from interface: Query

Bind the given argument 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, Query.setParameter(String, Object) is used.

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

See Also:

• Query.setParameter(String, Object, BindableType)

setParameter

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

Description copied from interface: Query

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

setParameter

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

Description copied from interface: Query

Bind an Instant value 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

setParameter

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

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

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

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

SqmQueryImplementor<R> setParameter(int position,
 Object value)

Description copied from interface: Query

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

See Also:

• Query.setParameter(int, Object, Class)
• Query.setParameter(int, Object, BindableType)

setParameter

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

Description copied from interface: Query

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, Query.setParameter(int, Object) is used.

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

See Also:

• Query.setParameter(int, Object, BindableType)

setParameter

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

Description copied from interface: Query

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

setParameter

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

Description copied from interface: Query

Bind an Instant value to the 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

setParameter

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

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

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

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

<T> SqmQueryImplementor<R> setParameter(QueryParameter<T> parameter,
 T value)

Description copied from interface: Query

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

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• Query.setParameter(QueryParameter, Object, BindableType)

setParameter

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

Description copied from interface: Query

Bind an argument to the query parameter represented by the given QueryParameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, Query.setParameter(QueryParameter, Object) is used

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

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

See Also:

• Query.setParameter(QueryParameter, Object, BindableType)

setParameter

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

Description copied from interface: Query

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

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - an BindableType representing the type of the parameter

Returns:

this, for method chaining

setParameter

<T> SqmQueryImplementor<R> setParameter(Parameter<T> param,
 T 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 TypedQuery<R>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

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

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

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

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

SqmQueryImplementor<R> setParameterList(String name,
 Collection values)

Description copied from interface: Query

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

Returns:

this, for method chaining

See Also:

• Query.setParameterList(java.lang.String, java.util.Collection, BindableType)

setParameterList

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

Description copied from interface: Query

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, Query.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

Returns:

this, for method chaining

See Also:

• Query.setParameterList(java.lang.String, java.util.Collection, BindableType)

setParameterList

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

Description copied from interface: Query

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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, Query.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

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: Query

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

Returns:

this, for method chaining

setParameterList

SqmQueryImplementor<R> setParameterList(int position,
 Collection values)

Description copied from interface: Query

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, Query.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

Returns:

this, for method chaining

See Also:

• Query.setParameterList(int, Collection, BindableType)

setParameterList

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

Description copied from interface: Query

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, Query.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

Returns:

this, for method chaining

See Also:

• Query.setParameterList(int, Object[], BindableType)

setParameterList

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

Description copied from interface: Query

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, Query.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

Returns:

this, for method chaining

See Also:

• Query.setParameterList(QueryParameter, java.util.Collection, BindableType)

setParameterList

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

Description copied from interface: Query

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

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

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

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: Query

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, Query.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

Returns:

this, for method chaining

See Also:

• Query.setParameterList(QueryParameter, Object[], BindableType)

setParameterList

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

Description copied from interface: Query

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

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

Returns:

this, for method chaining

setProperties

SqmQueryImplementor<R> setProperties(Object bean)

Description copied from interface: Query

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

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

SqmQueryImplementor<R> setProperties(Map bean)

Description copied from interface: Query

Bind the values of the given Map for each 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

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining