Interface SqmQuery
- All Superinterfaces:
CommonQueryContract
- All Known Subinterfaces:
SqmQueryImplementor<R>
,SqmSelectionQuery<R>
,SqmSelectionQueryImplementor<R>
- All Known Implementing Classes:
DelegatingSqmSelectionQueryImplementor
,QuerySqmImpl
,SqmSelectionQueryImpl
-
Method Summary
Modifier and TypeMethodDescriptionGet theParameterMetadata
object representing the parameters of this query, and providing access to theQueryParameter
s.setHibernateFlushMode
(FlushMode flushMode) Deprecated.setParameter
(int position, Object value) Bind the given argument to an ordinal query parameter.setParameter
(int position, Instant value, TemporalType temporalType) Deprecated.setParameter
(int position, Calendar value, TemporalType temporalType) Deprecated.setParameter
(int position, Date value, TemporalType temporalType) Deprecated.<P> SqmQuery
setParameter
(int position, P value, Type<P> type) Bind the given argument to an ordinal query parameter using the givenType
.<P> SqmQuery
setParameter
(int position, P value, Class<P> type) setParameter
(Parameter<Calendar> param, Calendar value, TemporalType temporalType) Deprecated.setParameter
(Parameter<Date> param, Date value, TemporalType temporalType) Deprecated.<T> SqmQuery
setParameter
(Parameter<T> param, T value) setParameter
(String name, Object value) Bind the given argument to a named query parameter.setParameter
(String name, Instant value, TemporalType temporalType) Deprecated.setParameter
(String name, Calendar value, TemporalType temporalType) Deprecated.setParameter
(String name, Date value, TemporalType temporalType) Deprecated.<P> SqmQuery
setParameter
(String name, P value, Type<P> type) Bind the given argument to a named query parameter using the givenType
.<P> SqmQuery
setParameter
(String name, P value, Class<P> type) <P> SqmQuery
setParameter
(QueryParameter<P> parameter, P val, Type<P> type) Bind an argument to the query parameter represented by the givenQueryParameter
, using the givenType
.<P> SqmQuery
setParameter
(QueryParameter<P> parameter, P value, Class<P> type) Bind an argument to the query parameter represented by the givenQueryParameter
, using the givenClass
reference to attempt to infer theType
to use.<T> SqmQuery
setParameter
(QueryParameter<T> parameter, T value) Bind an argument to the query parameter represented by the givenQueryParameter
.setParameterList
(int position, Object[] values) Bind multiple arguments to an ordinal query parameter.setParameterList
(int position, Collection values) Bind multiple arguments to an ordinal query parameter.<P> SqmQuery
setParameterList
(int position, Collection<? extends P> values, Type<P> type) Bind multiple arguments to an ordinal query parameter using the givenType
.<P> SqmQuery
setParameterList
(int position, Collection<? extends P> values, Class<P> javaType) <P> SqmQuery
setParameterList
(int position, P[] values, Type<P> type) Bind multiple arguments to an ordinal query parameter using the givenType
.<P> SqmQuery
setParameterList
(int position, P[] values, Class<P> javaType) setParameterList
(String name, Object[] values) Bind multiple arguments to a named query parameter.setParameterList
(String name, Collection values) Bind multiple arguments to a named query parameter.<P> SqmQuery
setParameterList
(String name, Collection<? extends P> values, Type<P> type) Bind multiple arguments to a named query parameter using the givenType
.<P> SqmQuery
setParameterList
(String name, Collection<? extends P> values, Class<P> javaType) Bind multiple arguments to a named query parameter using the givenClass
reference to attempt to infer theType
If unable to infer an appropriateType
, fall back toCommonQueryContract.setParameterList(String, Collection)
.<P> SqmQuery
setParameterList
(String name, P[] values, Type<P> type) Bind multiple arguments to a named query parameter using the givenType
.<P> SqmQuery
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 theType
to use.<P> SqmQuery
setParameterList
(QueryParameter<P> parameter, Collection<? extends P> values) Bind multiple arguments to the query parameter represented by the givenQueryParameter
.<P> SqmQuery
setParameterList
(QueryParameter<P> parameter, Collection<? extends P> values, Type<P> type) Bind multiple arguments to the query parameter represented by the givenQueryParameter
, using the givenType
.<P> SqmQuery
setParameterList
(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType) Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the givenClass
reference to attempt to infer theType
to use.<P> SqmQuery
setParameterList
(QueryParameter<P> parameter, P[] values) Bind multiple arguments to the query parameter represented by the givenQueryParameter
.<P> SqmQuery
setParameterList
(QueryParameter<P> parameter, P[] values, Type<P> type) Bind multiple arguments to the query parameter represented by the givenQueryParameter
, using the given theType
.<P> SqmQuery
setParameterList
(QueryParameter<P> parameter, P[] values, Class<P> javaType) Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the givenClass
reference to attempt to infer theType
to use.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.setProperties
(Map bean) Bind the values of the givenMap
to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.setQueryFlushMode
(QueryFlushMode queryFlushMode) Set theQueryFlushMode
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 getSqmStatement() -
getParameterMetadata
ParameterMetadata getParameterMetadata()Description copied from interface:CommonQueryContract
Get theParameterMetadata
object representing the parameters of this query, and providing access to theQueryParameter
s.- Specified by:
getParameterMetadata
in interfaceCommonQueryContract
-
getQueryOptions
QueryOptions getQueryOptions() -
setParameter
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 interfaceCommonQueryContract
- See Also:
-
setParameter
Description copied from interface:CommonQueryContract
Bind the given argument to a named query parameter using the givenClass
reference to attempt to infer theType
. If unable to infer an appropriateType
, fall back toCommonQueryContract.setParameter(String, Object)
.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
Description copied from interface:CommonQueryContract
Bind the given argument to a named query parameter using the givenType
.- Specified by:
setParameter
in interfaceCommonQueryContract
-
setParameter
Deprecated.Description copied from interface:CommonQueryContract
Bind anInstant
to the named query parameter using just the portion indicated by the givenTemporalType
.- Specified by:
setParameter
in interfaceCommonQueryContract
-
setParameter
@Deprecated(since="7") SqmQuery setParameter(String name, Calendar value, TemporalType temporalType) Deprecated.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
Deprecated.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
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 interfaceCommonQueryContract
- See Also:
-
setParameter
Description copied from interface:CommonQueryContract
Bind the given argument to an ordinal query parameter using the givenClass
reference to attempt to infer theType
. If unable to infer an appropriateType
, fall back toCommonQueryContract.setParameter(int, Object)
.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
Description copied from interface:CommonQueryContract
Bind the given argument to an ordinal query parameter using the givenType
.- Specified by:
setParameter
in interfaceCommonQueryContract
-
setParameter
@Deprecated(since="7") SqmQuery setParameter(int position, Instant value, TemporalType temporalType) Deprecated.Description copied from interface:CommonQueryContract
Bind anInstant
to an ordinal query parameter using just the portion indicated by the givenTemporalType
.- Specified by:
setParameter
in interfaceCommonQueryContract
-
setParameter
Deprecated.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
@Deprecated(since="7") SqmQuery setParameter(int position, Calendar value, TemporalType temporalType) Deprecated.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
Description copied from interface:CommonQueryContract
Bind an argument to the query parameter represented by the givenQueryParameter
.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 interfaceCommonQueryContract
- Parameters:
parameter
- the query parameter mementovalue
- the argument, which might be null- Returns:
this
, for method chaining- See Also:
-
setParameter
Description copied from interface:CommonQueryContract
Bind an argument to the query parameter represented by the givenQueryParameter
, using the givenClass
reference to attempt to infer theType
to use. If unable to infer an appropriateType
, fall back toCommonQueryContract.setParameter(QueryParameter, Object)
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Parameters:
parameter
- the query parameter mementovalue
- the argument, which might be nulltype
- aType
representing the type of the parameter- Returns:
this
, for method chaining- See Also:
-
setParameter
Description copied from interface:CommonQueryContract
Bind an argument to the query parameter represented by the givenQueryParameter
, using the givenType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Parameters:
parameter
- the query parameter mementoval
- the argument, which might be nulltype
- aType
representing the type of the parameter- Returns:
this
, for method chaining
-
setParameter
- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
@Deprecated(since="7") SqmQuery setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType) Deprecated.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameter
@Deprecated(since="7") SqmQuery setParameter(Parameter<Date> param, Date value, TemporalType temporalType) Deprecated.- Specified by:
setParameter
in interfaceCommonQueryContract
- See Also:
-
setParameterList
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 interfaceCommonQueryContract
- Returns:
this
, for method chaining- See Also:
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to a named query parameter using the givenClass
reference to attempt to infer theType
If unable to infer an appropriateType
, fall back toCommonQueryContract.setParameterList(String, Collection)
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining- See Also:
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to a named query parameter using the givenType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
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 interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theType
to use. If unable to determine an appropriateType
,CommonQueryContract.setParameterList(String, Collection)
is used- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining- See Also:
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to a named query parameter using the givenType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
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 interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to an ordinal query parameter using the givenClass
reference to attempt to infer theType
. If unable to infer an appropriateType
, fall back toCommonQueryContract.setParameterList(String, Collection)
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining- See Also:
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to an ordinal query parameter using the givenType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
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 interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to an ordinal query parameter using the givenClass
reference to attempt to infer theType
. If unable to infer an appropriateType
, fall back toCommonQueryContract.setParameterList(String, Collection)
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining- See Also:
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to an ordinal query parameter using the givenType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to the query parameter represented by the givenQueryParameter
.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 interfaceCommonQueryContract
- Parameters:
parameter
- the parameter mementovalues
- a collection of arguments- Returns:
this
, for method chaining
-
setParameterList
<P> SqmQuery 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 givenQueryParameter
using the givenClass
reference to attempt to infer theType
to use. If unable to infer an appropriateType
, fall back to usingCommonQueryContract.setParameterList(String, Collection)
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining- See Also:
-
setParameterList
<P> SqmQuery 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 givenQueryParameter
, using the givenType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to the query parameter represented by the givenQueryParameter
.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 interfaceCommonQueryContract
- Parameters:
parameter
- the parameter mementovalues
- a collection of arguments- Returns:
this
, for method chaining
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the givenClass
reference to attempt to infer theType
to use. If unable to infer an appropriateType
, fall back to usingCommonQueryContract.setParameterList(String, Collection)
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining- See Also:
-
setParameterList
Description copied from interface:CommonQueryContract
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, using the given theType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Returns:
this
, for method chaining
-
setProperties
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 interfaceCommonQueryContract
- Parameters:
bean
- any JavaBean or POJO- Returns:
this
, for method chaining
-
setProperties
Description copied from interface:CommonQueryContract
Bind the values of the givenMap
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 interfaceCommonQueryContract
- Parameters:
bean
- aMap
of names to arguments- Returns:
this
, for method chaining
-
setHibernateFlushMode
Deprecated.Description copied from interface:CommonQueryContract
Set the currentFlushMode
in effect for this query.- Specified by:
setHibernateFlushMode
in interfaceCommonQueryContract
- See Also:
-
setQueryFlushMode
Description copied from interface:CommonQueryContract
Set theQueryFlushMode
to use for this query.- Specified by:
setQueryFlushMode
in interfaceCommonQueryContract
- See Also:
-