org.hibernate.jpa.internal

Class QueryImpl<X>

java.lang.Object

org.hibernate.jpa.spi.BaseQueryImpl

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

org.hibernate.jpa.internal.QueryImpl<X>

All Implemented Interfaces:

Query, TypedQuery<X>, HibernateQuery

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

Hibernate implementation of both the Query and TypedQuery contracts.

Author:

Gavin King, Emmanuel Bernard, Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryImpl.JpaPositionalParameterRegistrationImpl<T> Specialized handling for JPA "positional parameters".

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

BaseQueryImpl.ParameterBindImpl<T>

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

Modifier and Type	Method and Description
protected void	applyAliasSpecificLockModeHint(String alias, LockMode lockMode) Apply the alias specific lock modes.
protected boolean	applyCacheableHint(boolean isCacheable) Apply the cacheable (true/false) hint.
protected boolean	applyCacheModeHint(CacheMode cacheMode) Apply the CacheMode hint.
protected boolean	applyCacheRegionHint(String regionName) Apply the cache region hint
protected boolean	applyCommentHint(String comment) Apply the comment hint.
protected boolean	applyFetchSizeHint(int fetchSize) Apply the fetch size hint
protected void	applyFirstResult(int firstResult) Apply the given first-result value.
protected boolean	applyFlushModeHint(FlushMode flushMode) Apply the FlushMode hint.
protected boolean	applyLockTimeoutHint(int timeout) Apply the lock timeout (in seconds!) hint
protected void	applyMaxResults(int maxResults) Apply the given max results value.
protected boolean	applyReadOnlyHint(boolean isReadOnly) Apply the read-only (true/false) hint.
protected boolean	applyTimeoutHint(int timeout) Apply the query timeout hint.
protected boolean	canApplyAliasSpecificLockModeHints() Can alias-specific lock modes be applied?
Query	getHibernateQuery() Gives access to the underlying Hibernate query object..
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 void	internalApplyLockMode(LockModeType lockModeType)
protected int	internalExecuteUpdate() Actually execute the update; all pre-requisites have been checked.
protected boolean	isNativeSqlQuery() Is the query represented here a native SQL query?
protected boolean	isSelectQuery() Is the query represented here a SELECT query?
<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.jpa.spi.AbstractQueryImpl

checkTransaction, executeUpdate, getEntityManager, getLockMode, getSupportedHints, setFirstResult, setFlushMode, setHint, setLockMode, setMaxResults, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter

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

checkOpen, entityManager, findParameterRegistration, findParameterRegistration, findParameterRegistration, getEntityGraphQueryHint, getFirstResult, getFlushMode, getHints, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getSpecifiedFlushMode, getSpecifiedMaxResults, isBound, 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

setFirstResult, setFlushMode, setHint, setLockMode, setMaxResults, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter

Methods inherited from interface javax.persistence.Query

executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, 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

isNativeSqlQuery

protected boolean isNativeSqlQuery()

Description copied from class: BaseQueryImpl

Is the query represented here a native SQL query?

Specified by:

isNativeSqlQuery in class BaseQueryImpl

Returns:

true if it is a native SQL query; false otherwise

isSelectQuery

protected boolean isSelectQuery()

Description copied from class: BaseQueryImpl

Is the query represented here a SELECT query?

Specified by:

isSelectQuery in class BaseQueryImpl

Returns:

true if the query is a SELECT; false otherwise.

getHibernateQuery

public Query getHibernateQuery()

Description copied from interface: HibernateQuery

Gives access to the underlying Hibernate query object..

Specified by:

getHibernateQuery in interface HibernateQuery

Returns:

THe Hibernate query object.

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: BaseQueryImpl

Apply the given max results value.

Specified by:

applyMaxResults in class BaseQueryImpl

Parameters:

maxResults - The specified max results

applyFirstResult

protected void applyFirstResult(int firstResult)

Description copied from class: BaseQueryImpl

Apply the given first-result value.

Specified by:

applyFirstResult in class BaseQueryImpl

Parameters:

firstResult - The specified first-result value.

applyTimeoutHint

