Class ProcedureQueryDescriptor

java.lang.Object

org.apache.cayenne.map.QueryDescriptor

org.apache.cayenne.map.ProcedureQueryDescriptor

All Implemented Interfaces:

Serializable, ConfigurationNode, XMLSerializable

public class ProcedureQueryDescriptor
extends QueryDescriptor

Since:

4.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	resultEntityName

Fields inherited from class QueryDescriptor

DATA_MAP_ROOT, dataMap, DB_ENTITY_ROOT, EJBQL_QUERY, JAVA_CLASS_ROOT, name, OBJ_ENTITY_ROOT, PROCEDURE_QUERY, PROCEDURE_ROOT, properties, root, SELECT_QUERY, SQL_TEMPLATE, type

Modifier and Type	Field	Description
static final String	DATA_MAP_ROOT
protected DataMap	dataMap
static final String	DB_ENTITY_ROOT
static final String	EJBQL_QUERY
static final String	JAVA_CLASS_ROOT
protected String	name
static final String	OBJ_ENTITY_ROOT
static final String	PROCEDURE_QUERY
static final String	PROCEDURE_ROOT
protected Map<String,String>	properties
protected Object	root
static final String	SELECT_QUERY
static final String	SQL_TEMPLATE
protected String	type

Constructor Summary

Constructors

Constructor	Description
ProcedureQueryDescriptor()

Method Summary

Modifier and Type	Method	Description
ProcedureQuery	buildQuery()	Assembles Cayenne query instance of appropriate type from this descriptor.
void	encodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)	Prints itself as XML to the provided XMLEncoder.
String	getResultEntityName()	Returns result entity name.
void	setResultEntityName(String resultEntityName)	Sets result entity name.

Methods inherited from class QueryDescriptor

acceptVisitor, descriptor, ejbqlQueryDescriptor, getDataMap, getName, getProperties, getProperty, getRoot, getType, procedureQueryDescriptor, selectQueryDescriptor, setDataMap, setName, setProperties, setProperty, setRoot, setType, sqlTemplateDescriptor

Modifier and Type	Method	Description
<T> T	acceptVisitor(ConfigurationNodeVisitor<T> visitor)
static QueryDescriptor	descriptor(String type)	Creates query descriptor of a given type.
static EJBQLQueryDescriptor	ejbqlQueryDescriptor()	Creates new EJBQLQuery query descriptor.
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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

resultEntityName

protected String resultEntityName

Constructor Details

ProcedureQueryDescriptor

public ProcedureQueryDescriptor()

Method Details

getResultEntityName

public String getResultEntityName()

Returns result entity name.

setResultEntityName

public void setResultEntityName(String resultEntityName)

Sets result entity name.

buildQuery

public ProcedureQuery buildQuery()

Description copied from class: QueryDescriptor

Assembles Cayenne query instance of appropriate type from this descriptor.

Overrides:

buildQuery in class QueryDescriptor

encodeAsXML

public void encodeAsXML(XMLEncoder encoder,
 ConfigurationNodeVisitor delegate)

Description copied from interface: XMLSerializable

Prints itself as XML to the provided XMLEncoder.

Specified by:

encodeAsXML in interface XMLSerializable

Overrides:

encodeAsXML in class QueryDescriptor