org.apache.openjpa.persistence
Interface OpenJPAQuery

All Known Subinterfaces:
OpenJPAQuerySPI
All Known Implementing Classes:
QueryImpl

public interface OpenJPAQuery

Interface implemented by OpenJPA queries.

Since:
0.4.0
Author:
Abe White

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 addAggregateListener(AggregateListener listener)
          Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.
 OpenJPAQuery addFilterListener(FilterListener listener)
          Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.
 OpenJPAQuery closeAll()
          Close all open query results.
 OpenJPAQuery 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 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.
 boolean hasPositionalParameters()
          Whether this query has positional parameters.
 boolean hasSubclasses()
          Whether subclasses are included in the query results.
 OpenJPAQuery removeAggregateListener(AggregateListener listener)
          Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.
 OpenJPAQuery removeFilterListener(FilterListener listener)
          Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.
 OpenJPAQuery setCandidateCollection(Collection coll)
          Set a collection of candidates.
 OpenJPAQuery setFirstResult(int startPosition)
           
 OpenJPAQuery setFlushMode(FlushModeType flushMode)
           
 OpenJPAQuery setHint(String hintName, Object value)
           
 OpenJPAQuery setIgnoreChanges(boolean ignore)
          Whether to ignore changes in the current transaction.
 OpenJPAQuery setMaxResults(int maxResult)
           
 OpenJPAQuery setParameter(int position, Calendar value, TemporalType temporalType)
           
 OpenJPAQuery setParameter(int position, Date value, TemporalType temporalType)
           
 OpenJPAQuery setParameter(int position, Object value)
           
 OpenJPAQuery setParameter(String name, Calendar value, TemporalType temporalType)
           
 OpenJPAQuery setParameter(String name, Date value, TemporalType temporalType)
           
 OpenJPAQuery setParameter(String name, Object value)
           
 OpenJPAQuery setParameters(Map params)
          Set parameters.
 OpenJPAQuery setParameters(Object... params)
          Set parameters.
 OpenJPAQuery setResultClass(Class type)
          Query result element type.
 OpenJPAQuery setSubclasses(boolean subs)
          Whether subclasses are included in the query results.
 

Field Detail

HINT_RESULT_COUNT

static final String HINT_RESULT_COUNT
Hint key for specifying the number of rows to optimize for.

See Also:
Constant Field Values

OP_SELECT

static final int OP_SELECT
Deprecated. use the QueryOperationType instead.
See Also:
Constant Field Values

OP_DELETE

static final int OP_DELETE
Deprecated. use the QueryOperationType instead.
See Also:
Constant Field Values

OP_UPDATE

static final int OP_UPDATE
Deprecated. use the QueryOperationType instead.
See Also:
Constant Field Values

FLUSH_TRUE

static final int FLUSH_TRUE
Deprecated. use the FlushModeType enum instead.
See Also:
Constant Field Values

FLUSH_FALSE

static final int FLUSH_FALSE
Deprecated. use the FlushModeType enum instead.
See Also:
Constant Field Values

FLUSH_WITH_CONNECTION

static final int FLUSH_WITH_CONNECTION
Deprecated. use the FlushModeType enum instead.
See Also:
Constant Field Values
Method Detail

getEntityManager

OpenJPAEntityManager getEntityManager()
The owning entity manager.


getLanguage

String getLanguage()
Query language.


getOperation

QueryOperationType getOperation()
Query operation type.


getFetchPlan

FetchPlan getFetchPlan()
Fetch plan for controlling the loading of results.


getQueryString

String getQueryString()
Query string.


getIgnoreChanges

boolean getIgnoreChanges()
Whether to ignore changes in the current transaction.


setIgnoreChanges

OpenJPAQuery setIgnoreChanges(boolean ignore)
Whether to ignore changes in the current transaction.


getCandidateCollection

Collection getCandidateCollection()
Return the candidate collection, or null if an extent was specified instead of a collection.


setCandidateCollection

OpenJPAQuery setCandidateCollection(Collection coll)
Set a collection of candidates.


getResultClass

Class getResultClass()
Query result element type.


setResultClass

OpenJPAQuery setResultClass(Class type)
Query result element type.


hasSubclasses

boolean hasSubclasses()
Whether subclasses are included in the query results.


setSubclasses

OpenJPAQuery setSubclasses(boolean subs)
Whether subclasses are included in the query results.


getFirstResult

int getFirstResult()
Return the 0-based start index for the returned results.


getMaxResults

int getMaxResults()
Return the maximum number of results to retrieve. or Integer.MAX_VALUE for no limit.


compile

OpenJPAQuery compile()
Compile the query.


hasPositionalParameters

boolean hasPositionalParameters()
Whether this query has positional parameters.


getPositionalParameters

Object[] getPositionalParameters()
The positional parameters for the query; empty array if none or if query uses named parameters.


getNamedParameters

Map getNamedParameters()
The named parameters for the query; empty map if none or if query uses positional parameters.


setParameters

OpenJPAQuery setParameters(Map params)
Set parameters.


setParameters

OpenJPAQuery setParameters(Object... params)
Set parameters.


closeAll

OpenJPAQuery closeAll()
Close all open query results.


getDataStoreActions

String[] getDataStoreActions(Map params)
Returns a description of the commands that will be sent to the datastore in order to execute this query. This will typically be in the native query language of the database (e.g., SQL).

Parameters:
params - the named parameter map for the query invocation

setMaxResults

OpenJPAQuery setMaxResults(int maxResult)

setFirstResult

OpenJPAQuery setFirstResult(int startPosition)

setHint

OpenJPAQuery setHint(String hintName,
                     Object value)

setParameter

OpenJPAQuery setParameter(String name,
                          Object value)

setParameter

OpenJPAQuery setParameter(String name,
                          Date value,
                          TemporalType temporalType)

setParameter

OpenJPAQuery setParameter(String name,
                          Calendar value,
                          TemporalType temporalType)

setParameter

OpenJPAQuery setParameter(int position,
                          Object value)

setParameter

OpenJPAQuery setParameter(int position,
                          Date value,
                          TemporalType temporalType)

setParameter

OpenJPAQuery setParameter(int position,
                          Calendar value,
                          TemporalType temporalType)

setFlushMode

OpenJPAQuery setFlushMode(FlushModeType flushMode)

getFlushMode

FlushModeType getFlushMode()
Return the current flush mode.


addFilterListener

OpenJPAQuery addFilterListener(FilterListener listener)
Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.


removeFilterListener

OpenJPAQuery removeFilterListener(FilterListener listener)
Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.


addAggregateListener

OpenJPAQuery addAggregateListener(AggregateListener listener)
Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.


removeAggregateListener

OpenJPAQuery removeAggregateListener(AggregateListener listener)
Deprecated. cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.



Copyright © 2006-2010 Apache Software Foundation. All Rights Reserved.