protected boolean applyTimeoutHint(int timeout)

Description copied from class: BaseQueryImpl

Apply the query timeout hint.

Specified by:

applyTimeoutHint in class BaseQueryImpl

Parameters:

timeout - The timeout (in seconds!) specified as a hint

Returns:

true if the hint was "applied"

applyCommentHint

protected boolean applyCommentHint(String comment)

Description copied from class: BaseQueryImpl

Apply the comment hint.

Specified by:

applyCommentHint in class BaseQueryImpl

Parameters:

comment - The comment specified as a hint

Returns:

true if the hint was "applied"

applyFetchSizeHint

protected boolean applyFetchSizeHint(int fetchSize)

Description copied from class: BaseQueryImpl

Apply the fetch size hint

Specified by:

applyFetchSizeHint in class BaseQueryImpl

Parameters:

fetchSize - The fetch size specified as a hint

Returns:

true if the hint was "applied"

applyCacheableHint

protected boolean applyCacheableHint(boolean isCacheable)

Description copied from class: BaseQueryImpl

Apply the cacheable (true/false) hint.

Specified by:

applyCacheableHint in class BaseQueryImpl

Parameters:

isCacheable - The value specified as hint

Returns:

true if the hint was "applied"

applyCacheRegionHint

protected boolean applyCacheRegionHint(String regionName)

Description copied from class: BaseQueryImpl

Apply the cache region hint

Specified by:

applyCacheRegionHint in class BaseQueryImpl

Parameters:

regionName - The name of the cache region specified as a hint

Returns:

true if the hint was "applied"

applyReadOnlyHint

protected boolean applyReadOnlyHint(boolean isReadOnly)

Description copied from class: BaseQueryImpl

Apply the read-only (true/false) hint.

Specified by:

applyReadOnlyHint in class BaseQueryImpl

Parameters:

isReadOnly - The value specified as hint

Returns:

true if the hint was "applied"

applyCacheModeHint

protected boolean applyCacheModeHint(CacheMode cacheMode)

Description copied from class: BaseQueryImpl

Apply the CacheMode hint.

Specified by:

applyCacheModeHint in class BaseQueryImpl

Parameters:

cacheMode - The CacheMode value specified as a hint.

Returns:

true if the hint was "applied"

applyFlushModeHint

protected boolean applyFlushModeHint(FlushMode flushMode)

Description copied from class: BaseQueryImpl

Apply the FlushMode hint.

Specified by:

applyFlushModeHint in class BaseQueryImpl

Parameters:

flushMode - The FlushMode value specified as hint

Returns:

true if the hint was "applied"

canApplyAliasSpecificLockModeHints

protected boolean canApplyAliasSpecificLockModeHints()

Description copied from class: BaseQueryImpl

Can alias-specific lock modes be applied?

Specified by:

canApplyAliasSpecificLockModeHints in class BaseQueryImpl

Returns:

true indicates they can be applied, false otherwise.

applyAliasSpecificLockModeHint

protected void applyAliasSpecificLockModeHint(String alias,
                                              LockMode lockMode)

Description copied from class: BaseQueryImpl

Apply the alias specific lock modes. Assumes BaseQueryImpl.canApplyAliasSpecificLockModeHints() has already been called and returned true.

Specified by:

applyAliasSpecificLockModeHint in class BaseQueryImpl

Parameters:

alias - The alias to apply the 'lockMode' to.

lockMode - The LockMode to apply.

getResultList

public List<X> getResultList()

Description copied from interface: TypedQuery

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

Description copied from interface: TypedQuery

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

unwrap

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

Description copied from interface: Query

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

internalApplyLockMode

protected void internalApplyLockMode(LockModeType lockModeType)

Specified by:

internalApplyLockMode in class BaseQueryImpl

applyLockTimeoutHint

protected boolean applyLockTimeoutHint(int timeout)

Description copied from class: BaseQueryImpl

Apply the lock timeout (in seconds!) hint

Specified by:

applyLockTimeoutHint in class BaseQueryImpl

Parameters:

timeout - The timeout (in seconds!) specified as a hint

Returns:

true if the hint was "applied"