org.apache.openjpa.persistence

Class StoredProcedureQueryImpl

java.lang.Object

org.apache.openjpa.persistence.StoredProcedureQueryImpl

All Implemented Interfaces:

javax.persistence.Query, javax.persistence.StoredProcedureQuery

public class StoredProcedureQueryImpl
extends Object
implements javax.persistence.StoredProcedureQuery

Implements Store Procedure based query for JPA facade.
A stored procedure query differs from other query types because it may return more than one result set, apart from an optional update count, whereas the traditional query processing in OpenJPA via the abstractions of ResultObjectProvider and Result assumed that a query will return its result in a single list.
This query resorts to a callback mechanism, where the execution of the query returns not a result, but a callback object that can be used to callback to OpenJPA kernel to get a series of results via the traditional result processing pathway.

Author:

Pinaki Poddar, Romain Manni-Bucau

Constructor Summary

Constructors

Constructor and Description
StoredProcedureQueryImpl(String procedureName, MultiQueryMetaData meta, QueryImpl<?> delegate) Construct a query for executing a Stored Procedure.

Method Summary

Modifier and Type	Method and Description
boolean	execute() Executes this receiver by delegation to the underlying executable query.
int	executeUpdate()
OpenJPAQuery<?>	getDelegate() Gets the facade delegate that manages bind parameters on behalf of this receiver.
Query	getExecutableQuery() Gets the kernel delegate that is handles actual execution on behalf of this receiver.
int	getFirstResult()
javax.persistence.FlushModeType	getFlushMode()
Map<String,Object>	getHints()
javax.persistence.LockModeType	getLockMode()
int	getMaxResults()
Object	getOutputParameterValue(int position)
Object	getOutputParameterValue(String parameterName)
javax.persistence.Parameter<?>	getParameter(int position)
<T> javax.persistence.Parameter<T>	getParameter(int position, Class<T> type)
javax.persistence.Parameter<?>	getParameter(String name)
<T> javax.persistence.Parameter<T>	getParameter(String name, Class<T> type)
Set<javax.persistence.Parameter<?>>	getParameters()
Object	getParameterValue(int position)
<T> T	getParameterValue(javax.persistence.Parameter<T> param)
Object	getParameterValue(String name)
List	getResultList()
Object	getSingleResult()
int	getUpdateCount()
boolean	hasMoreResults()
boolean	isBound(javax.persistence.Parameter<?> param)
javax.persistence.StoredProcedureQuery	registerStoredProcedureParameter(int position, Class type, javax.persistence.ParameterMode mode)
javax.persistence.StoredProcedureQuery	registerStoredProcedureParameter(String name, Class type, javax.persistence.ParameterMode mode)
javax.persistence.Query	setFirstResult(int startPosition)
javax.persistence.StoredProcedureQuery	setFlushMode(javax.persistence.FlushModeType flushMode)
javax.persistence.StoredProcedureQuery	setHint(String hintName, Object value)
javax.persistence.Query	setLockMode(javax.persistence.LockModeType lockMode)
javax.persistence.Query	setMaxResults(int maxResult)
javax.persistence.StoredProcedureQuery	setParameter(int position, Calendar value, javax.persistence.TemporalType temporalType)
javax.persistence.StoredProcedureQuery	setParameter(int position, Date value, javax.persistence.TemporalType temporalType)
javax.persistence.StoredProcedureQuery	setParameter(int position, Object value)
javax.persistence.StoredProcedureQuery	setParameter(javax.persistence.Parameter<Calendar> param, Calendar cal, javax.persistence.TemporalType temporalType)
javax.persistence.StoredProcedureQuery	setParameter(javax.persistence.Parameter<Date> param, Date value, javax.persistence.TemporalType temporalType)
<T> javax.persistence.StoredProcedureQuery	setParameter(javax.persistence.Parameter<T> param, T value)
javax.persistence.StoredProcedureQuery	setParameter(String name, Calendar cal, javax.persistence.TemporalType temporalType)
javax.persistence.StoredProcedureQuery	setParameter(String name, Date date, javax.persistence.TemporalType temporalType)
javax.persistence.StoredProcedureQuery	setParameter(String name, Object value)
String	toString()
<T> T	unwrap(Class<T> cls)

Methods inherited from class java.lang.Object

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

Constructor Detail

StoredProcedureQueryImpl

public StoredProcedureQueryImpl(String procedureName,
                                MultiQueryMetaData meta,
                                QueryImpl<?> delegate)

Construct a query for executing a Stored Procedure.

Parameters:

procedureName - name of the database stored procedure.

meta -

delegate - the delegate which manages bind parameters on behalf of this

Method Detail

getDelegate

public OpenJPAQuery<?> getDelegate()

Gets the facade delegate that manages bind parameters on behalf of this receiver.

Returns:

getExecutableQuery

public Query getExecutableQuery()

Gets the kernel delegate that is handles actual execution on behalf of this receiver.

Returns:

