Class QueryDescriptorHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.cayenne.project.xml.SAXNestedTagHandler

org.apache.cayenne.project.xml.NamespaceAwareNestedTagHandler

org.apache.cayenne.project.xml.QueryDescriptorHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

ProcedureQueryDescriptorHandler, SelectQueryDescriptorHandler, SQLTemplateDescriptorHandler

public abstract class QueryDescriptorHandler
extends NamespaceAwareNestedTagHandler

A base of the handlers of the query tags of a DataMap. A subclass per query type reads its own tag into the matching QueryDescriptor. The base reads the attributes common to all the query tags.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected final DataMap	map

Fields inherited from class NamespaceAwareNestedTagHandler

allowAllNamespaces, targetNamespace

Fields inherited from class SAXNestedTagHandler

loaderContext, locator, parentHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryDescriptorHandler(NamespaceAwareNestedTagHandler parentHandler, DataMap map)

Method Summary

Modifier and Type	Method	Description
protected void	beforeScopeEnd()	Callback method that is called before this handler pushed out of parsers stack.
protected static CapsStrategy	columnNameCapitalization(Attributes attributes)	Reads the "columnNameCapitalization" attribute of a SQL or a procedure query, returning null if it is not set.
abstract QueryDescriptor	getQueryDescriptor()	Returns the descriptor of the query being read, or null before the query tag is processed.
protected static int	intAttribute(Attributes attributes, String name)
protected void	loadQuerySettings(QueryDescriptor descriptor, Attributes attributes)	Reads the attributes common to all the query tags into a descriptor.
protected Object	resolveRoot(Attributes attributes)	Resolves the root of a query from its "root" and "rootName" attributes.

Methods inherited from class NamespaceAwareNestedTagHandler

characters, createChildTagHandler, endElement, processCharData, processElement, setAllowAllNamespaces, setTargetNamespace, startElement

Methods inherited from class SAXNestedTagHandler

getParentHandler, setDocumentLocator, stop, unexpectedTagMessage

Methods inherited from class DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

map

protected final DataMap map

Constructor Details

QueryDescriptorHandler

protected QueryDescriptorHandler(NamespaceAwareNestedTagHandler parentHandler,
 DataMap map)

Method Details

beforeScopeEnd

protected void beforeScopeEnd()

Description copied from class: SAXNestedTagHandler

Callback method that is called before this handler pushed out of parsers stack. Can be used to flush some aggregate state.

Overrides:

beforeScopeEnd in class SAXNestedTagHandler

getQueryDescriptor

public abstract QueryDescriptor getQueryDescriptor()

Returns the descriptor of the query being read, or null before the query tag is processed.

loadQuerySettings

protected void loadQuerySettings(QueryDescriptor descriptor,
 Attributes attributes)
                          throws SAXException

Reads the attributes common to all the query tags into a descriptor.

Throws:

SAXException

resolveRoot

protected Object resolveRoot(Attributes attributes)

Resolves the root of a query from its "root" and "rootName" attributes. Falls back to the DataMap when the root type is not set, or the named root is not found.

intAttribute

protected static int intAttribute(Attributes attributes,
 String name)

columnNameCapitalization

protected static CapsStrategy columnNameCapitalization(Attributes attributes)

Reads the "columnNameCapitalization" attribute of a SQL or a procedure query, returning null if it is not set.