Package org.apache.cayenne.query
Class AbstractQuery
java.lang.Object
org.apache.cayenne.query.CacheableQuery
org.apache.cayenne.query.AbstractQuery
- All Implemented Interfaces:
- Serializable,- Query
- Direct Known Subclasses:
- ProcedureQuery,- SelectQuery,- SQLTemplate
public abstract class AbstractQuery extends CacheableQuery
A common superclass of Cayenne queries.
- See Also:
- Serialized Form
- 
Field SummaryFields inherited from class org.apache.cayenne.query.CacheableQuerylogger
- 
Constructor SummaryConstructors Constructor Description AbstractQuery()
- 
Method SummaryModifier and Type Method Description abstract SQLActioncreateSQLAction(SQLActionVisitor visitor)A callback method invoked by Cayenne during the final execution phase of the query run.QueryMetadatagetMetaData(EntityResolver resolver)Returns default select parameters.ObjectgetRoot()Returns the root of this query.voidroute(QueryRouter router, EntityResolver resolver, Query substitutedQuery)Implements default routing mechanism relying on the EntityResolver to find DataMap based on the query root.voidsetRoot(Object value)Sets the root of the queryStringtoString()Methods inherited from class org.apache.cayenne.query.CacheableQuerygetBaseMetaData, getCacheGroup, getCacheStrategy, setCacheGroup, setCacheStrategy, useLocalCache, useLocalCache, useSharedCache, useSharedCache
- 
Field Details- 
rootThe root object this query. May be an entity name, Java class, ObjEntity or DbEntity, depending on the specific query and how it was constructed.
 
- 
- 
Constructor Details- 
AbstractQuerypublic AbstractQuery()
 
- 
- 
Method Details- 
getMetaDataReturns default select parameters.- Since:
- 1.2
 
- 
getRootReturns the root of this query.
- 
setRootSets the root of the query- Parameters:
- value- The new root
- Throws:
- IllegalArgumentException- if value is not a String, ObjEntity, DbEntity, Procedure, DataMap, Class or null.
 
- 
toString
- 
createSQLActionDescription copied from interface:QueryA callback method invoked by Cayenne during the final execution phase of the query run. A concrete query implementation is given a chance to decide how it should be handled. Implementors can pick an appropriate method of the SQLActionVisitor to handle itself, create a custom SQLAction of its own, or substitute itself with another query that should be used for SQLAction construction.- Since:
- 1.2
 
- 
routeImplements default routing mechanism relying on the EntityResolver to find DataMap based on the query root. This mechanism should be sufficient for most queries that "know" their root.- Since:
- 1.2
 
 
-