|
||||||||||
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 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. |
Collection |
getCandidateCollection()
Return the candidate collection, or null if an
extent was specified instead of a collection. |
String[] |
getDataStoreActions(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. |
FlushModeType |
getFlushMode()
Return the current flush mode. |
boolean |
getIgnoreChanges()
Whether to ignore changes in the current transaction. |
String |
getLanguage()
Query language. |
int |
getMaxResults()
Return the maximum number of results to retrieve. |
Map<String,Object> |
getNamedParameters()
The named parameters for the query; empty map if none or if query uses positional parameters. |
QueryOperationType |
getOperation()
Query operation type. |
Object[] |
getPositionalParameters()
The positional parameters for the query; empty array if none or if query uses named parameters. |
String |
getQueryString()
Query string. |
Class |
getResultClass()
Query result element type. |
Set<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(Collection coll)
Set a collection of candidates. |
OpenJPAQuery<X> |
setFirstResult(int startPosition)
|
OpenJPAQuery<X> |
setFlushMode(FlushModeType flushMode)
|
OpenJPAQuery<X> |
setHint(String hintName,
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,
Calendar value,
TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(int position,
Date value,
TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(int position,
Object value)
|
OpenJPAQuery<X> |
setParameter(String name,
Calendar value,
TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(String name,
Date value,
TemporalType temporalType)
|
OpenJPAQuery<X> |
setParameter(String name,
Object value)
|
OpenJPAQuery<X> |
setParameters(Map params)
Set parameters. |
OpenJPAQuery<X> |
setParameters(Object... params)
Set parameters. |
OpenJPAQuery<X> |
setResultClass(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 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()
String getLanguage()
QueryOperationType getOperation()
FetchPlan getFetchPlan()
String getQueryString()
boolean getIgnoreChanges()
OpenJPAQuery<X> setIgnoreChanges(boolean ignore)
Collection getCandidateCollection()
null
if an
extent was specified instead of a collection.
OpenJPAQuery<X> setCandidateCollection(Collection coll)
Class getResultClass()
OpenJPAQuery<X> setResultClass(Class type)
boolean hasSubclasses()
OpenJPAQuery<X> setSubclasses(boolean subs)
int getFirstResult()
getFirstResult
in interface Query
int getMaxResults()
Integer.MAX_VALUE
for no limit.
getMaxResults
in interface Query
OpenJPAQuery<X> compile()
boolean hasPositionalParameters()
Object[] getPositionalParameters()
Map<String,Object> getNamedParameters()
OpenJPAQuery<X> setParameters(Map params)
OpenJPAQuery<X> setParameters(Object... params)
OpenJPAQuery<X> closeAll()
String[] getDataStoreActions(Map params)
params
- the named parameter map for the query invocationOpenJPAQuery<X> setMaxResults(int maxResult)
setMaxResults
in interface Query
setMaxResults
in interface TypedQuery<X>
OpenJPAQuery<X> setFirstResult(int startPosition)
setFirstResult
in interface Query
setFirstResult
in interface TypedQuery<X>
OpenJPAQuery<X> setHint(String hintName, Object value)
setHint
in interface Query
setHint
in interface TypedQuery<X>
OpenJPAQuery<X> setParameter(String name, Object value)
setParameter
in interface Query
setParameter
in interface TypedQuery<X>
OpenJPAQuery<X> setParameter(String name, Date value, TemporalType temporalType)
setParameter
in interface Query
setParameter
in interface TypedQuery<X>
OpenJPAQuery<X> setParameter(String name, Calendar value, TemporalType temporalType)
setParameter
in interface Query
setParameter
in interface TypedQuery<X>
OpenJPAQuery<X> setParameter(int position, Object value)
setParameter
in interface Query
setParameter
in interface TypedQuery<X>
OpenJPAQuery<X> setParameter(int position, Date value, TemporalType temporalType)
setParameter
in interface Query
setParameter
in interface TypedQuery<X>
OpenJPAQuery<X> setParameter(int position, Calendar value, TemporalType temporalType)
setParameter
in interface Query
setParameter
in interface TypedQuery<X>
OpenJPAQuery<X> setFlushMode(FlushModeType flushMode)
setFlushMode
in interface Query
setFlushMode
in interface TypedQuery<X>
FlushModeType getFlushMode()
getFlushMode
in interface 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.
Set<String> getSupportedHints()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |