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 String
DATA_MAP_ROOT
protected DataMap
dataMap
static String
DB_ENTITY_ROOT
static String
EJBQL_QUERY
static String
JAVA_CLASS_ROOT
protected String
name
static String
OBJ_ENTITY_ROOT
static String
PROCEDURE_QUERY
static String
PROCEDURE_ROOT
protected Map<String,String>
properties
protected Object
root
static String
SELECT_QUERY
static String
SQL_TEMPLATE
protected String
type
-
Constructor Summary
Constructors Modifier Constructor Description protected
QueryDescriptor(String type)
-
Method Summary
Modifier and Type Method Description <T> T
acceptVisitor(ConfigurationNodeVisitor<T> visitor)
Query
buildQuery()
Assembles Cayenne query instance of appropriate type from this descriptor.static QueryDescriptor
descriptor(String type)
Creates query descriptor of a given type.static EJBQLQueryDescriptor
ejbqlQueryDescriptor()
Creates new EJBQLQuery query descriptor.void
encodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)
Prints itself as XML to the provided XMLEncoder.DataMap
getDataMap()
String
getName()
Returns name of the query.Map<String,String>
getProperties()
Returns map of query properties set up for this query.String
getProperty(String name)
Returns query property by its name.Object
getRoot()
Returns the root of this query.String
getType()
Returns type of the query.static ProcedureQueryDescriptor
procedureQueryDescriptor()
Creates new ProcedureQuery query descriptor.static SelectQueryDescriptor
selectQueryDescriptor()
Creates new SelectQuery query descriptor.void
setDataMap(DataMap dataMap)
void
setName(String name)
Sets name of the query.void
setProperties(Map<String,String> properties)
Sets map of query properties for this query.void
setProperty(String name, String value)
Sets single query property.void
setRoot(Object root)
Sets the root of this query.void
setType(String type)
Sets type of the query.static SQLTemplateDescriptor
sqlTemplateDescriptor()
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:
acceptVisitor
in interfaceConfigurationNode
-
encodeAsXML
Description copied from interface:XMLSerializable
Prints itself as XML to the provided XMLEncoder.- Specified by:
encodeAsXML
in interfaceXMLSerializable
-