| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface QueryContext
A query execution context.
| Method Summary | |
|---|---|
|  Class<?> | classForName(String name,
             String[] imports)Helper method to instantiate the class with the given name, taking into account the query's candidate package, automatic imports, and the given imports (if any). | 
|  void | declareParameters(String params)Declared parameters, for query languages that use them. | 
|  Number | deleteInMemory(StoreQuery q,
               StoreQuery.Executor ex,
               Object[] params)Helper method to delete the objects found by executing a query on the given executor. | 
|  ClassMetaData[] | getAccessPathMetaDatas()Return the classes that affect this query. | 
|  AggregateListener | getAggregateListener(String tag)Return the filter listener for the given tag, or null. | 
|  Collection<AggregateListener> | getAggregateListeners()The set of aggregate listeners. | 
|  String | getAlias()If this query is not a projection but places candidate results into a result class under an alias, return that alias. | 
|  Collection<?> | getCandidateCollection()Return the candidate collection, or nullif an
 extent was specified instead of a collection. | 
|  Class<?> | getCandidateType()Return the class of the objects that this query will return, or nullif this information is not available / not relevant. | 
|  Object | getCompilation()Return the query's compilation state. | 
|  long | getEndRange()Return the 0-based exclusive end index for the returned results, or Long.MAX_VALUEfor no limit. | 
|  FetchConfiguration | getFetchConfiguration()Return the fetch configuration for this query. | 
|  FilterListener | getFilterListener(String tag)Return the filter listener for the given tag, or null. | 
|  Collection<FilterListener> | getFilterListeners()The set of filter listeners. | 
|  boolean | getIgnoreChanges()Whether to ignore changes in the current transaction. | 
|  String | getLanguage()The query language. | 
|  int | getOperation()Returns the operation that this query will be expected to perform. | 
|  OrderedMap<Object,Class<?>> | getOrderedParameterTypes()Return a map of parameter name to type for this query. | 
|  String | getParameterDeclaration()The parameter declaration. | 
|  org.apache.commons.collections.map.LinkedMap | getParameterTypes()Deprecated. | 
|  String[] | getProjectionAliases()If this query is a projection, return the projection aliases. | 
|  Class<?>[] | getProjectionTypes()If this query is a projection, return the projection types. | 
|  Query | getQuery()Return the query for this context. | 
|  String | getQueryString()The query string. | 
|  String | getResultMappingName()Name of a mapping from the result data to its object representation. | 
|  Class<?> | getResultMappingScope()Scope of a mapping from the result data to its object representation. | 
|  Class<?> | getResultType()Returns the result class that has been set through setResultType(java.lang.Class>), or null if none. | 
|  long | getStartRange()Return the 0-based start index for the returned results. | 
|  StoreContext | getStoreContext()The persistence context for the query. | 
|  Map<FieldMetaData,Value> | getUpdates()If this query is a bulk update, return a map of the FieldMetaDatas toConstants. | 
|  boolean | hasGrouping()Return true if the query uses grouping. | 
|  boolean | hasSubclasses()Whether query results will include subclasses of the candidate class. | 
|  boolean | isAggregate()Return true if the query is an aggregate. | 
|  boolean | isDistinct()Affirms if this query results are distinct instance(s). | 
|  boolean | isReadOnly()Whether the query has been marked read-only. | 
|  boolean | isUnique()The unique flag. | 
|  void | lock()Synchronize on the query's internal lock. | 
|  void | setCandidateType(Class<?> cls,
                 boolean subs)Set the candidate type. | 
|  void | setRange(long start,
         long end)Set the range of results to return. | 
|  void | setReadOnly(boolean readOnly)Whether the query has been marked read-only. | 
|  void | setResultMapping(Class<?> scope,
                 String name)Name and scope of a mapping from the result data to its object representation. | 
|  void | setResultType(Class<?> cls)Specify the type of object in which the result of evaluating this query. | 
|  void | setUnique(boolean unique)Specify that the query will return only 1 result, rather than a collection. | 
|  void | unlock()Unlock the query's internal lock. | 
|  Number | updateInMemory(StoreQuery q,
               StoreQuery.Executor ex,
               Object[] params)Helper method to update the objects found by executing a query on the given executor. | 
| Method Detail | 
|---|
Query getQuery()
StoreContext getStoreContext()
FetchConfiguration getFetchConfiguration()
int getOperation()
QueryOperationsString getLanguage()
String getQueryString()
Collection<?> getCandidateCollection()
null if an
 extent was specified instead of a collection.
Class<?> getCandidateType()
null if this information is not available / not relevant.
boolean hasSubclasses()
void setCandidateType(Class<?> cls,
                      boolean subs)
boolean isReadOnly()
void setReadOnly(boolean readOnly)
boolean isUnique()
void setUnique(boolean unique)
boolean isDistinct()
Class<?> getResultMappingScope()
String getResultMappingName()
void setResultMapping(Class<?> scope,
                      String name)
Class<?> getResultType()
setResultType(java.lang.Class>), or null if none.
void setResultType(Class<?> cls)
long getStartRange()
long getEndRange()
Long.MAX_VALUE for no limit.
void setRange(long start,
              long end)
start - 0-based inclusive start indexend - 0-based exclusive end index, or
 Long.MAX_VALUE for no limitString getParameterDeclaration()
void declareParameters(String params)
OrderedMap<Object,Class<?>> getOrderedParameterTypes()
@Deprecated org.apache.commons.collections.map.LinkedMap getParameterTypes()
Map<FieldMetaData,Value> getUpdates()
FieldMetaDatas to Constants.
boolean getIgnoreChanges()
Object getCompilation()
String getAlias()
String[] getProjectionAliases()
Class<?>[] getProjectionTypes()
boolean isAggregate()
boolean hasGrouping()
ClassMetaData[] getAccessPathMetaDatas()
FilterListener getFilterListener(String tag)
AggregateListener getAggregateListener(String tag)
Collection<FilterListener> getFilterListeners()
Collection<AggregateListener> getAggregateListeners()
Number deleteInMemory(StoreQuery q,
                      StoreQuery.Executor ex,
                      Object[] params)
Number updateInMemory(StoreQuery q,
                      StoreQuery.Executor ex,
                      Object[] params)
Class<?> classForName(String name,
                      String[] imports)
void lock()
void unlock()
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||