Package org.hibernate.query.spi

Class AbstractCommonQueryContract

java.lang.Object

org.hibernate.query.spi.AbstractCommonQueryContract

All Implemented Interfaces:

CommonQueryContract

Direct Known Subclasses:

AbstractSelectionQuery

@Internal
public abstract class AbstractCommonQueryContract
extends Object
implements CommonQueryContract

Base implementation of CommonQueryContract.

API Note:

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractCommonQueryContract(SharedSessionContractImplementor session)
protected	AbstractCommonQueryContract(AbstractCommonQueryContract original)

Method Summary

Modifier and Type	Method	Description
protected void	applyCommentHint(String comment)
protected void	applyDatabaseHint(String hint)
protected void	applyEntityGraphHint(GraphSemantic graphSemantic, Object value, String hintName)
protected void	applyFlushModeHint(FlushMode flushMode)
protected void	applyFollowOnLockingHint(Boolean followOnLocking)
protected void	applyFollowOnStrategyHint(Locking.FollowOn followOnStrategy)
protected void	applyGraph(String graphString, GraphSemantic graphSemantic)
protected void	applyGraph(RootGraphImplementor<?> entityGraph, GraphSemantic graphSemantic)
protected void	applyHibernateLockMode(LockMode value)
final boolean	applyHint(String hintName, Object value)
protected final void	applyLockModeHint(Object value)
protected void	applyLockModeType(LockModeType value)
protected void	applyLockTimeoutHint(int timeout)
protected void	applyLockTimeoutHint(Integer timeout)
protected final boolean	applySelectionHint(String hintName, Object value)
protected void	applySynchronizeSpacesHint(Object value)
protected void	applyTimeoutHint(int timeout)
protected void	collectHints(Map<String,Object> hints)
protected <T> Type<T>	determineType(String namedParam, Class<? extends T> retType)
String	getComment()	Get the comment that has been set for this query, if any.
protected final ExceptionConverter	getExceptionConverter()
int	getFirstResult()
FlushMode	getHibernateFlushMode()	The FlushMode in effect for this query.
Map<String,Object>	getHints()
protected int	getIntegerLiteral(JpaExpression<Number> expression, int defaultValue)
int	getMaxResults()
protected int	getMaxRows(SqmSelectStatement<?> selectStatement, int size)
QueryParameterImplementor<?>	getParameter(int position)
<T> QueryParameterImplementor<T>	getParameter(int position, Class<T> type)
QueryParameterImplementor<?>	getParameter(String name)
<T> QueryParameterImplementor<T>	getParameter(String name, Class<T> type)
abstract ParameterMetadataImplementor	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
Set<Parameter<?>>	getParameters()
Object	getParameterValue(int position)
<T> T	getParameterValue(Parameter<T> param)
Object	getParameterValue(String name)
QueryFlushMode	getQueryFlushMode()	The QueryFlushMode in effect for this query.
MutableQueryOptions	getQueryOptions()
abstract QueryParameterBindings	getQueryParameterBindings()
final SharedSessionContractImplementor	getSession()
final SessionFactoryImplementor	getSessionFactory()
Integer	getTimeout()	Obtain the query timeout in seconds.
final TypeConfiguration	getTypeConfiguration()
boolean	isBound(Parameter<?> param)
protected <P> QueryParameterBinding<P>	locateBinding(int position)
protected <P> QueryParameterBinding<P>	locateBinding(Parameter<P> parameter)
protected <P> QueryParameterBinding<P>	locateBinding(String name)
protected <P> QueryParameterBinding<P>	locateBinding(QueryParameterImplementor<P> parameter)
protected void	putIfNotNull(Map<String,Object> hints, String hintName, Enum<?> hintValue)
protected void	putIfNotNull(Map<String,Object> hints, String hintName, Object hintValue)
protected abstract boolean	resolveJdbcParameterTypeIfNecessary()
CommonQueryContract	setComment(String comment)	Set a comment for this query.
CommonQueryContract	setHibernateFlushMode(FlushMode flushMode)	Set the current FlushMode in effect for this query.
CommonQueryContract	setHint(String hintName, Object value)	Set a hint.
CommonQueryContract	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
CommonQueryContract	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
CommonQueryContract	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
CommonQueryContract	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> CommonQueryContract	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> CommonQueryContract	setParameter(int position, P value, Class<P> javaType)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
CommonQueryContract	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
CommonQueryContract	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> CommonQueryContract	setParameter(Parameter<P> parameter, P value)
CommonQueryContract	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
CommonQueryContract	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
CommonQueryContract	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
CommonQueryContract	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> CommonQueryContract	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> CommonQueryContract	setParameter(String name, P value, Class<P> javaType)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> CommonQueryContract	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> CommonQueryContract	setParameter(QueryParameter<P> parameter, P value, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> CommonQueryContract	setParameter(QueryParameter<P> parameter, P value, Class<P> javaType)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use.
CommonQueryContract	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
CommonQueryContract	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> CommonQueryContract	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> CommonQueryContract	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> CommonQueryContract	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> CommonQueryContract	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.
CommonQueryContract	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
CommonQueryContract	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> CommonQueryContract	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> CommonQueryContract	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> CommonQueryContract	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> CommonQueryContract	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> CommonQueryContract	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> CommonQueryContract	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> CommonQueryContract	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> CommonQueryContract	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> CommonQueryContract	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> CommonQueryContract	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.
CommonQueryContract	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.
CommonQueryContract	setProperties(Map map)	Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
CommonQueryContract	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
CommonQueryContract	setTimeout(int timeout)	Set the query timeout in seconds.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.query.CommonQueryContract

getFlushMode, setFlushMode, setTimeout

Constructor Details

AbstractCommonQueryContract

public AbstractCommonQueryContract(SharedSessionContractImplementor session)

AbstractCommonQueryContract

protected AbstractCommonQueryContract(AbstractCommonQueryContract original)

Method Details

getSession

public final SharedSessionContractImplementor getSession()

getSessionFactory

public final SessionFactoryImplementor getSessionFactory()

getTypeConfiguration

public final TypeConfiguration getTypeConfiguration()

getExceptionConverter

protected final ExceptionConverter getExceptionConverter()

getIntegerLiteral

protected int getIntegerLiteral(JpaExpression<Number> expression,
 int defaultValue)

getMaxRows

protected int getMaxRows(SqmSelectStatement<?> selectStatement,
 int size)

getHints

public Map<String,Object> getHints()

collectHints

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

putIfNotNull

protected void putIfNotNull(Map<String,Object> hints,
 String hintName,
 Enum<?> hintValue)

putIfNotNull

protected void putIfNotNull(Map<String,Object> hints,
 String hintName,
 Object hintValue)

setHint

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

See Also:

• HibernateHints
• SpecHints

applyHint

public final boolean applyHint(String hintName,
 Object value)

applySynchronizeSpacesHint

protected void applySynchronizeSpacesHint(Object value)

applySelectionHint

protected final boolean applySelectionHint(String hintName,
 Object value)

applyEntityGraphHint

protected void applyEntityGraphHint(GraphSemantic graphSemantic,
 Object value,
 String hintName)

applyGraph

protected void applyGraph(String graphString,
 GraphSemantic graphSemantic)

applyGraph

protected void applyGraph(RootGraphImplementor<?> entityGraph,
 GraphSemantic graphSemantic)

applyLockTimeoutHint

protected void applyLockTimeoutHint(Integer timeout)

applyLockTimeoutHint

protected void applyLockTimeoutHint(int timeout)

applyHibernateLockMode

protected void applyHibernateLockMode(LockMode value)

applyLockModeType

protected void applyLockModeType(LockModeType value)

applyLockModeHint

protected final void applyLockModeHint(Object value)

applyFollowOnStrategyHint

protected void applyFollowOnStrategyHint(Locking.FollowOn followOnStrategy)

applyFollowOnLockingHint

protected void applyFollowOnLockingHint(Boolean followOnLocking)

getComment

public String getComment()

Description copied from interface: CommonQueryContract

Get the comment that has been set for this query, if any.

Specified by:

getComment in interface CommonQueryContract

setComment

public CommonQueryContract setComment(String comment)

Description copied from interface: CommonQueryContract

Set a comment for this query.

Specified by:

setComment in interface CommonQueryContract

See Also:

• Query.setComment(String)

getHibernateFlushMode

public FlushMode getHibernateFlushMode()

Description copied from interface: CommonQueryContract

The FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.

Specified by:

getHibernateFlushMode in interface CommonQueryContract

See Also:

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

setHibernateFlushMode

public CommonQueryContract setHibernateFlushMode(FlushMode flushMode)

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

getQueryFlushMode

public QueryFlushMode getQueryFlushMode()

Description copied from interface: CommonQueryContract

The QueryFlushMode in effect for this query.

By default, this is QueryFlushMode.DEFAULT, and the FlushMode of the owning Session determines whether it is flushed.

Specified by:

getQueryFlushMode in interface CommonQueryContract

See Also:

• Session.getHibernateFlushMode()

setQueryFlushMode

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

applyTimeoutHint

protected void applyTimeoutHint(int timeout)

applyCommentHint

protected void applyCommentHint(String comment)

applyFlushModeHint

protected void applyFlushModeHint(FlushMode flushMode)

applyDatabaseHint

protected void applyDatabaseHint(String hint)

getQueryOptions

public MutableQueryOptions getQueryOptions()

getTimeout

public Integer getTimeout()

Description copied from interface: CommonQueryContract

Obtain the query timeout in seconds.

This value is eventually passed along to the JDBC statement via Statement.setQueryTimeout(int).

A value of zero indicates no timeout.

Specified by:

getTimeout in interface CommonQueryContract

See Also:

• Statement.getQueryTimeout()
• Statement.setQueryTimeout(int)

setTimeout

public CommonQueryContract setTimeout(int timeout)

Description copied from interface: CommonQueryContract

Set the query timeout in seconds.

Any value set here is eventually passed directly along to the JDBC statement, which expressly disallows negative values. So negative values should be avoided as a general rule, although certain "magic values" are handled - see Timeouts.NO_WAIT.

A value of zero indicates no timeout.

Specified by:

setTimeout in interface CommonQueryContract

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

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

getMaxResults

public int getMaxResults()

getFirstResult

public int getFirstResult()

getParameterMetadata

public abstract ParameterMetadataImplementor 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

getParameters

public Set<Parameter<?>> getParameters()

getParameter

public QueryParameterImplementor<?> getParameter(String name)

getParameter

public <T> QueryParameterImplementor<T> getParameter(String name,
 Class<T> type)

getParameter

public QueryParameterImplementor<?> getParameter(int position)

getParameter

public <T> QueryParameterImplementor<T> getParameter(int position,
 Class<T> type)

getQueryParameterBindings

@Internal
public abstract QueryParameterBindings getQueryParameterBindings()

resolveJdbcParameterTypeIfNecessary

protected abstract boolean resolveJdbcParameterTypeIfNecessary()

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(Parameter<P> parameter)

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(QueryParameterImplementor<P> parameter)

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(String name)

locateBinding

protected <P> QueryParameterBinding<P> locateBinding(int position)

isBound

public boolean isBound(Parameter<?> param)

getParameterValue

public <T> T getParameterValue(Parameter<T> param)

getParameterValue

public Object getParameterValue(String name)

getParameterValue

public Object getParameterValue(int position)

setParameter

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

public <P> CommonQueryContract setParameter(String name,
 P value,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

See Also:

• CommonQueryContract.setParameter(String, Object, Type)

setParameter

public <P> CommonQueryContract 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")
public CommonQueryContract 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

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

public <P> CommonQueryContract setParameter(int position,
 P value,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

public <P> CommonQueryContract 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")
public CommonQueryContract 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

public <P> CommonQueryContract setParameter(QueryParameter<P> parameter,
 P value)

Description copied from interface: CommonQueryContract

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

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

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> CommonQueryContract setParameter(QueryParameter<P> parameter,
 P value,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

javaType - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> CommonQueryContract setParameter(QueryParameter<P> parameter,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

public <P> CommonQueryContract setParameter(Parameter<P> parameter,
 P value)

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(Parameter, Object)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

@Deprecated
public CommonQueryContract setParameter(String name,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated
public CommonQueryContract setParameter(String name,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Deprecated
public CommonQueryContract setParameter(int position,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

@Deprecated
public CommonQueryContract setParameter(int position,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameterList

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public CommonQueryContract setProperties(Map map)

Description copied from interface: CommonQueryContract

Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.

Specified by:

setProperties in interface CommonQueryContract

Parameters:

map - a Map of names to arguments

Returns:

this, for method chaining

determineType

protected <T> Type<T> determineType(String namedParam,
 Class<? extends T> retType)

setProperties

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