org.hibernate.ejb

Class AbstractQueryImpl<X>

java.lang.Object

org.hibernate.ejb.AbstractQueryImpl<X>

All Implemented Interfaces:

Query, TypedQuery<X>

Direct Known Subclasses:

QueryImpl

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

Intended as a base class providing convenience in implementing both Query and TypedQuery.

IMPL NOTE : This issue, and the reason for this distinction, is that criteria and hl.sql queries share no commonality currently in Hibernate internals.

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
AbstractQueryImpl(HibernateEntityManagerImplementor entityManager)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	applyAliasSpecificLockMode(String alias, LockMode lockMode)
protected abstract void	applyCacheable(boolean isCacheable)
protected abstract void	applyCacheMode(CacheMode cacheMode)
protected abstract void	applyCacheRegion(String regionName)
protected abstract void	applyComment(String comment)
protected abstract void	applyFetchSize(int fetchSize)
protected abstract void	applyFirstResult(int firstResult) Apply the given first-result value.
protected abstract void	applyFlushMode(FlushMode flushMode)
protected abstract void	applyMaxResults(int maxResults) Apply the given max results value.
protected abstract void	applyReadOnly(boolean isReadOnly)
protected abstract void	applyTimeout(int timeout)
protected abstract boolean	canApplyLockModes()
int	executeUpdate() Execute an update or delete statement.
protected HibernateEntityManagerImplementor	getEntityManager()
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.
abstract LockModeType	getLockMode() Get the current lock mode for the query.
int	getMaxResults() The maximum number of results the query object was set to retrieve.
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 int	internalExecuteUpdate() Actually execute the update; all pre-requisites have been checked.
boolean	isBound(Parameter<?> param) Return a boolean indicating whether a value has been bound to the parameter.
protected void	registerParameterBinding(Parameter parameter, Object value)
TypedQuery<X>	setFirstResult(int firstResult) Set the position of the first result to retrieve.
TypedQuery<X>	setFlushMode(FlushModeType jpaFlushMode) Set the flush mode type to be used for the query execution.
TypedQuery<X>	setHint(String hintName, Object value) Set a query property or hint.
abstract TypedQuery<X>	setLockMode(LockModeType lockModeType) Set the lock mode type to be used for the query execution.
TypedQuery<X>	setMaxResults(int maxResult) Set the maximum number of results to retrieve.

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, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter

Methods inherited from interface javax.persistence.Query

getParameter, getParameter, getParameter, getParameter, getParameters, 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

applyMaxResults

protected abstract void applyMaxResults(int maxResults)

Apply the given max results value.

Parameters:

maxResults - The specified max results

setMaxResults

public TypedQuery<X> setMaxResults(int maxResult)

Description copied from interface: TypedQuery

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface TypedQuery<X>

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

applyFirstResult

protected abstract void applyFirstResult(int firstResult)

Apply the given first-result value.

Parameters:

firstResult - The specified first-result value.

setFirstResult

public TypedQuery<X> setFirstResult(int firstResult)

Description copied from interface: TypedQuery

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface TypedQuery<X>

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

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

applyTimeout

protected abstract void applyTimeout(int timeout)

applyComment

protected abstract void applyComment(String comment)

applyFetchSize

protected abstract void applyFetchSize(int fetchSize)

applyCacheable

protected abstract void applyCacheable(boolean isCacheable)

applyCacheRegion

protected abstract void applyCacheRegion(String regionName)

applyReadOnly

protected abstract void applyReadOnly(boolean isReadOnly)

applyCacheMode

protected abstract void applyCacheMode(CacheMode cacheMode)

applyFlushMode

protected abstract void applyFlushMode(FlushMode flushMode)

canApplyLockModes

protected abstract boolean canApplyLockModes()

applyAliasSpecificLockMode

protected abstract void applyAliasSpecificLockMode(String alias,
                              LockMode lockMode)

setHint

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

Description copied from interface: TypedQuery

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>

Parameters:

hintName - name of property or hint

value - value for the property or hint

Returns:

the same query instance

getSupportedHints

public Set<String> getSupportedHints()

setLockMode

public abstract 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 abstract LockModeType getLockMode()

Description copied from interface: Query

Get the current lock mode for the query.

Specified by:

getLockMode in interface Query

Returns:

lock mode

setFlushMode

public TypedQuery<X> setFlushMode(FlushModeType jpaFlushMode)

Description copied from interface: TypedQuery

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>

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

registerParameterBinding

protected void registerParameterBinding(Parameter parameter,
                            Object value)

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