org.apache.xml.resolver.readers
Class SAXParserHandler

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.apache.xml.resolver.readers.SAXParserHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class SAXParserHandler
extends DefaultHandler

An entity-resolving DefaultHandler.

This class provides a SAXParser DefaultHandler that performs entity resolution.

Version:

1.0

Author:

Norman Walsh Norman.Walsh@Sun.COM

Constructor Summary

SAXParserHandler()

Method Summary

void	characters(char[] ch, int start, int length) Receive notification of character data inside an element.
void	endDocument() Receive notification of the end of the document.
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) Receive notification of the end of an element.
void	endPrefixMapping(java.lang.String prefix) Receive notification of the end of a Namespace mapping.
void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.
void	processingInstruction(java.lang.String target, java.lang.String data) Receive notification of a processing instruction.
InputSource	resolveEntity(java.lang.String publicId, java.lang.String systemId) Resolve an external entity.
void	setContentHandler(ContentHandler ch)
void	setDocumentLocator(Locator locator) Receive a Locator object for document events.
void	setEntityResolver(EntityResolver er)
void	skippedEntity(java.lang.String name) Receive notification of a skipped entity.
void	startDocument() Receive notification of the beginning of the document.
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, Attributes atts) Receive notification of the start of an element.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Receive notification of the start of a Namespace mapping.

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

error, fatalError, notationDecl, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

SAXParserHandler

public SAXParserHandler()

Method Detail

setEntityResolver

public void setEntityResolver(EntityResolver er)

setContentHandler

public void setContentHandler(ContentHandler ch)

resolveEntity

public InputSource resolveEntity(java.lang.String publicId,
                                 java.lang.String systemId)
                          throws SAXException

Description copied from class: DefaultHandler

Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Parameters:

publicId - The public identifer, or null if none is available.

systemId - The system identifier provided in the XML document.

Returns:

The new input source, or null to require the default behaviour.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

EntityResolver.resolveEntity(java.lang.String, java.lang.String)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Description copied from class: DefaultHandler

Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Parameters:

ch - The characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.characters(char[], int, int)

endDocument

public void endDocument()
                 throws SAXException

Description copied from class: DefaultHandler

Receive notification of the end of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.endDocument()

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws SAXException

Description copied from class: DefaultHandler

Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Parameters:

namespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

endPrefixMapping

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

Description copied from class: DefaultHandler

Receive notification of the end of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultHandler

Parameters:

prefix - The Namespace prefix being declared.

Throws:

SAXException - the client may throw an exception during processing

See Also:

ContentHandler.endPrefixMapping(java.lang.String)

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException

Description copied from class: DefaultHandler

Receive notification of ignorable whitespace in element content.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Parameters:

ch - The whitespace characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.ignorableWhitespace(char[], int, int)

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws SAXException

Description copied from class: DefaultHandler

Receive notification of a processing instruction.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Parameters:

target - The processing instruction target.

data - The processing instruction data, or null if none is supplied.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

setDocumentLocator

public void setDocumentLocator(Locator locator)

Description copied from class: DefaultHandler

Receive a Locator object for document events.

By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

Parameters:

locator - A locator for all SAX document events.

See Also:

ContentHandler.setDocumentLocator(org.xml.sax.Locator), Locator

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws SAXException

Description copied from class: DefaultHandler

Receive notification of a skipped entity.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class DefaultHandler

Parameters:

name - The name of the skipped entity.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

startDocument

public void startDocument()
                   throws SAXException

Description copied from class: DefaultHandler

Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.startDocument()

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         Attributes atts)
                  throws SAXException

Description copied from class: DefaultHandler

Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

namespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

atts - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

startPrefixMapping

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

Description copied from class: DefaultHandler

Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI mapped to the prefix.

Throws:

SAXException - the client may throw an exception during processing

See Also:

ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)