Package org.hibernate.query.spi

Interface SqmQuery<R>

All Superinterfaces:

CommonQueryContract

All Known Subinterfaces:

SqmQueryImplementor<R>, SqmSelectionQuery<R>, SqmSelectionQueryImplementor<R>

All Known Implementing Classes:

DelegatingSqmSelectionQueryImplementor, SqmQueryImpl, SqmSelectionQueryImpl

public interface SqmQuery<R>
extends CommonQueryContract

Query based on an SQM tree.

Method Summary

Modifier and Type	Method	Description
ParameterMetadata	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
QueryOptions	getQueryOptions()
String	getQueryString()
SqmStatement<R>	getSqmStatement()
SqmQuery<R>	setHibernateFlushMode(FlushMode flushMode)	Deprecated.
SqmQuery<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
SqmQuery<R>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
SqmQuery<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
SqmQuery<R>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> SqmQuery<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> SqmQuery<R>	setParameter(int position, P value, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
SqmQuery<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
SqmQuery<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<T> SqmQuery<R>	setParameter(Parameter<T> param, T value)
SqmQuery<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
SqmQuery<R>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
SqmQuery<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
SqmQuery<R>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> SqmQuery<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> SqmQuery<R>	setParameter(String name, P value, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> SqmQuery<R>	setParameter(QueryParameter<P> parameter, P val, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> SqmQuery<R>	setParameter(QueryParameter<P> parameter, P value, Class<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use.
<T> SqmQuery<R>	setParameter(QueryParameter<T> parameter, T value)	Bind an argument to the query parameter represented by the given QueryParameter.
SqmQuery<R>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
SqmQuery<R>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> SqmQuery<R>	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmQuery<R>	setParameterList(int position, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
<P> SqmQuery<R>	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmQuery<R>	setParameterList(int position, P[] values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
SqmQuery<R>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
SqmQuery<R>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> SqmQuery<R>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmQuery<R>	setParameterList(String name, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> SqmQuery<R>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmQuery<R>	setParameterList(String name, P[] values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use.
<P> SqmQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.
<P> SqmQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
<P> SqmQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.
<P> SqmQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
SqmQuery<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.
SqmQuery<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.
SqmQuery<R>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.

Methods inherited from interface org.hibernate.query.CommonQueryContract

getComment, getFlushMode, getHibernateFlushMode, getQueryFlushMode, getTimeout, setComment, setFlushMode, setHint, setTimeout, setTimeout

Method Details

getQueryString

String getQueryString()

getSqmStatement

SqmStatement<R> getSqmStatement()

getParameterMetadata

ParameterMetadata getParameterMetadata()

Description copied from interface: CommonQueryContract

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

Specified by:

getParameterMetadata in interface CommonQueryContract

getQueryOptions

QueryOptions getQueryOptions()

setParameter

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

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter.

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

Specified by:

setParameter in interface CommonQueryContract

See Also:

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

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

See Also:

• CommonQueryContract.setParameter(String, Object, Type)

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(String name,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(String name,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(String name,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

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

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter.

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

Specified by:

setParameter in interface CommonQueryContract

See Also:

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

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(int position,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(int position,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(int position,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

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

Description copied from interface: CommonQueryContract

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

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

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

<P> SqmQuery<R> setParameter(QueryParameter<P> parameter,
 P val,
 Type<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

<T> SqmQuery<R> setParameter(Parameter<T> param,
 T value)

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(Parameter<Calendar> param,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
SqmQuery<R> setParameter(Parameter<Date> param,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

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

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setProperties

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

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

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

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setHibernateFlushMode

@Deprecated(since="7")
SqmQuery<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

See Also:

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

setQueryFlushMode

SqmQuery<R> setQueryFlushMode(QueryFlushMode queryFlushMode)

Description copied from interface: CommonQueryContract

Set the QueryFlushMode to use for this query.

Specified by:

setQueryFlushMode in interface CommonQueryContract

See Also:

• Session.getHibernateFlushMode()