execute

public boolean execute()

Executes this receiver by delegation to the underlying executable query.
This method is multi-call safe. The underlying executable query is executed only for the first invocation. Subsequent

Specified by:

execute in interface javax.persistence.StoredProcedureQuery

getResultList

public List getResultList()

Specified by:

getResultList in interface javax.persistence.Query

Specified by:

getResultList in interface javax.persistence.StoredProcedureQuery

getSingleResult

public Object getSingleResult()

Specified by:

getSingleResult in interface javax.persistence.Query

Specified by:

getSingleResult 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

executeUpdate

public int executeUpdate()

Specified by:

executeUpdate in interface javax.persistence.Query

Specified by:

executeUpdate in interface javax.persistence.StoredProcedureQuery

getParameter

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

Specified by:

getParameter in interface javax.persistence.Query

getParameter

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

Specified by:

getParameter in interface javax.persistence.Query

isBound

public boolean isBound(javax.persistence.Parameter<?> param)

Specified by:

isBound in interface javax.persistence.Query

getParameterValue

public <T> T getParameterValue(javax.persistence.Parameter<T> param)

Specified by:

getParameterValue in interface javax.persistence.Query

unwrap

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

Specified by:

unwrap in interface javax.persistence.Query

setParameter

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

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setParameter

public javax.persistence.StoredProcedureQuery setParameter(javax.persistence.Parameter<Calendar> param,
                                                           Calendar cal,
                                                           javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setParameter

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

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

registerStoredProcedureParameter

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

Specified by:

registerStoredProcedureParameter in interface javax.persistence.StoredProcedureQuery

registerStoredProcedureParameter

public javax.persistence.StoredProcedureQuery registerStoredProcedureParameter(String name,
                                                                               Class type,
                                                                               javax.persistence.ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface javax.persistence.StoredProcedureQuery

getOutputParameterValue

public Object getOutputParameterValue(int position)

Specified by:

getOutputParameterValue in interface javax.persistence.StoredProcedureQuery

getOutputParameterValue

public Object getOutputParameterValue(String parameterName)

Specified by:

getOutputParameterValue in interface javax.persistence.StoredProcedureQuery

setMaxResults

public javax.persistence.Query setMaxResults(int maxResult)

Specified by:

setMaxResults in interface javax.persistence.Query

getMaxResults

public int getMaxResults()

Specified by:

getMaxResults in interface javax.persistence.Query

setFirstResult

public javax.persistence.Query setFirstResult(int startPosition)

Specified by:

setFirstResult in interface javax.persistence.Query

getFirstResult

public int getFirstResult()

Specified by:

getFirstResult in interface javax.persistence.Query

getHints

public Map<String,Object> getHints()

Specified by:

getHints in interface javax.persistence.Query

getParameters

public Set<javax.persistence.Parameter<?>> getParameters()

Specified by:

getParameters in interface javax.persistence.Query

getParameter

public javax.persistence.Parameter<?> getParameter(String name)

Specified by:

getParameter in interface javax.persistence.Query

getParameter

public javax.persistence.Parameter<?> getParameter(int position)

Specified by:

getParameter in interface javax.persistence.Query

getParameterValue

public Object getParameterValue(String name)

Specified by:

getParameterValue in interface javax.persistence.Query

getParameterValue

public Object getParameterValue(int position)

Specified by:

getParameterValue in interface javax.persistence.Query

getFlushMode

public javax.persistence.FlushModeType getFlushMode()

Specified by:

getFlushMode in interface javax.persistence.Query

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

setHint

public javax.persistence.StoredProcedureQuery setHint(String hintName,
                                                      Object value)

Specified by:

setHint in interface javax.persistence.Query

Specified by:

setHint in interface javax.persistence.StoredProcedureQuery

setParameter

public javax.persistence.StoredProcedureQuery setParameter(String name,
                                                           Object value)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setParameter

public javax.persistence.StoredProcedureQuery setParameter(String name,
                                                           Calendar cal,
                                                           javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setParameter

public javax.persistence.StoredProcedureQuery setParameter(String name,
                                                           Date date,
                                                           javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setParameter

public javax.persistence.StoredProcedureQuery setParameter(int position,
                                                           Object value)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setParameter

public javax.persistence.StoredProcedureQuery setParameter(int position,
                                                           Calendar value,
                                                           javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setParameter

public javax.persistence.StoredProcedureQuery setParameter(int position,
                                                           Date value,
                                                           javax.persistence.TemporalType temporalType)

Specified by:

setParameter in interface javax.persistence.Query

Specified by:

setParameter in interface javax.persistence.StoredProcedureQuery

setFlushMode

public javax.persistence.StoredProcedureQuery setFlushMode(javax.persistence.FlushModeType flushMode)

Specified by:

setFlushMode in interface javax.persistence.Query

Specified by:

setFlushMode in interface javax.persistence.StoredProcedureQuery

toString

public String toString()

Overrides:

toString in class Object