JtaQuery

java.lang.Object
- org.apache.openejb.persistence.JtaQuery

All Implemented Interfaces:

Query

Direct Known Subclasses:

JtaTypedQuery
```
public class JtaQuery
extends java.lang.Object
implements Query
```
The JtaQuery is a wrapper around a query and and entity manager that automatically closes the entity managers when the query is finished. This implementation is only for non-transaction queryies

Constructor Summary

Constructors
Constructor and Description
`JtaQuery(EntityManager entityManager, JtaEntityManager jtaEntityManager, java.lang.reflect.Method method, java.lang.Object... args)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`executeUpdate()` Execute an update or delete statement.
`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.
`java.util.Map<java.lang.String,java.lang.Object>`	`getHints()` Get the properties and hints and associated values that are in effect for the query instance.
`LockModeType`	`getLockMode()` Get the current lock mode for the query.
`int`	`getMaxResults()` The maximum number of results the query object was set to retrieve.
`Parameter<?>`	`getParameter(int position)` Get the parameter object corresponding to the declared positional parameter with the given position.
`<T> Parameter<T>`	`getParameter(int position, java.lang.Class<T> type)` Get the parameter object corresponding to the declared positional parameter with the given position and type.
`Parameter<?>`	`getParameter(java.lang.String name)` Get the parameter object corresponding to the declared parameter of the given name.
`<T> Parameter<T>`	`getParameter(java.lang.String name, java.lang.Class<T> type)` Get the parameter object corresponding to the declared parameter of the given name and type.
`java.util.Set<Parameter<?>>`	`getParameters()` Get the parameter objects corresponding to the declared parameters of the query.
`java.lang.Object`	`getParameterValue(int position)` Return the input value bound to the positional parameter.
`<T> T`	`getParameterValue(Parameter<T> param)` Return the input value bound to the parameter.
`java.lang.Object`	`getParameterValue(java.lang.String name)` Return the input value bound to the named parameter.
`java.util.List`	`getResultList()` Execute a SELECT query and return the query results as an untyped List.
`java.lang.Object`	`getSingleResult()` Execute a SELECT query that returns a single untyped result.
`boolean`	`isBound(Parameter<?> param)` Return a boolean indicating whether a value has been bound to the parameter.
`protected java.lang.Class<? extends Query>`	`queryType()`
`Query`	`setFirstResult(int i)` Set the position of the first result to retrieve.
`Query`	`setFlushMode(FlushModeType flushModeType)` Set the flush mode type to be used for the query execution.
`Query`	`setHint(java.lang.String s, java.lang.Object o)` Set a query property or hint.
`Query`	`setLockMode(LockModeType lockMode)` Set the lock mode type to be used for the query execution.
`Query`	`setMaxResults(int i)` Set the maximum number of results to retrieve.
`Query`	`setParameter(int i, java.util.Calendar calendar, TemporalType temporalType)` Bind an instance of `java.util.Calendar` to a positional parameter.
`Query`	`setParameter(int i, java.util.Date date, TemporalType temporalType)` Bind an instance of `java.util.Date` to a positional parameter.
`Query`	`setParameter(int i, java.lang.Object o)` Bind an argument value to a positional parameter.
`Query`	`setParameter(Parameter<java.util.Calendar> param, java.util.Calendar value, TemporalType temporalType)` Bind an instance of `java.util.Calendar` to a `Parameter` object.
`Query`	`setParameter(Parameter<java.util.Date> param, java.util.Date value, TemporalType temporalType)` Bind an instance of `java.util.Date` to a `Parameter` object.
`<T> Query`	`setParameter(Parameter<T> param, T value)` Bind the value of a `Parameter` object.
`Query`	`setParameter(java.lang.String s, java.util.Calendar calendar, TemporalType temporalType)` Bind an instance of `java.util.Calendar` to a named parameter.
`Query`	`setParameter(java.lang.String s, java.util.Date date, TemporalType temporalType)` Bind an instance of `java.util.Date` to a named parameter.
`Query`	`setParameter(java.lang.String s, java.lang.Object o)` Bind an argument value to a named parameter.
`<T> T`	`unwrap(java.lang.Class<T> cls)` Return an object of the specified type to allow access to the provider-specific API.

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
getResultStream

- Constructor Detail
  - JtaQuery
```
public JtaQuery(EntityManager entityManager,
                JtaEntityManager jtaEntityManager,
                java.lang.reflect.Method method,
                java.lang.Object... args)
```
- Method Detail
  - queryType
```
protected java.lang.Class<? extends Query> queryType()
```
  - getResultList
```
public java.util.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 java.lang.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
  - 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
  - setMaxResults
```
public Query setMaxResults(int i)
```
    Description copied from interface: Query
    
    Set the maximum number of results to retrieve.
    
    Specified by:
    
    setMaxResults in interface Query
    
    Parameters:
    
    i - maximum number of results to retrieve
    
    Returns:
    
    the same query instance
  - setFirstResult
```
public Query setFirstResult(int i)
```
    Description copied from interface: Query
    
    Set the position of the first result to retrieve.
    
    Specified by:
    
    setFirstResult in interface Query
    
    Parameters:
    
    i - position of the first result, numbered from 0
    
    Returns:
    
    the same query instance
  - setFlushMode
```
public Query setFlushMode(FlushModeType flushModeType)
```
    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
    
    Parameters:
    
    flushModeType - flush mode
    
    Returns:
    
    the same query instance
  - setHint
```
public Query setHint(java.lang.String s,
                     java.lang.Object o)
```
    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
    
    Parameters:
    
    s - name of the property or hint
    
    o - value for the property or hint
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(java.lang.String s,
                          java.lang.Object o)
```
    Description copied from interface: Query
    
    Bind an argument value to a named parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    s - parameter name
    
    o - parameter value
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(java.lang.String s,
                          java.util.Date date,
                          TemporalType temporalType)
```
    Description copied from interface: Query
    
    Bind an instance of java.util.Date to a named parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    s - parameter name
    
    date - parameter value
    
    temporalType - temporal type
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(java.lang.String s,
                          java.util.Calendar calendar,
                          TemporalType temporalType)
```
    Description copied from interface: Query
    
    Bind an instance of java.util.Calendar to a named parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    s - parameter name
    
    calendar - parameter value
    
    temporalType - temporal type
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(int i,
                          java.lang.Object o)
```
    Description copied from interface: Query
    
    Bind an argument value to a positional parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    i - position
    
    o - parameter value
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(int i,
                          java.util.Date date,
                          TemporalType temporalType)
```
    Description copied from interface: Query
    
    Bind an instance of java.util.Date to a positional parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    i - position
    
    date - parameter value
    
    temporalType - temporal type
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(int i,
                          java.util.Calendar calendar,
                          TemporalType temporalType)
```
    Description copied from interface: Query
    
    Bind an instance of java.util.Calendar to a positional parameter.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    i - position
    
    calendar - parameter value
    
    temporalType - temporal type
    
    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
  - 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
  - getHints
```
public java.util.Map<java.lang.String,java.lang.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
  - getLockMode
```
public LockModeType getLockMode()
```
    Description copied from interface: Query
    
    Get the current lock mode for the query. Returns null if a lock mode has not been set on the query object.
    
    Specified by:
    
    getLockMode in interface Query
    
    Returns:
    
    lock mode
  - 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
  - getParameter
```
public Parameter<?> getParameter(java.lang.String name)
```
    Description copied from interface: Query
    
    Get the parameter object corresponding to the declared parameter of the given name. This method is not required to be supported for native queries.
    
    Specified by:
    
    getParameter in interface Query
    
    Parameters:
    
    name - parameter name
    
    Returns:
    
    parameter object
  - getParameter
```
public Parameter<?> getParameter(int position)
```
    Description copied from interface: Query
    
    Get the parameter object corresponding to the declared positional parameter with the given position. This method is not required to be supported for native queries.
    
    Specified by:
    
    getParameter in interface Query
    
    Parameters:
    
    position - position
    
    Returns:
    
    parameter object
  - getParameter
```
public <T> Parameter<T> getParameter(java.lang.String name,
                                     java.lang.Class<T> type)
```
    Description copied from interface: Query
    
    Get the parameter object corresponding to the declared parameter of the given name and type. This method is required to be supported for criteria queries only.
    
    Specified by:
    
    getParameter in interface Query
    
    Parameters:
    
    name - parameter name
    
    type - type
    
    Returns:
    
    parameter object
  - getParameter
```
public <T> Parameter<T> getParameter(int position,
                                     java.lang.Class<T> type)
```
    Description copied from interface: Query
    
    Get the parameter object corresponding to the declared positional parameter with the given position and type. This method is not required to be supported by the provider.
    
    Specified by:
    
    getParameter in interface Query
    
    Parameters:
    
    position - position
    
    type - type
    
    Returns:
    
    parameter object
  - getParameterValue
```
public <T> T getParameterValue(Parameter<T> param)
```
    Description copied from interface: Query
    
    Return the input value bound to the parameter. (Note that OUT parameters are unbound.)
    
    Specified by:
    
    getParameterValue in interface Query
    
    Parameters:
    
    param - parameter object
    
    Returns:
    
    parameter value
  - getParameterValue
```
public java.lang.Object getParameterValue(java.lang.String name)
```
    Description copied from interface: Query
    
    Return the input value bound to the named parameter. (Note that OUT parameters are unbound.)
    
    Specified by:
    
    getParameterValue in interface Query
    
    Parameters:
    
    name - parameter name
    
    Returns:
    
    parameter value
  - getParameterValue
```
public java.lang.Object getParameterValue(int position)
```
    Description copied from interface: Query
    
    Return the input value bound to the positional parameter. (Note that OUT parameters are unbound.)
    
    Specified by:
    
    getParameterValue in interface Query
    
    Parameters:
    
    position - position
    
    Returns:
    
    parameter value
  - getParameters
```
public java.util.Set<Parameter<?>> getParameters()
```
    Description copied from interface: Query
    
    Get the parameter objects corresponding to the declared parameters of the query. Returns empty set if the query has no parameters. This method is not required to be supported for native queries.
    
    Specified by:
    
    getParameters in interface Query
    
    Returns:
    
    set of the parameter objects
  - 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
  - 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
  - setParameter
```
public <T> Query setParameter(Parameter<T> param,
                              T value)
```
    Description copied from interface: Query
    
    Bind the value of a Parameter object.
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    param - parameter object
    
    value - parameter value
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(Parameter<java.util.Calendar> param,
                          java.util.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
    
    Parameters:
    
    param - parameter object
    
    value - parameter value
    
    temporalType - temporal type
    
    Returns:
    
    the same query instance
  - setParameter
```
public Query setParameter(Parameter<java.util.Date> param,
                          java.util.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
    
    Parameters:
    
    param - parameter object
    
    value - parameter value
    
    temporalType - temporal type
    
    Returns:
    
    the same query instance
  - unwrap
```
public <T> T unwrap(java.lang.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

Class JtaQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface javax.persistence.Query

Constructor Detail

JtaQuery

Method Detail

queryType

getResultList

getSingleResult

executeUpdate

setMaxResults

setFirstResult

setFlushMode

setHint

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

getFirstResult

getFlushMode

getHints

getLockMode

getMaxResults

getParameter

getParameter

getParameter

getParameter

getParameterValue

getParameterValue

getParameterValue

getParameters

isBound

setLockMode

setParameter

setParameter

setParameter

unwrap