org.hibernate.jpa.spi

Class BaseQueryImpl

java.lang.Object

org.hibernate.jpa.spi.BaseQueryImpl

All Implemented Interfaces:

Query

Direct Known Subclasses:

AbstractQueryImpl, BaseQueryImpl, StoredProcedureQueryImpl

public abstract class BaseQueryImpl
extends Object
implements Query

Intended as the base class for all Query implementations, including TypedQuery and StoredProcedureQuery. Care should be taken that all changes here fit with all those usages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseQueryImpl.ParameterBindImpl<T>

Constructor Summary

Constructors

Constructor and Description
BaseQueryImpl(HibernateEntityManagerImplementor entityManager)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	applyAliasSpecificLockModeHint(String alias, LockMode lockMode) Apply the alias specific lock modes.
protected abstract boolean	applyCacheableHint(boolean isCacheable) Apply the cacheable (true/false) hint.
protected abstract boolean	applyCacheModeHint(CacheMode cacheMode) Apply the CacheMode hint.
protected abstract boolean	applyCacheRegionHint(String regionName) Apply the cache region hint
protected abstract boolean	applyCommentHint(String comment) Apply the comment hint.
protected abstract boolean	applyFetchSizeHint(int fetchSize) Apply the fetch size hint
protected abstract void	applyFirstResult(int firstResult) Apply the given first-result value.
protected abstract boolean	applyFlushModeHint(FlushMode flushMode) Apply the FlushMode hint.
protected abstract boolean	applyLockTimeoutHint(int timeout) Apply the lock timeout (in seconds!) hint
protected abstract void	applyMaxResults(int maxResults) Apply the given max results value.
protected abstract boolean	applyReadOnlyHint(boolean isReadOnly) Apply the read-only (true/false) hint.
protected abstract boolean	applyTimeoutHint(int timeout) Apply the query timeout hint.
protected abstract boolean	canApplyAliasSpecificLockModeHints() Can alias-specific lock modes be applied?
protected void	checkOpen(boolean markForRollbackIfClosed)
protected HibernateEntityManagerImplementor	entityManager()
protected <X> ParameterRegistration<X>	findParameterRegistration(int parameterPosition)
protected <X> ParameterRegistration<X>	findParameterRegistration(Parameter<X> parameter)
protected <X> ParameterRegistration<X>	findParameterRegistration(String parameterName)
protected EntityGraphQueryHint	getEntityGraphQueryHint()
int	getFirstResult()
FlushModeType	getFlushMode()
Map<String,Object>	getHints()
int	getMaxResults()
Parameter<?>	getParameter(int position)
<T> Parameter<T>	getParameter(int position, Class<T> type)
Parameter<?>	getParameter(String name)
<T> Parameter<T>	getParameter(String name, Class<T> type)
Set	getParameters()
Object	getParameterValue(int position)
<T> T	getParameterValue(Parameter<T> param)
Object	getParameterValue(String name)
protected FlushModeType	getSpecifiedFlushMode()
int	getSpecifiedMaxResults()
Set<String>	getSupportedHints()
protected abstract void	internalApplyLockMode(LockModeType lockModeType)
boolean	isBound(Parameter<?> param)
protected abstract boolean	isNativeSqlQuery() Is the query represented here a native SQL query?
protected abstract boolean	isSelectQuery() Is the query represented here a SELECT query?
protected void	registerParameter(ParameterRegistration parameter)
BaseQueryImpl	setFirstResult(int firstResult)
BaseQueryImpl	setFlushMode(FlushModeType jpaFlushMode)
BaseQueryImpl	setHint(String hintName, Object value)
BaseQueryImpl	setMaxResults(int maxResult)
BaseQueryImpl	setParameter(int position, Calendar value, TemporalType temporalType)
BaseQueryImpl	setParameter(int position, Date value, TemporalType temporalType)
BaseQueryImpl	setParameter(int position, Object value)
BaseQueryImpl	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)
BaseQueryImpl	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)
<T> BaseQueryImpl	setParameter(Parameter<T> param, T value)
BaseQueryImpl	setParameter(String name, Calendar value, TemporalType temporalType)
BaseQueryImpl	setParameter(String name, Date value, TemporalType temporalType)
BaseQueryImpl	setParameter(String name, Object value)
protected static void	validateBinding(Class parameterType, Object bind, TemporalType temporalType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.persistence.Query

executeUpdate, getLockMode, getResultList, getSingleResult, setLockMode, unwrap

Constructor Detail

BaseQueryImpl

public BaseQueryImpl(HibernateEntityManagerImplementor entityManager)

Method Detail

entityManager

protected HibernateEntityManagerImplementor entityManager()

checkOpen

protected void checkOpen(boolean markForRollbackIfClosed)

applyFirstResult

protected abstract void applyFirstResult(int firstResult)

Apply the given first-result value.

Parameters:

firstResult - The specified first-result value.

setFirstResult

public BaseQueryImpl setFirstResult(int firstResult)

Specified by:

setFirstResult in interface Query

getFirstResult

public int getFirstResult()

Specified by:

getFirstResult in interface Query

applyMaxResults

protected abstract void applyMaxResults(int maxResults)

Apply the given max results value.

Parameters:

maxResults - The specified max results

setMaxResults

public BaseQueryImpl setMaxResults(int maxResult)

Specified by:

setMaxResults in interface Query

getSpecifiedMaxResults

public int getSpecifiedMaxResults()

getMaxResults

public int getMaxResults()

Specified by:

getMaxResults in interface Query

getSupportedHints

public Set<String> getSupportedHints()

getHints

public Map<String,Object> getHints()

Specified by:

getHints in interface Query

applyTimeoutHint

protected abstract boolean applyTimeoutHint(int timeout)

Apply the query timeout hint.

Parameters:

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

Returns:

true if the hint was "applied"

applyLockTimeoutHint

protected abstract boolean applyLockTimeoutHint(int timeout)

Apply the lock timeout (in seconds!) hint

Parameters:

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

Returns:

true if the hint was "applied"

applyCommentHint

protected abstract boolean applyCommentHint(String comment)

Apply the comment hint.

Parameters:

comment - The comment specified as a hint

Returns:

true if the hint was "applied"

applyFetchSizeHint

protected abstract boolean applyFetchSizeHint(int fetchSize)

Apply the fetch size hint

Parameters:

fetchSize - The fetch size specified as a hint

Returns:

true if the hint was "applied"

applyCacheableHint

protected abstract boolean applyCacheableHint(boolean isCacheable)

Apply the cacheable (true/false) hint.

Parameters:

isCacheable - The value specified as hint

Returns:

true if the hint was "applied"

applyCacheRegionHint

protected abstract boolean applyCacheRegionHint(String regionName)

Apply the cache region hint

Parameters:

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

Returns:

true if the hint was "applied"

applyReadOnlyHint

protected abstract boolean applyReadOnlyHint(boolean isReadOnly)

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

Parameters:

isReadOnly - The value specified as hint

Returns:

true if the hint was "applied"

applyCacheModeHint

protected abstract boolean applyCacheModeHint(CacheMode cacheMode)

Apply the CacheMode hint.

Parameters:

cacheMode - The CacheMode value specified as a hint.

Returns:

true if the hint was "applied"

applyFlushModeHint

protected abstract boolean applyFlushModeHint(FlushMode flushMode)

Apply the FlushMode hint.

Parameters:

flushMode - The FlushMode value specified as hint

Returns:

true if the hint was "applied"

canApplyAliasSpecificLockModeHints

protected abstract boolean canApplyAliasSpecificLockModeHints()

Can alias-specific lock modes be applied?

Returns:

true indicates they can be applied, false otherwise.

applyAliasSpecificLockModeHint

protected abstract void applyAliasSpecificLockModeHint(String alias,
                                  LockMode lockMode)

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

Parameters:

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

lockMode - The LockMode to apply.

setHint

public BaseQueryImpl setHint(String hintName,
                    Object value)

Specified by:

setHint in interface Query

isNativeSqlQuery

protected abstract boolean isNativeSqlQuery()

Is the query represented here a native SQL query?

Returns:

true if it is a native SQL query; false otherwise

isSelectQuery

protected abstract boolean isSelectQuery()

Is the query represented here a SELECT query?

Returns:

true if the query is a SELECT; false otherwise.

internalApplyLockMode

protected abstract void internalApplyLockMode(LockModeType lockModeType)

setFlushMode

public BaseQueryImpl setFlushMode(FlushModeType jpaFlushMode)

Specified by:

setFlushMode in interface Query

getSpecifiedFlushMode

protected FlushModeType getSpecifiedFlushMode()

getFlushMode

public FlushModeType getFlushMode()

Specified by:

getFlushMode in interface Query

findParameterRegistration

protected <X> ParameterRegistration<X> findParameterRegistration(Parameter<X> parameter)

findParameterRegistration

protected <X> ParameterRegistration<X> findParameterRegistration(String parameterName)

findParameterRegistration

protected <X> ParameterRegistration<X> findParameterRegistration(int parameterPosition)

registerParameter

protected void registerParameter(ParameterRegistration parameter)

setParameter

public <T> BaseQueryImpl setParameter(Parameter<T> param,
                             T value)

Specified by:

setParameter in interface Query

setParameter

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

Specified by:

setParameter in interface Query

setParameter

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

Specified by:

setParameter in interface Query

setParameter

public BaseQueryImpl setParameter(String name,
                         Object value)

Specified by:

setParameter in interface Query

setParameter

public BaseQueryImpl setParameter(String name,
                         Calendar value,
                         TemporalType temporalType)

Specified by:

setParameter in interface Query

setParameter

public BaseQueryImpl setParameter(String name,
                         Date value,
                         TemporalType temporalType)

Specified by:

setParameter in interface Query

setParameter

public BaseQueryImpl setParameter(int position,
                         Object value)

Specified by:

setParameter in interface Query

setParameter

public BaseQueryImpl setParameter(int position,
                         Calendar value,
                         TemporalType temporalType)

Specified by:

setParameter in interface Query

setParameter

public BaseQueryImpl setParameter(int position,
                         Date value,
                         TemporalType temporalType)

Specified by:

setParameter in interface Query

getParameters

public Set getParameters()

Specified by:

getParameters in interface Query

getParameter

public Parameter<?> getParameter(String name)

Specified by:

getParameter in interface Query

getParameter

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

Specified by:

getParameter in interface Query

getParameter

public Parameter<?> getParameter(int position)

Specified by:

getParameter in interface Query

getParameter

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

Specified by:

getParameter in interface Query

isBound

public boolean isBound(Parameter<?> param)

Specified by:

isBound in interface Query

getParameterValue

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

Specified by:

getParameterValue in interface Query

getParameterValue

public Object getParameterValue(String name)

Specified by:

getParameterValue in interface Query

getParameterValue

public Object getParameterValue(int position)

Specified by:

getParameterValue in interface Query

getEntityGraphQueryHint

protected EntityGraphQueryHint getEntityGraphQueryHint()

validateBinding

protected static void validateBinding(Class parameterType,
                   Object bind,
                   TemporalType temporalType)