org.hibernate.ejb

Class QueryImpl<X>

java.lang.Object

org.hibernate.ejb.AbstractQueryImpl<X>

org.hibernate.ejb.QueryImpl<X>

All Implemented Interfaces:

Query, TypedQuery<X>, HibernateQuery

public class QueryImpl<X>
extends AbstractQueryImpl<X>
implements TypedQuery<X>, HibernateQuery

Hibernate implementation of both the Query and TypedQuery contracts.

Author:

Gavin King, Emmanuel Bernard, Steve Ebersole

Field Summary

Fields

Modifier and Type	Field and Description
static EntityManagerMessageLogger	LOG

Constructor Summary

Constructors

Constructor and Description
QueryImpl(Query query, AbstractEntityManagerImpl em)
QueryImpl(Query query, AbstractEntityManagerImpl em, Map<String,Class> namedParameterTypeRedefinitions)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyAliasSpecificLockMode(String alias, LockMode lockMode)
protected void	applyCacheable(boolean isCacheable)
protected void	applyCacheMode(CacheMode cacheMode)
protected void	applyCacheRegion(String regionName)
protected void	applyComment(String comment)
protected void	applyFetchSize(int fetchSize)
protected void	applyFirstResult(int firstResult) Apply the given first-result value.
protected void	applyFlushMode(FlushMode flushMode)
protected void	applyMaxResults(int maxResults) Apply the given max results value.
protected void	applyReadOnly(boolean isReadOnly)
protected void	applyTimeout(int timeout)
protected boolean	canApplyLockModes()
Query	getHibernateQuery()
LockModeType	getLockMode() Get the current lock mode for the query.
Parameter<?>	getParameter(int position) Get the parameter object corresponding to the declared positional parameter with the given position.
<T> Parameter<T>	getParameter(int position, Class<T> type) Get the parameter object corresponding to the declared positional parameter with the given position and type.
Parameter<?>	getParameter(String name) Get the parameter object corresponding to the declared parameter of the given name.
<T> Parameter<T>	getParameter(String name, Class<T> type) Get the parameter object corresponding to the declared parameter of the given name and type.
Set<Parameter<?>>	getParameters() Get the parameter objects corresponding to the declared parameters of the query.
List<X>	getResultList() Execute a SELECT query and return the query results as a typed List.
X	getSingleResult() Execute a SELECT query that returns a single result.
protected int	internalExecuteUpdate() Actually execute the update; all pre-requisites have been checked.
TypedQuery<X>	setLockMode(LockModeType lockModeType) Set the lock mode type to be used for the query execution.
TypedQuery<X>	setParameter(int position, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
TypedQuery<X>	setParameter(int position, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
TypedQuery<X>	setParameter(int position, Object value) Bind an argument to a positional parameter.
TypedQuery<X>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a Parameter object.
TypedQuery<X>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a Parameter object.
<T> TypedQuery<X>	setParameter(Parameter<T> param, T value) Bind the value of a Parameter object.
TypedQuery<X>	setParameter(String name, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
TypedQuery<X>	setParameter(String name, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
TypedQuery<X>	setParameter(String name, Object value) Bind an argument to a named parameter.
<T> T	unwrap(Class<T> tClass) Return an object of the specified type to allow access to the provider-specific API.

Methods inherited from class org.hibernate.ejb.AbstractQueryImpl

executeUpdate, getEntityManager, getFirstResult, getFlushMode, getHints, getMaxResults, getParameterValue, getParameterValue, getParameterValue, getSpecifiedFlushMode, getSpecifiedMaxResults, getSupportedHints, isBound, registerParameterBinding, setFirstResult, setFlushMode, setHint, setMaxResults

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

setFirstResult, setFlushMode, setHint, setMaxResults

Methods inherited from interface javax.persistence.Query

executeUpdate, getFirstResult, getFlushMode, getHints, getMaxResults, getParameterValue, getParameterValue, getParameterValue, isBound

Field Detail

LOG

public static final EntityManagerMessageLogger LOG

Constructor Detail

QueryImpl

public QueryImpl(Query query,
         AbstractEntityManagerImpl em)

QueryImpl

public QueryImpl(Query query,
         AbstractEntityManagerImpl em,
         Map<String,Class> namedParameterTypeRedefinitions)

Method Detail

getHibernateQuery

public Query getHibernateQuery()

Specified by:

getHibernateQuery in interface HibernateQuery

internalExecuteUpdate

protected int internalExecuteUpdate()

Description copied from class: AbstractQueryImpl

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

Specified by:

internalExecuteUpdate in class AbstractQueryImpl<X>

Returns:

The number of "affected rows".

applyMaxResults

protected void applyMaxResults(int maxResults)

Description copied from class: AbstractQueryImpl

Apply the given max results value.

Specified by:

applyMaxResults in class AbstractQueryImpl<X>

Parameters:

maxResults - The specified max results

applyFirstResult

protected void applyFirstResult(int firstResult)

Description copied from class: AbstractQueryImpl

Apply the given first-result value.

Specified by:

applyFirstResult in class AbstractQueryImpl<X>

Parameters:

firstResult - The specified first-result value.

applyTimeout

protected void applyTimeout(int timeout)

Specified by:

applyTimeout in class AbstractQueryImpl<X>

applyComment

protected void applyComment(String comment)

Specified by:

applyComment in class AbstractQueryImpl<X>

applyFetchSize

protected void applyFetchSize(int fetchSize)

Specified by:

applyFetchSize in class AbstractQueryImpl<X>

applyCacheable

protected void applyCacheable(boolean isCacheable)

Specified by:

applyCacheable in class AbstractQueryImpl<X>

applyCacheRegion

protected void applyCacheRegion(String regionName)

Specified by:

applyCacheRegion in class AbstractQueryImpl<X>

applyReadOnly

protected void applyReadOnly(boolean isReadOnly)

Specified by:

applyReadOnly in class AbstractQueryImpl<X>

applyCacheMode

protected void applyCacheMode(CacheMode cacheMode)

Specified by:

applyCacheMode in class AbstractQueryImpl<X>

applyFlushMode

protected void applyFlushMode(FlushMode flushMode)

Specified by:

applyFlushMode in class AbstractQueryImpl<X>

canApplyLockModes

protected boolean canApplyLockModes()

Specified by:

canApplyLockModes in class AbstractQueryImpl<X>

applyAliasSpecificLockMode

protected void applyAliasSpecificLockMode(String alias,
                              LockMode lockMode)

Specified by:

applyAliasSpecificLockMode in class AbstractQueryImpl<X>

getResultList

public List<X> getResultList()

Execute a SELECT query and return the query results as a typed List.

Specified by:

getResultList in interface Query

Specified by:

getResultList in interface TypedQuery<X>

Returns:

a list of the results

getSingleResult

public X getSingleResult()

Execute a SELECT query that returns a single result.

Specified by:

getSingleResult in interface Query

Specified by:

getSingleResult in interface TypedQuery<X>

Returns:

the result

setParameter

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

Description copied from interface: TypedQuery

Bind the value of a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

setParameter

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

Description copied from interface: TypedQuery

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

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Description copied from interface: TypedQuery

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

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Bind an argument to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

setParameter

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

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

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

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

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Bind an argument to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

position - position

value - parameter value

Returns:

the same query instance

setParameter

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

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

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

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

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<X>

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

getParameters

public Set<Parameter<?>> getParameters()

Get the parameter objects corresponding to the declared parameters of the query. Returns empty set if the query has no parameters. This method is not required to be supported for native queries.

Specified by:

getParameters in interface Query

Returns:

set of the parameter objects

getParameter

public Parameter<?> getParameter(String name)

Get the parameter object corresponding to the declared parameter of the given name. This method is not required to be supported for native queries.

Specified by:

getParameter in interface Query

Parameters:

name - parameter name

Returns:

parameter object

getParameter

public Parameter<?> getParameter(int position)

Get the parameter object corresponding to the declared positional parameter with the given position. This method is not required to be supported for native queries.

Specified by:

getParameter in interface Query

Parameters:

position - position

Returns:

parameter object

getParameter

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

Get the parameter object corresponding to the declared parameter of the given name and type. This method is required to be supported for criteria queries only.

Specified by:

getParameter in interface Query

Parameters:

name - parameter name

type - type

Returns:

parameter object

getParameter

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

Get the parameter object corresponding to the declared positional parameter with the given position and type. This method is not required to be supported by the provider.

Specified by:

getParameter in interface Query

Parameters:

position - position

type - type

Returns:

parameter object

unwrap

public <T> T unwrap(Class<T> tClass)

Return an object of the specified type to allow access to the provider-specific API. If the provider's query implementation does not support the specified class, the PersistenceException is thrown.

Specified by:

unwrap in interface Query

Parameters:

tClass - the class of the object to be returned. This is normally either the underlying query implementation class or an interface that it implements.

Returns:

an instance of the specified class

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>

Specified by:

setLockMode in class AbstractQueryImpl<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

Specified by:

getLockMode in class AbstractQueryImpl<X>

Returns:

lock mode