org.datanucleus.api.jpa

Class JPAStoredProcedureQuery

java.lang.Object

org.datanucleus.api.jpa.JPAStoredProcedureQuery

All Implemented Interfaces:

StoredProcedureQuery, javax.persistence.Query

public class JPAStoredProcedureQuery
extends Object
implements StoredProcedureQuery

Implementation of a StoredProcedureQuery. Wraps an internal query. TODO Extend JPAQuery

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.datanucleus.util.Localiser	LOCALISER Localisation utility for output messages

Constructor Summary

Constructors

Constructor and Description
JPAStoredProcedureQuery(javax.persistence.EntityManager em, org.datanucleus.store.query.Query query)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute() Returns 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()
int	getFirstResult()
javax.persistence.FlushModeType	getFlushMode()
Map<String,Object>	getHints()
javax.persistence.LockModeType	getLockMode()
int	getMaxResults()
Object	getOutputParameterValue(int position) Used to retrieve the values passed back from the procedure through INOUT and OUT parameters.
Object	getOutputParameterValue(String parameterName) Used to retrieve the values passed back from the procedure through INOUT and OUT parameters.
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() Returns the update count or -1 if there is no pending result or if the next result is not an update count.
boolean	hasMoreResults() Returns 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.
boolean	isBound(javax.persistence.Parameter<?> param)
StoredProcedureQuery	registerStoredProcedureParameter(int position, Class type, ParameterMode mode) Register a positional parameter.
StoredProcedureQuery	registerStoredProcedureParameter(String parameterName, Class type, ParameterMode mode) Register a named parameter.
javax.persistence.Query	setFirstResult(int startPosition)
StoredProcedureQuery	setFlushMode(javax.persistence.FlushModeType mode) Set the flush mode type to be used for the query execution.
StoredProcedureQuery	setHint(String hintName, Object value) Set a query property or hint.
javax.persistence.Query	setLockMode(javax.persistence.LockModeType arg0)
javax.persistence.Query	setMaxResults(int max)
StoredProcedureQuery	setParameter(int position, Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
StoredProcedureQuery	setParameter(int position, Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
StoredProcedureQuery	setParameter(int position, Object value) Bind an argument to a positional parameter.
StoredProcedureQuery	setParameter(javax.persistence.Parameter<Calendar> param, Calendar cal, javax.persistence.TemporalType type) Bind an instance of java.util.Calendar to a Parameter object.
StoredProcedureQuery	setParameter(javax.persistence.Parameter<Date> param, Date date, javax.persistence.TemporalType type) Bind an instance of java.util.Date to a Parameter object.
<T> StoredProcedureQuery	setParameter(javax.persistence.Parameter<T> param, T value) Bind the value of a Parameter object.
StoredProcedureQuery	setParameter(String name, Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
StoredProcedureQuery	setParameter(String name, Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
StoredProcedureQuery	setParameter(String name, Object value) Bind an argument to a named parameter.
<T> T	unwrap(Class<T> cls)

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER

protected static final org.datanucleus.util.Localiser LOCALISER

Localisation utility for output messages

Constructor Detail

JPAStoredProcedureQuery

public JPAStoredProcedureQuery(javax.persistence.EntityManager em,
                       org.datanucleus.store.query.Query query)

Method Detail

getFlushMode

public javax.persistence.FlushModeType getFlushMode()

Specified by:

getFlushMode in interface javax.persistence.Query

setFlushMode

public StoredProcedureQuery setFlushMode(javax.persistence.FlushModeType mode)

Description copied from interface: StoredProcedureQuery

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 StoredProcedureQuery

Specified by:

setFlushMode in interface javax.persistence.Query

Parameters:

mode - flush mode

Returns:

the same query instance

getLockMode

public javax.persistence.LockModeType getLockMode()

Specified by:

getLockMode in interface javax.persistence.Query

setLockMode

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

Specified by:

setLockMode in interface javax.persistence.Query

getHints

public Map<String,Object> getHints()

Specified by:

getHints in interface javax.persistence.Query

setHint

public StoredProcedureQuery setHint(String hintName,
                           Object value)

Description copied from interface: StoredProcedureQuery

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, this hint may or may not be observed.

Specified by:

setHint in interface StoredProcedureQuery

Specified by:

setHint in interface javax.persistence.Query

Parameters:

hintName - name of the property or hint

value - value for the property or hint

Returns:

the same query instance

getParameter

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

Specified by:

getParameter in interface javax.persistence.Query

getParameter

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

Specified by:

getParameter in interface javax.persistence.Query

getParameter

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

Specified by:

getParameter in interface javax.persistence.Query

getParameter

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

Specified by:

getParameter in interface javax.persistence.Query

getParameters

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

Specified by:

getParameters in interface javax.persistence.Query

getParameterValue

public Object getParameterValue(int position)

Specified by:

getParameterValue in interface javax.persistence.Query

getParameterValue

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

Specified by:

getParameterValue in interface javax.persistence.Query

getParameterValue

public Object getParameterValue(String name)

Specified by:

getParameterValue in interface javax.persistence.Query

isBound

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

Specified by:

isBound in interface javax.persistence.Query

unwrap

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

Specified by:

unwrap in interface javax.persistence.Query

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind the value of a Parameter object.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Calendar to a Parameter object.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param - parameter object

cal - parameter value

type - temporal type

Returns:

the same query instance

setParameter

public StoredProcedureQuery setParameter(javax.persistence.Parameter<Date> param,
                                Date date,
                                javax.persistence.TemporalType type)

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Date to a Parameter object.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param - parameter object

date - parameter value

type - temporal type

Returns:

the same query instance

setParameter

public StoredProcedureQuery setParameter(String name,
                                Object value)

Description copied from interface: StoredProcedureQuery

Bind an argument to a named parameter.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Calendar to a named parameter.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Date to a named parameter.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

public StoredProcedureQuery setParameter(int position,
                                Object value)

Description copied from interface: StoredProcedureQuery

Bind an argument to a positional parameter.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position - position

value - parameter value

Returns:

the same query instance

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Calendar to a positional parameter.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Date to a positional parameter.

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

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

getOutputParameterValue

public Object getOutputParameterValue(int position)

Description copied from interface: StoredProcedureQuery

Used to retrieve the values passed back from the procedure through INOUT and OUT parameters. 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

Used to retrieve the values passed back from the procedure through INOUT and OUT parameters. 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

execute

public boolean execute()

Description copied from interface: StoredProcedureQuery

Returns 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

hasMoreResults

public boolean hasMoreResults()

Description copied from interface: StoredProcedureQuery

Returns 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

Returns 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

executeUpdate

public int executeUpdate()

Specified by:

executeUpdate in interface javax.persistence.Query

getResultList

public List getResultList()

Specified by:

getResultList in interface javax.persistence.Query

getSingleResult

public Object getSingleResult()

Specified by:

getSingleResult in interface javax.persistence.Query

getFirstResult

public int getFirstResult()

Specified by:

getFirstResult 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

setMaxResults

public javax.persistence.Query setMaxResults(int max)

Specified by:

setMaxResults in interface javax.persistence.Query