javanet.staxutils

Class StAXContentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

javanet.staxutils.StAXContentHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler

Direct Known Subclasses:

StAXEventContentHandler, StAXStreamContentHandler

public abstract class StAXContentHandler
extends org.xml.sax.helpers.DefaultHandler
implements org.xml.sax.ext.LexicalHandler

Base class for SAX-to-STAX bridge classes that provides common functionality.

Version:

$Revision: 1.3 $

Author:

Christian Niles

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.StringBuffer	CDATABuffer Buffer containing text read within the current CDATA section.
protected org.xml.sax.Locator	docLocator The SAX Locatorprovided to the handler.
protected boolean	isCDATA Whether the parser is currently within a CDATA section.
protected SimpleNamespaceContext	namespaces Stack used to store declared namespaces.
protected javax.xml.stream.XMLReporter	reporter The STAX XMLReporterregistered to receive notifications.

Constructor Summary

Constructors

Constructor and Description
StAXContentHandler()
StAXContentHandler(javax.xml.stream.XMLReporter reporter)

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	comment(char[] ch, int start, int length)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
void	endEntity(java.lang.String name)
void	endPrefixMapping(java.lang.String prefix)
void	error(org.xml.sax.SAXParseException e)
void	fatalError(org.xml.sax.SAXParseException e)
javax.xml.stream.Location	getCurrentLocation() Calculates the STAX Locationfrom the SAX Locator registered with this handler.
static void	parseQName(java.lang.String qName, java.lang.String[] results) Parses an XML qualified name, and places the resulting prefix and local name in the provided String array.
protected void	reportException(java.lang.String type, org.xml.sax.SAXException e) Used to report a SAXExceptionto the XMLReporter registered with this handler.
void	setDocumentLocator(org.xml.sax.Locator locator)
void	setXMLReporter(javax.xml.stream.XMLReporter reporter) Sets the XMLReporterto which warning and error messages will be sent.
void	startCDATA()
void	startDocument()
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)
void	startEntity(java.lang.String name)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
void	warning(org.xml.sax.SAXParseException e)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Detail

isCDATA

protected boolean isCDATA

Whether the parser is currently within a CDATA section.

CDATABuffer

protected java.lang.StringBuffer CDATABuffer

Buffer containing text read within the current CDATA section.

namespaces

protected SimpleNamespaceContext namespaces

Stack used to store declared namespaces.

docLocator

protected org.xml.sax.Locator docLocator

The SAX Locatorprovided to the handler.

reporter

protected javax.xml.stream.XMLReporter reporter

The STAX XMLReporterregistered to receive notifications.

Constructor Detail

StAXContentHandler

public StAXContentHandler()

StAXContentHandler

public StAXContentHandler(javax.xml.stream.XMLReporter reporter)

Method Detail

setXMLReporter

public void setXMLReporter(javax.xml.stream.XMLReporter reporter)

Sets the XMLReporterto which warning and error messages will be sent.

Parameters:

reporter - The XMLReporterto notify of errors.

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

getCurrentLocation

public javax.xml.stream.Location getCurrentLocation()

Calculates the STAX Locationfrom the SAX Locator registered with this handler. If no Locatorwas provided, then this method will return null.

error

public void error(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException

Specified by:

error in interface org.xml.sax.ErrorHandler

Overrides:

error in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

fatalError

public void fatalError(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Overrides:

fatalError in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

warning

public void warning(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException

Specified by:

warning in interface org.xml.sax.ErrorHandler

Overrides:

warning in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                java.lang.String localName,
                java.lang.String qName,
                org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
              java.lang.String localName,
              java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                      java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

startCDATA

public void startCDATA()
                throws org.xml.sax.SAXException

Specified by:

startCDATA in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
              int start,
              int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException

Specified by:

endCDATA in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException

comment

public void comment(char[] ch,
           int start,
           int length)
             throws org.xml.sax.SAXException

Specified by:

comment in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException

endDTD

public void endDTD()
            throws org.xml.sax.SAXException

Specified by:

endDTD in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException

endEntity

public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException

Specified by:

endEntity in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException

startDTD

public void startDTD(java.lang.String name,
            java.lang.String publicId,
            java.lang.String systemId)
              throws org.xml.sax.SAXException

Specified by:

startDTD in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException

startEntity

public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException

Specified by:

startEntity in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException

reportException

protected void reportException(java.lang.String type,
                   org.xml.sax.SAXException e)
                        throws org.xml.sax.SAXException

Used to report a SAXExceptionto the XMLReporter registered with this handler.

Throws:

org.xml.sax.SAXException

parseQName

public static final void parseQName(java.lang.String qName,
              java.lang.String[] results)

Parses an XML qualified name, and places the resulting prefix and local name in the provided String array.

Parameters:

qName - The qualified name to parse.

results - An array where parse results will be placed. The prefix will be placed at results[0], and the local part at results[1]