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 Details

  • Constructor Details

    • QueryDescriptor

      protected QueryDescriptor​(String type)
  • Method Details

    • selectQueryDescriptor

      public static SelectQueryDescriptor selectQueryDescriptor()
      Creates new SelectQuery query descriptor.
    • sqlTemplateDescriptor

      public static SQLTemplateDescriptor sqlTemplateDescriptor()
      Creates new SQLTemplate query descriptor.
    • procedureQueryDescriptor

      public static ProcedureQueryDescriptor procedureQueryDescriptor()
      Creates new ProcedureQuery query descriptor.
    • ejbqlQueryDescriptor

      public static EJBQLQueryDescriptor ejbqlQueryDescriptor()
      Creates new EJBQLQuery query descriptor.
    • descriptor

      public static QueryDescriptor descriptor​(String type)
      Creates query descriptor of a given type.
    • getName

      public String getName()
      Returns name of the query.
    • setName

      public void setName​(String name)
      Sets name of the query.
    • getType

      public String getType()
      Returns type of the query.
    • setType

      public void setType​(String type)
      Sets type of the query.
    • getDataMap

      public DataMap getDataMap()
    • setDataMap

      public void setDataMap​(DataMap dataMap)
    • getRoot

      public Object getRoot()
      Returns the root of this query.
    • setRoot

      public void setRoot​(Object root)
      Sets the root of this query.
    • getProperties

      public Map<String,​String> getProperties()
      Returns map of query properties set up for this query.
    • getProperty

      public String getProperty​(String name)
      Returns query property by its name.
    • setProperties

      public void setProperties​(Map<String,​String> properties)
      Sets map of query properties for this query.
    • setProperty

      public void setProperty​(String name, String value)
      Sets single query property.
    • buildQuery

      public Query buildQuery()
      Assembles Cayenne query instance of appropriate type from this descriptor.
    • acceptVisitor

      public <T> T acceptVisitor​(ConfigurationNodeVisitor<T> visitor)
      Specified by:
      acceptVisitor in interface ConfigurationNode
    • 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