org.hibernate.jpa.internal

Class StoredProcedureQueryImpl

java.lang.Object

org.hibernate.jpa.spi.BaseQueryImpl

org.hibernate.jpa.internal.StoredProcedureQueryImpl

All Implemented Interfaces:

Query, StoredProcedureQuery

public class StoredProcedureQueryImpl
extends BaseQueryImpl
implements StoredProcedureQuery

Author:

Steve Ebersole

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(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?
boolean	execute() Return true if the first result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.
int	executeUpdate() Execute an update or delete statement.
ProcedureCall	getHibernateProcedureCall()
LockModeType	getLockMode() Get the current lock mode for the query.
Object	getOutputParameterValue(int position) Retrieve a value passed back from the procedure through an INOUT or OUT parameter.
Object	getOutputParameterValue(String parameterName) Retrieve a value passed back from the procedure through an INOUT or OUT parameter.
List	getResultList() Execute a SELECT query and return the query results as an untyped List.
Object	getSingleResult() Execute a SELECT query that returns a single untyped result.
int	getUpdateCount() Return the update count or -1 if there is no pending result or if the next result is not an update count.
boolean	hasMoreResults() Return true if the next result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.
protected void	internalApplyLockMode(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()
StoredProcedureQuery	registerStoredProcedureParameter(int position, Class type, ParameterMode mode) Register a positional parameter.
StoredProcedureQuery	registerStoredProcedureParameter(String parameterName, Class type, ParameterMode mode) Register a named parameter.
StoredProcedureQueryImpl	setFlushMode(FlushModeType jpaFlushMode) Set the flush mode type to be used for the query execution.
StoredProcedureQueryImpl	setHint(String hintName, Object value) Set a query property or hint.
Query	setLockMode(LockModeType lockMode) Set the lock mode type to be used for the query execution.
StoredProcedureQueryImpl	setParameter(int position, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
StoredProcedureQueryImpl	setParameter(int position, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
StoredProcedureQueryImpl	setParameter(int position, Object value) Bind an argument to a positional parameter.
StoredProcedureQueryImpl	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a Parameter object.
StoredProcedureQueryImpl	setParameter(Parameter<Date> param, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a Parameter object.
<T> StoredProcedureQueryImpl	setParameter(Parameter<T> param, T value) Bind the value of a Parameter object.
StoredProcedureQueryImpl	setParameter(String name, Calendar value, TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
StoredProcedureQueryImpl	setParameter(String name, Date value, TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
StoredProcedureQueryImpl	setParameter(String name, Object value) Bind an argument to a named parameter.
<T> T	unwrap(Class<T> cls) Return an object of the specified type to allow access to the provider-specific API.

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(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 StoredProcedureQuery registerStoredProcedureParameter(int position,
                                                             Class type,
                                                             ParameterMode mode)

Description copied from interface: StoredProcedureQuery

Register a positional parameter. All positional parameters must be registered.

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

Parameters:

position - parameter position

type - type of the parameter

mode - parameter mode

Returns:

the same query instance

registerStoredProcedureParameter

public StoredProcedureQuery registerStoredProcedureParameter(String parameterName,
                                                             Class type,
                                                             ParameterMode mode)

Description copied from interface: StoredProcedureQuery

Register a named parameter. When using parameter names, all parameters must be registered in the order in which they occur in the parameter list of the stored procedure.

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

Parameters:

parameterName - name of the parameter as registered or

specified in metadata

type - type of the parameter

mode - parameter mode

Returns:

the same query instance

setParameter

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

Description copied from interface: Query

Bind the value of a Parameter object.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

setParameter

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

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public StoredProcedureQueryImpl setParameter(String name,
                                             Object value)

Description copied from interface: Query

Bind an argument to a named parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

setParameter

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

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public StoredProcedureQueryImpl setParameter(int position,
                                             Object value)

Description copied from interface: Query

Bind an argument to a positional parameter.

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

position - position

value - parameter value

Returns:

the same query instance

setParameter

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

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Specified by:

setParameter in interface StoredProcedureQuery

Overrides:

setParameter in class BaseQueryImpl

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setFlushMode

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

Specified by:

setFlushMode in interface StoredProcedureQuery

Overrides:

setFlushMode in class BaseQueryImpl

Parameters:

jpaFlushMode - flush mode

Returns:

the same query instance

setHint

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

Specified by:

setHint in interface StoredProcedureQuery

Overrides:

setHint in class BaseQueryImpl

Parameters:

hintName - name of the property or hint

value - value for the property or hint

Returns:

the same query instance

execute

public boolean execute()

Description copied from interface: StoredProcedureQuery

Return true if the first result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.

Specified by:

execute in interface StoredProcedureQuery

Returns:

true if first result corresponds to result set

outputs

protected ProcedureOutputs outputs()

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

getOutputParameterValue

public Object getOutputParameterValue(int position)

Description copied from interface: StoredProcedureQuery

Retrieve a value passed back from the procedure through an INOUT or OUT parameter. For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.

Specified by:

getOutputParameterValue in interface StoredProcedureQuery

Parameters:

position - parameter position

Returns:

the result that is passed back through the parameter

getOutputParameterValue

public Object getOutputParameterValue(String parameterName)

Description copied from interface: StoredProcedureQuery

Retrieve a value passed back from the procedure through an INOUT or OUT parameter. For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.

Specified by:

getOutputParameterValue in interface StoredProcedureQuery

Parameters:

parameterName - name of the parameter as registered or specified in metadata

Returns:

the result that is passed back through the parameter

hasMoreResults

public boolean hasMoreResults()

Description copied from interface: StoredProcedureQuery

Return true if the next result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.

Specified by:

hasMoreResults in interface StoredProcedureQuery

Returns:

true if next result corresponds to result set

getUpdateCount

public int getUpdateCount()

Description copied from interface: StoredProcedureQuery

Return the update count or -1 if there is no pending result or if the next result is not an update count.

Specified by:

getUpdateCount in interface StoredProcedureQuery

Returns:

update count or -1 if there is no pending result or if the next result is not an update count

getResultList

public List getResultList()

Description copied from interface: Query

Execute a SELECT query and return the query results as an untyped List.

Specified by:

getResultList in interface Query

Returns:

a list of the results

getSingleResult

public Object getSingleResult()

Description copied from interface: Query

Execute a SELECT query that returns a single untyped result.

Specified by:

getSingleResult in interface Query

Returns:

the result

unwrap

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

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:

cls - 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

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 Query setLockMode(LockModeType lockMode)

Description copied from interface: Query

Set the lock mode type to be used for the query execution.

Specified by:

setLockMode in interface Query

Parameters:

lockMode - lock mode

Returns:

the same query instance

getLockMode

public LockModeType getLockMode()

Description copied from interface: Query

Get the current lock mode for the query.

Specified by:

getLockMode in interface Query

Returns:

lock mode

internalApplyLockMode

protected void internalApplyLockMode(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(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(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()