| org.apache.openjpa.kernel.StoreQuery
All known Subclasses: org.apache.openjpa.datacache.QueryCacheStoreQuery, org.apache.openjpa.kernel.AbstractStoreQuery,
| StoreQuery | | public interface StoreQuery extends QueryOperations,Serializable(Code) | | Component that executes queries against the datastore. For
expression-based queries, consider subclassing
ExpressionStoreManagerQuery .
author:
Abe White
since:
0.4.0 |
| Inner Class :public static class Range | |
| Inner Class :public static interface Executor | |
| EMPTY_BOOLEANS | | final public static boolean[] EMPTY_BOOLEANS(Code) | | |
| EMPTY_CLASSES | | final public static Class[] EMPTY_CLASSES(Code) | | |
| EMPTY_OBJECTS | | final public static Object[] EMPTY_OBJECTS(Code) | | |
| EMPTY_PARAMS | | final public static LinkedMap EMPTY_PARAMS(Code) | | |
| EMPTY_STRINGS | | final public static String[] EMPTY_STRINGS(Code) | | |
| getAggregateListener | | public AggregateListener getAggregateListener(String tag)(Code) | | Return the standard filter listener for the given tag, or null.
|
| getContext | | public QueryContext getContext()(Code) | | Return the query context that has been set.
|
| getFilterListener | | public FilterListener getFilterListener(String tag)(Code) | | Return the standard filter listener for the given tag, or null.
|
| invalidateCompilation | | public void invalidateCompilation()(Code) | | Invalidate any internal compilation state.
|
| newCompilation | | public Object newCompilation()(Code) | | Create a new compilation for this query. May be null.
|
| newCompilationKey | | public Object newCompilationKey()(Code) | | Create a new key for caching compiled query information. May be null.
|
| newDataStoreExecutor | | public Executor newDataStoreExecutor(ClassMetaData meta, boolean subs)(Code) | | Return an executor for datastore execution of this query.
Executors must be cachable and thread safe. If this class returns
true from
StoreQuery.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.
Parameters:
subs - whether to include dependent mapped subclasses in theresults; independent subclasses should never be included |
| newInMemoryExecutor | | public Executor newInMemoryExecutor(ClassMetaData meta, boolean subs)(Code) | | Return an executor for in-memory execution of this query.
Executors must be cachable and thread safe. If this class returns
true from
StoreQuery.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.
Parameters:
subs - whether to include dependent mapped subclasses in theresults; independent subclasses should never be included |
| populateFromCompilation | | public void populateFromCompilation(Object comp)(Code) | | Populate internal data from compilation.
|
| requiresCandidateType | | public boolean requiresCandidateType()(Code) | | Whether this query requires a candidate class.
|
| requiresParameterDeclarations | | public boolean requiresParameterDeclarations()(Code) | | Whether this query requires parameters to be declared.
|
| setContext | | public void setContext(QueryContext ctx)(Code) | | Set the current query context. This will be called before use.
|
| setQuery | | public boolean setQuery(Object query)(Code) | | This is invoked when the user or a facade creates a new query with
an object that the system does not recognize. Return true if
the object is recognized by the store, false otherwise.
|
| supportsAbstractExecutors | | public boolean supportsAbstractExecutors()(Code) | | Return true if this query supports execution against abstract or
interface types. Returns false by default, meaning we will only
request executors for persistent classes. In this case, we will
automatically combine the results of the executors for all
implementing classes if we execute a query for an interface for
abstract type.
|
| supportsDataStoreExecution | | public boolean supportsDataStoreExecution()(Code) | | True if this query supports datastore execution, false if it
can only run in memory.
|
| supportsInMemoryExecution | | public boolean supportsInMemoryExecution()(Code) | | True if this query supports in-memory execution, false if it
can only run against the datastore.
|
| supportsParameterDeclarations | | public boolean supportsParameterDeclarations()(Code) | | Whether this query supports declared parameters.
|
|
|