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.

Author:

Steve Ebersole

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

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() The position of the first result the query object was set to retrieve.
FlushModeType	getFlushMode() Get the flush mode in effect for the query execution.
Map<String,Object>	getHints() Get the properties and hints and associated values that are in effect for the query instance.
int	getMaxResults() The maximum number of results the query object was set to retrieve.
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	getParameters() Get the parameter objects corresponding to the declared parameters of the query.
Object	getParameterValue(int position) Return the value bound to the positional parameter.
<T> T	getParameterValue(Parameter<T> param) Return the value bound to the parameter.
Object	getParameterValue(String name) Return the value bound to the named parameter.
protected FlushModeType	getSpecifiedFlushMode()
int	getSpecifiedMaxResults()
Set<String>	getSupportedHints()
protected abstract void	internalApplyLockMode(LockModeType lockModeType)
boolean	isBound(Parameter<?> param) Return a boolean indicating whether a value has been bound to the parameter.
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) Set the position of the first result to retrieve.
BaseQueryImpl	setFlushMode(FlushModeType jpaFlushMode) Set the flush mode type to be used for the query execution.
BaseQueryImpl	setHint(String hintName, Object value) Set a query property or hint.
BaseQueryImpl	setMaxResults(int maxResult) Set the maximum number of results to retrieve.
BaseQueryImpl	setParameter(int position, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
BaseQueryImpl	setParameter(int position, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
BaseQueryImpl	setParameter(int position, Object value) Bind an argument to a positional parameter.
BaseQueryImpl	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a Parameter object.
BaseQueryImpl	setParameter(Parameter<Date> param, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a Parameter object.
<T> BaseQueryImpl	setParameter(Parameter<T> param, T value) Bind the value of a Parameter object.
BaseQueryImpl	setParameter(String name, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
BaseQueryImpl	setParameter(String name, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
BaseQueryImpl	setParameter(String name, Object value) Bind an argument to a named parameter.
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)

Description copied from interface: Query

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface Query

Parameters:

firstResult - position of the first result, numbered from 0

Returns:

the same query instance

getFirstResult

public int getFirstResult()

Description copied from interface: Query

The position of the first result the query object was set to retrieve. Returns 0 if setFirstResult was not applied to the query object.

Specified by:

getFirstResult in interface Query

Returns:

position of the first result

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)

Description copied from interface: Query

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface Query

Parameters:

maxResult - maximum number of results to retrieve

Returns:

the same query instance

getSpecifiedMaxResults

public int getSpecifiedMaxResults()

getMaxResults

public int getMaxResults()

Description copied from interface: Query

The maximum number of results the query object was set to retrieve. Returns Integer.MAX_VALUE if setMaxResults was not applied to the query object.

Specified by:

getMaxResults in interface Query

Returns:

maximum number of results

getSupportedHints

public Set<String> getSupportedHints()

getHints

public Map<String,Object> getHints()

Description copied from interface: Query

Get the properties and hints and associated values that are in effect for the query instance.

Specified by:

getHints in interface Query

Returns:

query properties and hints

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)

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

Parameters:

hintName - name of the property or hint

value - value for the property or hint

Returns:

the same query instance

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)

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

Parameters:

jpaFlushMode - flush mode

Returns:

the same query instance

getSpecifiedFlushMode

protected FlushModeType getSpecifiedFlushMode()

getFlushMode

public FlushModeType getFlushMode()

Description copied from interface: Query

Get the flush mode in effect for the query execution. If a flush mode has not been set for the query object, returns the flush mode in effect for the entity manager.

Specified by:

getFlushMode in interface Query

Returns:

flush mode

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)

Description copied from interface: Query

Bind the value of a Parameter object.

Specified by:

setParameter in interface Query

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

setParameter

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

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public BaseQueryImpl setParameter(String name,
                                  Object value)

Description copied from interface: Query

Bind an argument to a named parameter.

Specified by:

setParameter in interface Query

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

setParameter

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

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public BaseQueryImpl setParameter(int position,
                                  Object value)

Description copied from interface: Query

Bind an argument to a positional parameter.

Specified by:

setParameter in interface Query

Parameters:

position - position

value - parameter value

Returns:

the same query instance

setParameter

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

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

getParameters

public Set getParameters()

Description copied from interface: Query

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)

Description copied from interface: Query

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 <T> Parameter<T> getParameter(String name,
                                     Class<T> type)

Description copied from interface: Query

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 Parameter<?> getParameter(int position)

Description copied from interface: Query

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(int position,
                                     Class<T> type)

Description copied from interface: Query

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

isBound

public boolean isBound(Parameter<?> param)

Description copied from interface: Query

Return a boolean indicating whether a value has been bound to the parameter.

Specified by:

isBound in interface Query

Parameters:

param - parameter object

Returns:

boolean indicating whether parameter has been bound

getParameterValue

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

Description copied from interface: Query

Return the value bound to the parameter.

Specified by:

getParameterValue in interface Query

Parameters:

param - parameter object

Returns:

parameter value

getParameterValue

public Object getParameterValue(String name)

Description copied from interface: Query

Return the value bound to the named parameter.

Specified by:

getParameterValue in interface Query

Parameters:

name - parameter name

Returns:

parameter value

getParameterValue

public Object getParameterValue(int position)

Description copied from interface: Query

Return the value bound to the positional parameter.

Specified by:

getParameterValue in interface Query

Parameters:

position - position

Returns:

parameter value

getEntityGraphQueryHint

protected EntityGraphQueryHint getEntityGraphQueryHint()

validateBinding

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