Package org.apache.cayenne.map
Class QueryDescriptor
java.lang.Object
org.apache.cayenne.map.QueryDescriptor
- All Implemented Interfaces:
Serializable,ConfigurationNode,XMLSerializable
- Direct Known Subclasses:
EJBQLQueryDescriptor,ProcedureQueryDescriptor,SelectQueryDescriptor,SQLTemplateDescriptor
public class QueryDescriptor extends Object implements Serializable, ConfigurationNode, XMLSerializable
Generic descriptor of a Cayenne query.
- Since:
- 4.0
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description static StringDATA_MAP_ROOTprotected DataMapdataMapstatic StringDB_ENTITY_ROOTstatic StringEJBQL_QUERYstatic StringJAVA_CLASS_ROOTprotected Stringnamestatic StringOBJ_ENTITY_ROOTstatic StringPROCEDURE_QUERYstatic StringPROCEDURE_ROOTprotected Map<String,String>propertiesprotected Objectrootstatic StringSELECT_QUERYstatic StringSQL_TEMPLATEprotected Stringtype -
Constructor Summary
Constructors Modifier Constructor Description protectedQueryDescriptor(String type) -
Method Summary
Modifier and Type Method Description <T> TacceptVisitor(ConfigurationNodeVisitor<T> visitor)QuerybuildQuery()Assembles Cayenne query instance of appropriate type from this descriptor.static QueryDescriptordescriptor(String type)Creates query descriptor of a given type.static EJBQLQueryDescriptorejbqlQueryDescriptor()Creates new EJBQLQuery query descriptor.voidencodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)Prints itself as XML to the provided XMLEncoder.DataMapgetDataMap()StringgetName()Returns name of the query.Map<String,String>getProperties()Returns map of query properties set up for this query.StringgetProperty(String name)Returns query property by its name.ObjectgetRoot()Returns the root of this query.StringgetType()Returns type of the query.static ProcedureQueryDescriptorprocedureQueryDescriptor()Creates new ProcedureQuery query descriptor.static SelectQueryDescriptorselectQueryDescriptor()Creates new SelectQuery query descriptor.voidsetDataMap(DataMap dataMap)voidsetName(String name)Sets name of the query.voidsetProperties(Map<String,String> properties)Sets map of query properties for this query.voidsetProperty(String name, String value)Sets single query property.voidsetRoot(Object root)Sets the root of this query.voidsetType(String type)Sets type of the query.static SQLTemplateDescriptorsqlTemplateDescriptor()Creates new SQLTemplate query descriptor.
-
Field Details
-
SELECT_QUERY
- See Also:
- Constant Field Values
-
SQL_TEMPLATE
- See Also:
- Constant Field Values
-
EJBQL_QUERY
- See Also:
- Constant Field Values
-
PROCEDURE_QUERY
- See Also:
- Constant Field Values
-
OBJ_ENTITY_ROOT
- Since:
- 4.1
- See Also:
- Constant Field Values
-
DB_ENTITY_ROOT
- Since:
- 4.1
- See Also:
- Constant Field Values
-
PROCEDURE_ROOT
- Since:
- 4.1
- See Also:
- Constant Field Values
-
DATA_MAP_ROOT
- Since:
- 4.1
- See Also:
- Constant Field Values
-
JAVA_CLASS_ROOT
- Since:
- 4.1
- See Also:
- Constant Field Values
-
name
-
type
-
dataMap
-
root
-
properties
-
-
Constructor Details
-
QueryDescriptor
-
-
Method Details
-
selectQueryDescriptor
Creates new SelectQuery query descriptor. -
sqlTemplateDescriptor
Creates new SQLTemplate query descriptor. -
procedureQueryDescriptor
Creates new ProcedureQuery query descriptor. -
ejbqlQueryDescriptor
Creates new EJBQLQuery query descriptor. -
descriptor
Creates query descriptor of a given type. -
getName
Returns name of the query. -
setName
Sets name of the query. -
getType
Returns type of the query. -
setType
Sets type of the query. -
getDataMap
-
setDataMap
-
getRoot
Returns the root of this query. -
setRoot
Sets the root of this query. -
getProperties
Returns map of query properties set up for this query. -
getProperty
Returns query property by its name. -
setProperties
Sets map of query properties for this query. -
setProperty
Sets single query property. -
buildQuery
Assembles Cayenne query instance of appropriate type from this descriptor. -
acceptVisitor
- Specified by:
acceptVisitorin interfaceConfigurationNode
-
encodeAsXML
Description copied from interface:XMLSerializablePrints itself as XML to the provided XMLEncoder.- Specified by:
encodeAsXMLin interfaceXMLSerializable
-