org.hibernate.jpa.spi

Class AbstractQueryImpl<X>

java.lang.Object

org.hibernate.jpa.spi.BaseQueryImpl

org.hibernate.jpa.spi.AbstractQueryImpl<X>

All Implemented Interfaces:

Query, TypedQuery<X>

Direct Known Subclasses:

AbstractQueryImpl, QueryImpl

public abstract class AbstractQueryImpl<X>
extends BaseQueryImpl
implements TypedQuery<X>

Base class for implementing both Query and TypedQuery, including query references built from criteria queries.

Not intended as base for StoredProcedureQuery

Author:

Steve Ebersole

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.jpa.spi.BaseQueryImpl

BaseQueryImpl.ParameterBindImpl<T>

Constructor Summary

Constructors

Constructor and Description
AbstractQueryImpl(HibernateEntityManagerImplementor entityManager)

Method Summary

Modifier and Type	Method and Description
protected void	checkTransaction()
int	executeUpdate() Execute an update or delete statement.
protected HibernateEntityManagerImplementor	getEntityManager()
LockModeType	getLockMode() Get the current lock mode for the query.
Set<String>	getSupportedHints()
protected abstract int	internalExecuteUpdate() Actually execute the update; all pre-requisites have been checked.
AbstractQueryImpl<X>	setFirstResult(int firstResult) Set the position of the first result to retrieve.
AbstractQueryImpl<X>	setFlushMode(FlushModeType jpaFlushMode) Set the flush mode type to be used for the query execution.
AbstractQueryImpl<X>	setHint(String hintName, Object value) Set a query property or hint.
TypedQuery<X>	setLockMode(LockModeType lockModeType) Set the lock mode type to be used for the query execution.
AbstractQueryImpl<X>	setMaxResults(int maxResults) Set the maximum number of results to retrieve.
AbstractQueryImpl<X>	setParameter(int position, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
AbstractQueryImpl<X>	setParameter(int position, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
AbstractQueryImpl<X>	setParameter(int position, Object value) Bind an argument to a positional parameter.
AbstractQueryImpl<X>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a Parameter object.
AbstractQueryImpl<X>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a Parameter object.
<T> AbstractQueryImpl<X>	setParameter(Parameter<T> param, T value) Bind the value of a Parameter object.
AbstractQueryImpl<X>	setParameter(String name, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
AbstractQueryImpl<X>	setParameter(String name, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
AbstractQueryImpl<X>	setParameter(String name, Object value) Bind an argument to a named parameter.

Methods inherited from class org.hibernate.jpa.spi.BaseQueryImpl

applyAliasSpecificLockModeHint, applyCacheableHint, applyCacheModeHint, applyCacheRegionHint, applyCommentHint, applyFetchSizeHint, applyFirstResult, applyFlushModeHint, applyLockTimeoutHint, applyMaxResults, applyReadOnlyHint, applyTimeoutHint, canApplyAliasSpecificLockModeHints, checkOpen, entityManager, findParameterRegistration, findParameterRegistration, findParameterRegistration, getEntityGraphQueryHint, getFirstResult, getFlushMode, getHints, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getSpecifiedFlushMode, getSpecifiedMaxResults, internalApplyLockMode, isBound, isNativeSqlQuery, isSelectQuery, registerParameter, validateBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.persistence.TypedQuery

getResultList, getSingleResult

Methods inherited from interface javax.persistence.Query

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

Constructor Detail

AbstractQueryImpl

public AbstractQueryImpl(HibernateEntityManagerImplementor entityManager)

Method Detail

getEntityManager

protected HibernateEntityManagerImplementor getEntityManager()

internalExecuteUpdate

protected abstract int internalExecuteUpdate()

Actually execute the update; all pre-requisites have been checked.

Returns:

The number of "affected rows".

executeUpdate

public int executeUpdate()

Description copied from interface: Query

Execute an update or delete statement.

Specified by:

executeUpdate in interface Query

Returns:

the number of entities updated or deleted

setMaxResults

public AbstractQueryImpl<X> setMaxResults(int maxResults)

Description copied from interface: Query

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface TypedQuery<X>

Overrides:

setMaxResults in class BaseQueryImpl

Parameters:

maxResults - maximum number of results to retrieve

Returns:

the same query instance

setFirstResult

public AbstractQueryImpl<X> setFirstResult(int firstResult)

Description copied from interface: Query

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface TypedQuery<X>

Overrides:

setFirstResult in class BaseQueryImpl

Parameters:

firstResult - position of the first result, numbered from 0

Returns:

the same query instance

setHint

public AbstractQueryImpl<X> setHint(String hintName,
                                    Object value)

Description copied from interface: Query

Set a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, this hint may or may not be observed.

Specified by:

setHint in interface Query

Specified by:

setHint in interface TypedQuery<X>

Overrides:

setHint in class BaseQueryImpl

Parameters:

hintName - name of the property or hint

value - value for the property or hint

Returns:

the same query instance

getSupportedHints

public Set<String> getSupportedHints()

Overrides:

getSupportedHints in class BaseQueryImpl

setLockMode

public TypedQuery<X> setLockMode(LockModeType lockModeType)

Description copied from interface: TypedQuery

Set the lock mode type to be used for the query execution.

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface TypedQuery<X>

Parameters:

lockModeType - lock mode

Returns:

the same query instance

getLockMode

public LockModeType getLockMode()

Description copied from interface: Query

Get the current lock mode for the query.

Specified by:

getLockMode in interface Query

Returns:

lock mode

setParameter

public <T> AbstractQueryImpl<X> setParameter(Parameter<T> param,
                                             T value)

Description copied from interface: Query

Bind the value of a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(Parameter<Calendar> param,
                                         Calendar value,
                                         TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Calendar to a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(Parameter<Date> param,
                                         Date value,
                                         TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Date to a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(String name,
                                         Object value)

Description copied from interface: Query

Bind an argument to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(String name,
                                         Calendar value,
                                         TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Calendar to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(String name,
                                         Date value,
                                         TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Date to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(int position,
                                         Object value)

Description copied from interface: Query

Bind an argument to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

position - position

value - parameter value

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(int position,
                                         Calendar value,
                                         TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Calendar to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public AbstractQueryImpl<X> setParameter(int position,
                                         Date value,
                                         TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Date to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Overrides:

setParameter in class BaseQueryImpl

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setFlushMode

public AbstractQueryImpl<X> setFlushMode(FlushModeType jpaFlushMode)

Description copied from interface: Query

Set the flush mode type to be used for the query execution. The flush mode type applies to the query regardless of the flush mode type in use for the entity manager.

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface TypedQuery<X>

Overrides:

setFlushMode in class BaseQueryImpl

Parameters:

jpaFlushMode - flush mode

Returns:

the same query instance

checkTransaction

protected void checkTransaction()