|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OpenJPAQuery<X>
Interface implemented by OpenJPA queries.
Field Summary | |
---|---|
static int |
FLUSH_FALSE
Deprecated. use the FlushModeType enum instead. |
static int |
FLUSH_TRUE
Deprecated. use the FlushModeType enum instead. |
static int |
FLUSH_WITH_CONNECTION
Deprecated. use the FlushModeType enum instead. |
static java.lang.String |
HINT_RESULT_COUNT
Hint key for specifying the number of rows to optimize for. |
static int |
OP_DELETE
Deprecated. use the QueryOperationType instead. |
static int |
OP_SELECT
Deprecated. use the QueryOperationType instead. |
static int |
OP_UPDATE
Deprecated. use the QueryOperationType instead. |
Method Summary | |
---|---|
OpenJPAQuery<X> |
addAggregateListener(AggregateListener listener)
Deprecated. cast to QueryImpl instead. This
method pierces the published-API boundary, as does the SPI cast. |
OpenJPAQuery<X> |
addFilterListener(FilterListener listener)
Deprecated. cast to QueryImpl instead. This
method pierces the published-API boundary, as does the SPI cast. |
OpenJPAQuery<X> |
closeAll()
Close all open query results. |
OpenJPAQuery<X> |
compile()
Compile the 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. |
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. |
boolean |
getIgnoreChanges()
Whether to ignore changes in the current transaction. |
java.lang.String |
getLanguage()
Query language. |
int |
getMaxResults()
Return the maximum number of results to retrieve. |
java.util.Map<java.lang.String,java.lang.Object> |
getNamedParameters()
The named parameters for the query; empty map if none or if query uses positional parameters. |
QueryOperationType |
getOperation()
Query operation type. |
java.lang.Object[] |
getPositionalParameters()
The positional parameters for the query; empty array if none or if query uses named parameters. |
java.lang.String |
getQueryString()
Query string. |
java.lang.Class |
getResultClass()
Query result element type. |
java.util.Set<java.lang.String> |
getSupportedHints()
Gets hints supported by this query. |
boolean |
hasPositionalParameters()
Whether this query has positional parameters. |
boolean |
hasSubclasses()
Whether subclasses are included in the query results. |
OpenJPAQuery<X> |
removeAggregateListener(AggregateListener listener)
Deprecated. cast to QueryImpl instead. This
method pierces the published-API boundary, as does the SPI cast. |
OpenJPAQuery<X> |
removeFilterListener(FilterListener listener)
Deprecated. cast to QueryImpl instead. This
method pierces the published-API boundary, as does the SPI cast. |
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 hintName,
java.lang.Object value)
|
OpenJPAQuery<X> |
setIgnoreChanges(boolean ignore)
Whether to ignore changes in the current transaction. |
OpenJPAQuery<X> |
setMaxResults(int maxResult)
|
OpenJPAQuery<X> |
setParameter(int position,
java.util.Calendar value,
javax.persistence.TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(int position,
java.util.Date value,
javax.persistence.TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(int position,
java.lang.Object value)
|
OpenJPAQuery<X> |
setParameter(java.lang.String name,
java.util.Calendar value,
javax.persistence.TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(java.lang.String name,
java.util.Date value,
javax.persistence.TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(java.lang.String name,
java.lang.Object value)
|
OpenJPAQuery<X> |
setParameters(java.util.Map params)
Set parameters. |
OpenJPAQuery<X> |
setParameters(java.lang.Object... params)
Set parameters. |
OpenJPAQuery<X> |
setResultClass(java.lang.Class type)
Query result element type. |
OpenJPAQuery<X> |
setSubclasses(boolean subs)
Whether subclasses are included in the query results. |
Methods inherited from interface javax.persistence.TypedQuery |
---|
getResultList, getSingleResult, setLockMode, setParameter, setParameter, setParameter |
Methods inherited from interface javax.persistence.Query |
---|
executeUpdate, getHints, getLockMode, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap |
Field Detail |
---|
static final java.lang.String HINT_RESULT_COUNT
static final int OP_SELECT
QueryOperationType
instead.static final int OP_DELETE
QueryOperationType
instead.static final int OP_UPDATE
QueryOperationType
instead.static final int FLUSH_TRUE
FlushModeType
enum instead.static final int FLUSH_FALSE
FlushModeType
enum instead.static final int FLUSH_WITH_CONNECTION
FlushModeType
enum instead.Method Detail |
---|
OpenJPAEntityManager getEntityManager()
java.lang.String getLanguage()
QueryOperationType getOperation()
FetchPlan getFetchPlan()
java.lang.String getQueryString()
boolean getIgnoreChanges()
OpenJPAQuery<X> setIgnoreChanges(boolean ignore)
java.util.Collection getCandidateCollection()
null
if an
extent was specified instead of a collection.
OpenJPAQuery<X> setCandidateCollection(java.util.Collection coll)
java.lang.Class getResultClass()
OpenJPAQuery<X> setResultClass(java.lang.Class type)
boolean hasSubclasses()
OpenJPAQuery<X> setSubclasses(boolean subs)
int getFirstResult()
getFirstResult
in interface javax.persistence.Query
int getMaxResults()
Integer.MAX_VALUE
for no limit.
getMaxResults
in interface javax.persistence.Query
OpenJPAQuery<X> compile()
boolean hasPositionalParameters()
java.lang.Object[] getPositionalParameters()
java.util.Map<java.lang.String,java.lang.Object> getNamedParameters()
OpenJPAQuery<X> setParameters(java.util.Map params)
OpenJPAQuery<X> setParameters(java.lang.Object... params)
OpenJPAQuery<X> closeAll()
java.lang.String[] getDataStoreActions(java.util.Map params)
params
- the named parameter map for the query invocationOpenJPAQuery<X> setMaxResults(int maxResult)
setMaxResults
in interface javax.persistence.Query
setMaxResults
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setFirstResult(int startPosition)
setFirstResult
in interface javax.persistence.Query
setFirstResult
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setHint(java.lang.String hintName, java.lang.Object value)
setHint
in interface javax.persistence.Query
setHint
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setParameter(java.lang.String name, java.lang.Object value)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setParameter(java.lang.String name, java.util.Calendar value, javax.persistence.TemporalType temporalType)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setParameter(int position, java.lang.Object value)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setParameter(int position, java.util.Date value, javax.persistence.TemporalType temporalType)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setParameter(int position, java.util.Calendar value, javax.persistence.TemporalType temporalType)
setParameter
in interface javax.persistence.Query
setParameter
in interface javax.persistence.TypedQuery<X>
OpenJPAQuery<X> setFlushMode(javax.persistence.FlushModeType flushMode)
setFlushMode
in interface javax.persistence.Query
setFlushMode
in interface javax.persistence.TypedQuery<X>
javax.persistence.FlushModeType getFlushMode()
getFlushMode
in interface javax.persistence.Query
OpenJPAQuery<X> addFilterListener(FilterListener listener)
QueryImpl
instead. This
method pierces the published-API boundary, as does the SPI cast.
OpenJPAQuery<X> removeFilterListener(FilterListener listener)
QueryImpl
instead. This
method pierces the published-API boundary, as does the SPI cast.
OpenJPAQuery<X> addAggregateListener(AggregateListener listener)
QueryImpl
instead. This
method pierces the published-API boundary, as does the SPI cast.
OpenJPAQuery<X> removeAggregateListener(AggregateListener listener)
QueryImpl
instead. This
method pierces the published-API boundary, as does the SPI cast.
java.util.Set<java.lang.String> getSupportedHints()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |