|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.openjpa.persistence.QueryImpl<X>
public class QueryImpl<X>
Implementation of Query
interface.
Field Summary |
---|
Fields inherited from interface org.apache.openjpa.persistence.OpenJPAQuery |
---|
FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION, HINT_RESULT_COUNT, OP_DELETE, OP_SELECT, OP_UPDATE |
Constructor Summary | |
---|---|
QueryImpl(EntityManagerImpl em,
Query query)
Deprecated. |
|
QueryImpl(EntityManagerImpl em,
RuntimeExceptionTranslator ret,
Query query)
Constructor; supply factory exception translator and delegate. |
Method Summary | ||
---|---|---|
OpenJPAQuery<X> |
addAggregateListener(AggregateListener listener)
Register an aggregate listener for the query. |
|
OpenJPAQuery<X> |
addFilterListener(FilterListener listener)
Register a filter listener for the query. |
|
OpenJPAQuery<X> |
closeAll()
Close all open query results. |
|
OpenJPAQuery<X> |
compile()
Compile the query. |
|
void |
declareParameter(java.lang.Object key,
javax.persistence.Parameter<?> param)
Declares the given parameter for this query. |
|
boolean |
equals(java.lang.Object other)
|
|
int |
executeUpdate()
|
|
java.util.Set<?> |
getBoundParameterKeys()
Gets the parameter keys bound with this query. |
|
java.util.Collection<?> |
getCandidateCollection()
Return the candidate collection, or null if an
extent was specified instead of a collection. |
|
java.lang.String[] |
getDataStoreActions(java.util.Map params)
Returns a description of the commands that will be sent to the datastore in order to execute this query. |
|
java.util.Set<?> |
getDeclaredParameterKeys()
Gets the declared parameter keys in the given query. |
|
|
getDeclaredParameterKeys(java.lang.Class<T> keyType)
|
|
java.util.Map<java.lang.Object,javax.persistence.Parameter<?>> |
getDeclaredParameters()
Gets the parameter instances declared in this query. |
|
Query |
getDelegate()
Delegate. |
|
OpenJPAEntityManager |
getEntityManager()
The owning entity manager. |
|
FetchPlan |
getFetchPlan()
Fetch plan for controlling the loading of results. |
|
int |
getFirstResult()
Return the 0-based start index for the returned results. |
|
javax.persistence.FlushModeType |
getFlushMode()
Return the current flush mode. |
|
java.util.Map<java.lang.String,java.lang.Object> |
getHints()
Get all the active hints and their values. |
|
boolean |
getIgnoreChanges()
Whether to ignore changes in the current transaction. |
|
java.lang.String |
getLanguage()
Query language. |
|
javax.persistence.LockModeType |
getLockMode()
|
|
int |
getMaxResults()
Return the maximum number of results to retrieve. |
|
java.util.Map<java.lang.String,java.lang.Object> |
getNamedParameters()
Gets the value of all the named parameters. |
|
QueryOperationType |
getOperation()
Query operation type. |
|
javax.persistence.Parameter<?> |
getParameter(int pos)
Get the positional parameter with the given position. |
|
|
getParameter(int pos,
java.lang.Class<T> type)
Get the positional parameter with the given position and type. |
|
javax.persistence.Parameter<?> |
getParameter(java.lang.String name)
Get the parameter object corresponding to the declared parameter of the given name. |
|
|
getParameter(java.lang.String name,
java.lang.Class<T> type)
Get the parameter of the given name and type. |
|
java.util.Set<javax.persistence.Parameter<?>> |
getParameters()
Gets the parameters declared in this query. |
|
java.lang.Object |
getParameterValue(int pos)
Return the value bound to the parameter. |
|
|
getParameterValue(javax.persistence.Parameter<T> p)
Return the value bound to the parameter. |
|
java.lang.Object |
getParameterValue(java.lang.String name)
Return the value bound to the parameter. |
|
java.lang.Object[] |
getPositionalParameters()
Gets the array of positional parameter values. |
|
java.lang.String |
getQueryString()
Query string. |
|
java.lang.Class |
getResultClass()
Query result element type. |
|
java.util.List |
getResultList()
|
|
X |
getSingleResult()
Execute a query that returns a single result. |
|
java.util.Set<java.lang.String> |
getSupportedHints()
Gets hints supported by this query. |
|
int |
hashCode()
|
|
boolean |
hasPositionalParameters()
Affirms if declared parameters use position identifier. |
|
boolean |
hasSubclasses()
Whether subclasses are included in the query results. |
|
boolean |
isBound(javax.persistence.Parameter<?> param)
Affirms if the given parameter is bound to a value for this query. |
|
boolean |
isNative()
|
|
OpenJPAQuery<X> |
removeAggregateListener(AggregateListener listener)
Remove an aggregate listener from the query. |
|
OpenJPAQuery<X> |
removeFilterListener(FilterListener listener)
Remove a filter listener from the query. |
|
OpenJPAQuery<X> |
setCandidateCollection(java.util.Collection coll)
Set a collection of candidates. |
|
OpenJPAQuery<X> |
setFirstResult(int startPosition)
|
|
OpenJPAQuery<X> |
setFlushMode(javax.persistence.FlushModeType flushMode)
|
|
OpenJPAQuery<X> |
setHint(java.lang.String key,
java.lang.Object value)
|
|
OpenJPAQuery<X> |
setIgnoreChanges(boolean ignore)
Whether to ignore changes in the current transaction. |
|
javax.persistence.TypedQuery<X> |
setLockMode(javax.persistence.LockModeType lockMode)
Sets lock mode on the given query. |
|
OpenJPAQuery<X> |
setMaxResults(int max)
|
|
OpenJPAQuery<X> |
setParameter(int position,
java.util.Calendar value,
javax.persistence.TemporalType t)
Sets the value of the given positional parameter after conversion of the given value to the given Temporal Type. |
|
OpenJPAQuery<X> |
setParameter(int position,
java.util.Date value,
javax.persistence.TemporalType type)
Sets the value of the given named parameter after conversion of the given value to the given Temporal Type. |
|
OpenJPAQuery<X> |
setParameter(int pos,
java.lang.Object value)
Binds the parameter identified by the given position to the given value. |
|
javax.persistence.TypedQuery<X> |
setParameter(javax.persistence.Parameter<java.util.Calendar> p,
java.util.Calendar cal,
javax.persistence.TemporalType type)
|
|
OpenJPAQuery<X> |
setParameter(javax.persistence.Parameter<java.util.Date> p,
java.util.Date date,
javax.persistence.TemporalType type)
|
|
|
setParameter(javax.persistence.Parameter<T> p,
T arg1)
|
|
OpenJPAQuery<X> |
setParameter(java.lang.String name,
java.util.Calendar value,
javax.persistence.TemporalType type)
|
|
OpenJPAQuery<X> |
setParameter(java.lang.String name,
java.util.Date value,
javax.persistence.TemporalType type)
|
|
OpenJPAQuery<X> |
setParameter(java.lang.String name,
java.lang.Object value)
Sets the parameter of the given name to the given value. |
|
OpenJPAQuery<X> |
setParameters(java.util.Map params)
Sets the values of the parameters from the given Map. |
|
OpenJPAQuery<X> |
setParameters(java.lang.Object... params)
Binds the given values as positional parameters. |
|
OpenJPAQuery<X> |
setResultClass(java.lang.Class cls)
Query result element type. |
|
OpenJPAQuery<X> |
setSubclasses(boolean subs)
Whether subclasses are included in the query results. |
|
java.lang.String |
toString()
|
|
|
unwrap(java.lang.Class<T> cls)
Unwraps this receiver to an instance of the given class, if possible. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public QueryImpl(EntityManagerImpl em, RuntimeExceptionTranslator ret, Query query)
em
- The EntityManager which created this queryret
- Exception translator for this queryquery
- The underlying "kernel" query.public QueryImpl(EntityManagerImpl em, Query query)
Method Detail |
---|
public Query getDelegate()
public OpenJPAEntityManager getEntityManager()
OpenJPAQuery
getEntityManager
in interface OpenJPAQuery<X>
public java.lang.String getLanguage()
OpenJPAQuery
getLanguage
in interface OpenJPAQuery<X>
public QueryOperationType getOperation()
OpenJPAQuery
getOperation
in interface OpenJPAQuery<X>
public FetchPlan getFetchPlan()
OpenJPAQuery
getFetchPlan
in interface OpenJPAQuery<X>
public java.lang.String getQueryString()
OpenJPAQuery
getQueryString
in interface OpenJPAQuery<X>
public boolean getIgnoreChanges()
OpenJPAQuery
getIgnoreChanges
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setIgnoreChanges(boolean ignore)
OpenJPAQuery
setIgnoreChanges
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> addFilterListener(FilterListener listener)
OpenJPAQuerySPI
addFilterListener
in interface OpenJPAQuery<X>
addFilterListener
in interface OpenJPAQuerySPI<X>
public OpenJPAQuery<X> removeFilterListener(FilterListener listener)
OpenJPAQuerySPI
removeFilterListener
in interface OpenJPAQuery<X>
removeFilterListener
in interface OpenJPAQuerySPI<X>
public OpenJPAQuery<X> addAggregateListener(AggregateListener listener)
OpenJPAQuerySPI
addAggregateListener
in interface OpenJPAQuery<X>
addAggregateListener
in interface OpenJPAQuerySPI<X>
public OpenJPAQuery<X> removeAggregateListener(AggregateListener listener)
OpenJPAQuerySPI
removeAggregateListener
in interface OpenJPAQuery<X>
removeAggregateListener
in interface OpenJPAQuerySPI<X>
public java.util.Collection<?> getCandidateCollection()
OpenJPAQuery
null
if an
extent was specified instead of a collection.
getCandidateCollection
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setCandidateCollection(java.util.Collection coll)
OpenJPAQuery
setCandidateCollection
in interface OpenJPAQuery<X>
public java.lang.Class getResultClass()
OpenJPAQuery
getResultClass
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setResultClass(java.lang.Class cls)
OpenJPAQuery
setResultClass
in interface OpenJPAQuery<X>
public boolean hasSubclasses()
OpenJPAQuery
hasSubclasses
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setSubclasses(boolean subs)
OpenJPAQuery
setSubclasses
in interface OpenJPAQuery<X>
public int getFirstResult()
OpenJPAQuery
getFirstResult
in interface javax.persistence.Query
getFirstResult
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setFirstResult(int startPosition)
setFirstResult
in interface javax.persistence.Query
setFirstResult
in interface javax.persistence.TypedQuery<X>
setFirstResult
in interface OpenJPAQuery<X>
public int getMaxResults()
OpenJPAQuery
Integer.MAX_VALUE
for no limit.
getMaxResults
in interface javax.persistence.Query
getMaxResults
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setMaxResults(int max)
setMaxResults
in interface javax.persistence.Query
setMaxResults
in interface javax.persistence.TypedQuery<X>
setMaxResults
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> compile()
OpenJPAQuery
compile
in interface OpenJPAQuery<X>
public java.util.List getResultList()
getResultList
in interface javax.persistence.Query
getResultList
in interface javax.persistence.TypedQuery<X>
public X getSingleResult()
getSingleResult
in interface javax.persistence.Query
getSingleResult
in interface javax.persistence.TypedQuery<X>
public int executeUpdate()
executeUpdate
in interface javax.persistence.Query
public javax.persistence.FlushModeType getFlushMode()
OpenJPAQuery
getFlushMode
in interface javax.persistence.Query
getFlushMode
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setFlushMode(javax.persistence.FlushModeType flushMode)
setFlushMode
in interface javax.persistence.Query
setFlushMode
in interface javax.persistence.TypedQuery<X>
setFlushMode
in interface OpenJPAQuery<X>
public boolean isNative()
public OpenJPAQuery<X> closeAll()
OpenJPAQuery
closeAll
in interface OpenJPAQuery<X>
public java.lang.String[] getDataStoreActions(java.util.Map params)
OpenJPAQuery
getDataStoreActions
in interface OpenJPAQuery<X>
params
- the named parameter map for the query invocationpublic javax.persistence.LockModeType getLockMode()
getLockMode
in interface javax.persistence.Query
public javax.persistence.TypedQuery<X> setLockMode(javax.persistence.LockModeType lockMode)
setLockMode
in interface javax.persistence.Query
setLockMode
in interface javax.persistence.TypedQuery<X>
ignorePreparedQuery()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public java.util.Map<java.lang.String,java.lang.Object> getHints()
getHints
in interface javax.persistence.Query
public OpenJPAQuery<X> setHint(java.lang.String key, java.lang.Object value)
setHint
in interface javax.persistence.Query
setHint
in interface javax.persistence.TypedQuery<X>
setHint
in interface OpenJPAQuery<X>
public java.util.Set<java.lang.String> getSupportedHints()
OpenJPAQuery
getSupportedHints
in interface OpenJPAQuery<X>
public <T> T unwrap(java.lang.Class<T> cls)
unwrap
in interface javax.persistence.Query
if
- the given class is null, generic Object.class
or a class
that is not wrapped by this receiver.public OpenJPAQuery<X> setParameter(int pos, java.lang.Object value)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
setParameter
in interface OpenJPAQuery<X>
position
- positive, integer position of the parametervalue
- an assignment compatible value
java.lang.IllegalArgumentException
- if position does not correspond to a positional
parameter of the query or if the argument is of incorrect typepublic OpenJPAQuery<X> setParameter(int position, java.util.Calendar value, javax.persistence.TemporalType t)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
setParameter
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setParameter(int position, java.util.Date value, javax.persistence.TemporalType type)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
setParameter
in interface OpenJPAQuery<X>
public boolean hasPositionalParameters()
hasPositionalParameters
in interface OpenJPAQuery<X>
public java.lang.Object[] getPositionalParameters()
getPositionalParameters
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setParameters(java.lang.Object... params)
setParameters
in interface OpenJPAQuery<X>
public java.util.Map<java.lang.String,java.lang.Object> getNamedParameters()
getNamedParameters
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setParameters(java.util.Map params)
setParameters
in interface OpenJPAQuery<X>
public <T> javax.persistence.Parameter<T> getParameter(java.lang.String name, java.lang.Class<T> type)
getParameter
in interface javax.persistence.Query
java.lang.IllegalArgumentException
- if the parameter of the
specified name does not exist or is not assignable
to the type
java.lang.IllegalStateException
- if invoked on a native querypublic <T> javax.persistence.Parameter<T> getParameter(int pos, java.lang.Class<T> type)
getParameter
in interface javax.persistence.Query
java.lang.IllegalArgumentException
- if the parameter with the
specified position does not exist or is not assignable
to the type
java.lang.IllegalStateException
- if invoked on a native query unless
the same parameter position is bound already.public <T> T getParameterValue(javax.persistence.Parameter<T> p)
getParameterValue
in interface javax.persistence.Query
param
- parameter object
java.lang.IllegalStateException
- if the parameter has not been been bound
java.lang.IllegalArgumentException
- if the parameter does not belong to this querypublic java.util.Set<javax.persistence.Parameter<?>> getParameters()
getParameters
in interface javax.persistence.Query
public <T> OpenJPAQuery<X> setParameter(javax.persistence.Parameter<T> p, T arg1)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
public OpenJPAQuery<X> setParameter(javax.persistence.Parameter<java.util.Date> p, java.util.Date date, javax.persistence.TemporalType type)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
public javax.persistence.TypedQuery<X> setParameter(javax.persistence.Parameter<java.util.Calendar> p, java.util.Calendar cal, javax.persistence.TemporalType type)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
public javax.persistence.Parameter<?> getParameter(java.lang.String name)
getParameter
in interface javax.persistence.Query
java.lang.IllegalArgumentException
- if the parameter of the specified name does not exist
java.lang.IllegalStateException
- if invoked on a native querypublic javax.persistence.Parameter<?> getParameter(int pos)
getParameter
in interface javax.persistence.Query
position
- specified in the user query.
java.lang.IllegalArgumentException
- if the parameter with the given position does not existpublic java.lang.Object getParameterValue(java.lang.String name)
getParameterValue
in interface javax.persistence.Query
name
- name of the parameter
java.lang.IllegalStateException
- if this parameter has not been boundpublic java.lang.Object getParameterValue(int pos)
getParameterValue
in interface javax.persistence.Query
pos
- position of the parameter
java.lang.IllegalStateException
- if this parameter has not been boundpublic java.util.Set<?> getBoundParameterKeys()
public java.util.Set<?> getDeclaredParameterKeys()
public <T> java.util.Set<T> getDeclaredParameterKeys(java.lang.Class<T> keyType)
public java.util.Map<java.lang.Object,javax.persistence.Parameter<?>> getDeclaredParameters()
public void declareParameter(java.lang.Object key, javax.persistence.Parameter<?> param)
key
- this is the key to identify the parameter later in the context of this query.
Valid key types are Integer, String or ParameterExpression itself.the
- parameter instance to be declaredpublic boolean isBound(javax.persistence.Parameter<?> param)
isBound
in interface javax.persistence.Query
public OpenJPAQuery<X> setParameter(java.lang.String name, java.util.Calendar value, javax.persistence.TemporalType type)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
setParameter
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType type)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
setParameter
in interface OpenJPAQuery<X>
public OpenJPAQuery<X> setParameter(java.lang.String name, java.lang.Object value)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
setParameter
in interface OpenJPAQuery<X>
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |