org.hibernate.jpa.internal

Class StoredProcedureQueryImpl

java.lang.Object

org.hibernate.jpa.spi.BaseQueryImpl

org.hibernate.jpa.internal.StoredProcedureQueryImpl

All Implemented Interfaces:

javax.persistence.Query, javax.persistence.StoredProcedureQuery

public class StoredProcedureQueryImpl
extends BaseQueryImpl
implements javax.persistence.StoredProcedureQuery

Nested Class Summary

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

BaseQueryImpl.ParameterBindImpl<T>

Constructor Summary

Constructors

Constructor and Description
StoredProcedureQueryImpl(ProcedureCall procedureCall, HibernateEntityManagerImplementor entityManager)
StoredProcedureQueryImpl(ProcedureCallMemento memento, HibernateEntityManagerImplementor entityManager) This form is used to build a StoredProcedureQueryImpl from a memento (usually from a NamedStoredProcedureQuery).

Method Summary

Modifier and Type	Method and Description
protected void	applyAliasSpecificLockModeHint(java.lang.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(java.lang.String regionName) Apply the cache region hint
protected boolean	applyCommentHint(java.lang.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?
boolean	execute()
int	executeUpdate()
ProcedureCall	getHibernateProcedureCall()
javax.persistence.LockModeType	getLockMode()
java.lang.Object	getOutputParameterValue(int position)
java.lang.Object	getOutputParameterValue(java.lang.String parameterName)
java.util.List	getResultList()
java.lang.Object	getSingleResult()
int	getUpdateCount()
boolean	hasMoreResults()
protected void	internalApplyLockMode(javax.persistence.LockModeType lockModeType)
protected boolean	isNativeSqlQuery() Is the query represented here a native SQL query?
protected boolean	isSelectQuery() Is the query represented here a SELECT query?
protected ProcedureOutputs	outputs()
javax.persistence.StoredProcedureQuery	registerStoredProcedureParameter(int position, java.lang.Class type, javax.persistence.ParameterMode mode)
javax.persistence.StoredProcedureQuery	registerStoredProcedureParameter(java.lang.String parameterName, java.lang.Class type, javax.persistence.ParameterMode mode)
StoredProcedureQueryImpl	setFlushMode(javax.persistence.FlushModeType jpaFlushMode)
StoredProcedureQueryImpl	setHint(java.lang.String hintName, java.lang.Object value)
javax.persistence.Query	setLockMode(javax.persistence.LockModeType lockMode)
StoredProcedureQueryImpl	setParameter(int position, java.util.Calendar value, javax.persistence.TemporalType temporalType)
StoredProcedureQueryImpl	setParameter(int position, java.util.Date value, javax.persistence.TemporalType temporalType)
StoredProcedureQueryImpl	setParameter(int position, java.lang.Object value)
StoredProcedureQueryImpl	setParameter(javax.persistence.Parameter<java.util.Calendar> param, java.util.Calendar value, javax.persistence.TemporalType temporalType)
StoredProcedureQueryImpl	setParameter(javax.persistence.Parameter<java.util.Date> param, java.util.Date value, javax.persistence.TemporalType temporalType)
<T> StoredProcedureQueryImpl	setParameter(javax.persistence.Parameter<T> param, T value)
StoredProcedureQueryImpl	setParameter(java.lang.String name, java.util.Calendar value, javax.persistence.TemporalType temporalType)
StoredProcedureQueryImpl	setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType)
StoredProcedureQueryImpl	setParameter(java.lang.String name, java.lang.Object value)
<T> T	unwrap(java.lang.Class<T> cls)

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, getSupportedHints, isBound, registerParameter, setFirstResult, setMaxResults, 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.Query

getFirstResult, getFlushMode, getHints, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, setFirstResult, setMaxResults

Constructor Detail

StoredProcedureQueryImpl

public StoredProcedureQueryImpl(ProcedureCall procedureCall,
                                HibernateEntityManagerImplementor entityManager)

StoredProcedureQueryImpl

public StoredProcedureQueryImpl(ProcedureCallMemento memento,
                                HibernateEntityManagerImplementor entityManager)

This form is used to build a StoredProcedureQueryImpl from a memento (usually from a NamedStoredProcedureQuery).

Parameters:

memento - The memento

entityManager - The EntityManager

Method Detail

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"

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(java.lang.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"

registerStoredProcedureParameter

public javax.persistence.StoredProcedureQuery registerStoredProcedureParameter(int position,
                                                                               java.lang.Class type,
                                                                               javax.persistence.ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface javax.persistence.StoredProcedureQuery

registerStoredProcedureParameter

public javax.persistence.StoredProcedureQuery registerStoredProcedureParameter(java.lang.String parameterName,
                                                                               java.lang.Class type,
                                                                               javax.persistence.ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface javax.persistence.StoredProcedureQuery

setParameter

public <T> StoredProcedureQueryImpl setParameter(javax.persistence.Parameter<T> param,
                                                 T value)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(javax.persistence.Parameter<java.util.Calendar> param,
                                             java.util.Calendar value,
                                             javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(javax.persistence.Parameter<java.util.Date> param,
                                             java.util.Date value,
                                             javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(java.lang.String name,
                                             java.lang.Object value)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(java.lang.String name,
                                             java.util.Calendar value,
                                             javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(java.lang.String name,
                                             java.util.Date value,
                                             javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(int position,
                                             java.lang.Object value)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(int position,
                                             java.util.Calendar value,
                                             javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setParameter

public StoredProcedureQueryImpl setParameter(int position,
                                             java.util.Date value,
                                             javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

setFlushMode

public StoredProcedureQueryImpl setFlushMode(javax.persistence.FlushModeType jpaFlushMode)

Specified by:

setFlushMode in interface javax.persistence.Query

Specified by:

setFlushMode in interface javax.persistence.StoredProcedureQuery

Overrides:

setFlushMode in class BaseQueryImpl

setHint

public StoredProcedureQueryImpl setHint(java.lang.String hintName,
                                        java.lang.Object value)

Specified by:

setHint in interface javax.persistence.Query

Specified by:

setHint in interface javax.persistence.StoredProcedureQuery

Overrides:

setHint in class BaseQueryImpl

execute

public boolean execute()

Specified by:

execute in interface javax.persistence.StoredProcedureQuery

outputs

protected ProcedureOutputs outputs()

executeUpdate

public int executeUpdate()

Specified by:

executeUpdate in interface javax.persistence.Query

getOutputParameterValue

public java.lang.Object getOutputParameterValue(int position)

Specified by:

getOutputParameterValue in interface javax.persistence.StoredProcedureQuery

getOutputParameterValue

public java.lang.Object getOutputParameterValue(java.lang.String parameterName)

Specified by:

getOutputParameterValue in interface javax.persistence.StoredProcedureQuery

hasMoreResults

public boolean hasMoreResults()

Specified by:

hasMoreResults in interface javax.persistence.StoredProcedureQuery

getUpdateCount

public int getUpdateCount()

Specified by:

getUpdateCount in interface javax.persistence.StoredProcedureQuery

getResultList

public java.util.List getResultList()

Specified by:

getResultList in interface javax.persistence.Query

getSingleResult

public java.lang.Object getSingleResult()

Specified by:

getSingleResult in interface javax.persistence.Query

unwrap

public <T> T unwrap(java.lang.Class<T> cls)

Specified by:

unwrap in interface javax.persistence.Query

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.

setLockMode

public javax.persistence.Query setLockMode(javax.persistence.LockModeType lockMode)

Specified by:

setLockMode in interface javax.persistence.Query

getLockMode

public javax.persistence.LockModeType getLockMode()

Specified by:

getLockMode in interface javax.persistence.Query

internalApplyLockMode

protected void internalApplyLockMode(javax.persistence.LockModeType lockModeType)

Specified by:

internalApplyLockMode in class BaseQueryImpl

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.

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

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(java.lang.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.

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"

applyCommentHint

protected boolean applyCommentHint(java.lang.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"

getHibernateProcedureCall

public ProcedureCall getHibernateProcedureCall()