|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StoreQuery
Component that executes queries against the datastore. For
expression-based queries, consider subclassing
ExpressionStoreManagerQuery
.
Nested Class Summary | |
---|---|
static interface |
StoreQuery.Executor
An executor provides a uniform interface to the mechanism for executing either an in-memory or datastore query. |
static class |
StoreQuery.Range
A query result range. |
Field Summary | |
---|---|
static boolean[] |
EMPTY_BOOLEANS
|
static Class[] |
EMPTY_CLASSES
|
static ClassMetaData[] |
EMPTY_METAS
|
static Object[] |
EMPTY_OBJECTS
|
static LinkedMap |
EMPTY_PARAMS
|
static String[] |
EMPTY_STRINGS
|
Fields inherited from interface org.apache.openjpa.kernel.QueryOperations |
---|
OP_DELETE, OP_SELECT, OP_UPDATE |
Method Summary | |
---|---|
AggregateListener |
getAggregateListener(String tag)
Return the standard filter listener for the given tag, or null. |
QueryContext |
getContext()
Return the query context that has been set. |
FilterListener |
getFilterListener(String tag)
Return the standard filter listener for the given tag, or null. |
void |
invalidateCompilation()
Invalidate any internal compilation state. |
Object |
newCompilation()
Create a new compilation for this query. |
Object |
newCompilationKey()
Create a new key for caching compiled query information. |
StoreQuery.Executor |
newDataStoreExecutor(ClassMetaData meta,
boolean subs)
Return an executor for datastore execution of this query. |
StoreQuery.Executor |
newInMemoryExecutor(ClassMetaData meta,
boolean subs)
Return an executor for in-memory execution of this query. |
void |
populateFromCompilation(Object comp)
Populate internal data from compilation. |
boolean |
requiresCandidateType()
Whether this query requires a candidate class. |
boolean |
requiresParameterDeclarations()
Whether this query requires parameters to be declared. |
void |
setContext(QueryContext ctx)
Set the current query context. |
boolean |
setQuery(Object query)
This is invoked when the user or a facade creates a new query with an object that the system does not recognize. |
boolean |
supportsAbstractExecutors()
Return true if this query supports execution against abstract or interface types. |
boolean |
supportsDataStoreExecution()
True if this query supports datastore execution, false if it can only run in memory. |
boolean |
supportsInMemoryExecution()
True if this query supports in-memory execution, false if it can only run against the datastore. |
boolean |
supportsParameterDeclarations()
Whether this query supports declared parameters. |
Field Detail |
---|
static final LinkedMap EMPTY_PARAMS
static final ClassMetaData[] EMPTY_METAS
static final String[] EMPTY_STRINGS
static final Object[] EMPTY_OBJECTS
static final Class[] EMPTY_CLASSES
static final boolean[] EMPTY_BOOLEANS
Method Detail |
---|
QueryContext getContext()
void setContext(QueryContext ctx)
boolean setQuery(Object query)
FilterListener getFilterListener(String tag)
AggregateListener getAggregateListener(String tag)
Object newCompilationKey()
Object newCompilation()
void populateFromCompilation(Object comp)
void invalidateCompilation()
boolean supportsDataStoreExecution()
boolean supportsInMemoryExecution()
StoreQuery.Executor newInMemoryExecutor(ClassMetaData meta, boolean subs)
supportsAbstractExecutors()
, the given metadata
will always be for the candidate class of this query, or possibly
null if the candidate class is not itself persistence capable (like
an interface or abstract base class). Otherwise, the given type will
be a mapped class.
subs
- whether to include dependent mapped subclasses in the
results; independent subclasses should never be includedStoreQuery.Executor newDataStoreExecutor(ClassMetaData meta, boolean subs)
supportsAbstractExecutors()
, the given metadata
will always be for the candidate class of this query, or possibly
null if the candidate class is not itself persistence capable (like
an interface or abstract base class). Otherwise, the given type will
be a mapped class.
subs
- whether to include dependent mapped subclasses in the
results; independent subclasses should never be includedboolean supportsAbstractExecutors()
boolean requiresCandidateType()
boolean requiresParameterDeclarations()
boolean supportsParameterDeclarations()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |