Class RootDataMapHandler

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.VersionAwareHandler

org.apache.cayenne.project.xml.RootDataMapHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class RootDataMapHandler
extends VersionAwareHandler

Since:

4.1

Field Summary

Fields inherited from class VersionAwareHandler

rootTag

Fields inherited from class NamespaceAwareNestedTagHandler

allowAllNamespaces, targetNamespace

Fields inherited from class SAXNestedTagHandler

loaderContext, locator, parentHandler

Constructor Summary

Constructors

Constructor	Description
RootDataMapHandler(LoaderContext loaderContext, Resource configurationSource)

Method Summary

Modifier and Type	Method	Description
protected ContentHandler	createChildTagHandler(String namespaceURI, String localName, String qName, Attributes attributes)	This method should be used to create nested handlers to process children elements.
DataMap	getDataMap()	Returns the DataMap loaded by this handler, or null if there was none in the document.
protected boolean	processElement(String namespaceURI, String localName, Attributes attributes)	Main method to process XML content.

Methods inherited from class VersionAwareHandler

validateNamespace, validateVersion

Methods inherited from class NamespaceAwareNestedTagHandler

characters, endElement, processCharData, setAllowAllNamespaces, setTargetNamespace, startElement

Methods inherited from class SAXNestedTagHandler

beforeScopeEnd, 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

Constructor Details

RootDataMapHandler

public RootDataMapHandler(LoaderContext loaderContext,
 Resource configurationSource)

Method Details

processElement

protected boolean processElement(String namespaceURI,
 String localName,
 Attributes attributes)
                          throws SAXException

Description copied from class: SAXNestedTagHandler

Main method to process XML content. Should be override in subclasses, by default do nothing. Return value should be true if tag was fully processed and shouldn't be passed down to child handler.

Overrides:

processElement in class VersionAwareHandler

Parameters:

namespaceURI - namespace for tag

localName - tag local name (i.e. w/o namespace prefix)

attributes - tag attributes

Returns:

true if tag was processed

Throws:

SAXException - can be thrown to abort parsing

See Also:

• SAXNestedTagHandler.createChildTagHandler(String, String, String, Attributes)

createChildTagHandler

protected ContentHandler createChildTagHandler(String namespaceURI,
 String localName,
 String qName,
 Attributes attributes)

Description copied from class: SAXNestedTagHandler

This method should be used to create nested handlers to process children elements. This method should never return null.

Overrides:

createChildTagHandler in class NamespaceAwareNestedTagHandler

Parameters:

namespaceURI - namespace for tag

localName - tag local name (i.e. w/o namespace prefix)

qName - tag full name (i.e. with namespace prefix)

attributes - tag attributes

Returns:

new handler to process child tag

getDataMap

public DataMap getDataMap()

Returns the DataMap loaded by this handler, or null if there was none in the document.