Class org.xml.sax.HandlerBase

java.lang.Object
    |
    +----org.xml.sax.HandlerBase

public class HandlerBase

extends java.lang.Object

implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler

This class implements the default behaviour for four SAX interfaces: EntityResolver, DTDHandler, DocumentHandler, and ErrorHandler.

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

Note that the use of this class is optional.

Version:

Revision: 27 1.3 src/org/xml/sax/HandlerBase.java, xml4jsrc, xml4j-jtcsv, xml4j_1_0_4

See Also:

EntityResolver, DTDHandler, DocumentHandler, ErrorHandler

Constructor Summary

HandlerBase()

 

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 name) Receive notification of the end of an element.
void	error(SAXParseException e) Receive notification of a recoverable parser error.
void	fatalError(SAXParseException e) Report a fatal XML parsing error.
void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.
void	notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Receive notification of a notation declaration.
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	setDocumentLocator(Locator locator) Receive a Locator object for document events.
void	startDocument() Receive notification of the beginning of the document.
void	startElement(java.lang.String name, AttributeList attributes) Receive notification of the start of an element.
void	unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) Receive notification of an unparsed entity declaration.
void	warning(SAXParseException e) Receive notification of a parser warning.

 

Methods inherited from class java.lang.Object

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

 

Constructor Detail

HandlerBase

public HandlerBase()

resolveEntity

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

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.

Implements:

resolveEntity in interface EntityResolver

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:

resolveEntity

notationDecl

public void notationDecl(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)

Receive notification of a notation declaration.

By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.

Implements:

notationDecl in interface DTDHandler

Parameters:

name - The notation name.

publicId - The notation public identifier, or null if not available.

systemId - The notation system identifier.

See Also:

notationDecl

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)

Receive notification of an unparsed entity declaration.

By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.

Implements:

unparsedEntityDecl in interface DTDHandler

Parameters:

name - The entity name.

publicId - The entity public identifier, or null if not available.

systemId - The entity system identifier.

notationName - The name of the associated notation.

See Also:

unparsedEntityDecl

setDocumentLocator

public void setDocumentLocator(Locator locator)

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.

Implements:

setDocumentLocator in interface DocumentHandler

Parameters:

locator - A locator for all SAX document events.

See Also:

setDocumentLocator, Locator

startDocument

public void startDocument() throws SAXException

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

Implements:

startDocument in interface DocumentHandler

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

startDocument

endDocument

public void endDocument() throws SAXException

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 beginning of a document (such as finalising a tree or closing an output file).

Implements:

endDocument in interface DocumentHandler

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

endDocument

startElement

public void startElement(java.lang.String name,
                         AttributeList attributes) throws SAXException

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

Implements:

startElement in interface DocumentHandler

Parameters:

name - The element type name.

attributes - The specified or defaulted attributes.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

startElement

endElement

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

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

Implements:

endElement in interface DocumentHandler

Parameters:

name - The element type name.

attributes - The specified or defaulted attributes.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

endElement

characters

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

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

Implements:

characters in interface DocumentHandler

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:

characters

ignorableWhitespace

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

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

Implements:

ignorableWhitespace in interface DocumentHandler

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:

ignorableWhitespace

processingInstruction

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

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.

Implements:

processingInstruction in interface DocumentHandler

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:

processingInstruction

warning

public void warning(SAXParseException e) throws SAXException

Receive notification of a parser warning.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.

Implements:

warning in interface ErrorHandler

Parameters:

e - The warning information encoded as an exception.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

warning, SAXParseException

error

public void error(SAXParseException e) throws SAXException

Receive notification of a recoverable parser error.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.

Implements:

error in interface ErrorHandler

Parameters:

e - The warning information encoded as an exception.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

warning, SAXParseException

fatalError

public void fatalError(SAXParseException e) throws SAXException

Report a fatal XML parsing error.

The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.

Implements:

fatalError in interface ErrorHandler

Parameters:

e - The error information encoded as an exception.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

fatalError, SAXParseException