class HandlerBase : public EntityResolver, public DTDHandler, public DocumentHandler, public ErrorHandler

Default base class for handlers

Inheritance:


Public

Default handlers for the DocumentHandler interface
virtual void characters ( const XMLCh* const chars, const unsigned int length )
Receive notification of character data inside an element
virtual void endDocument ()
Receive notification of the end of the document
virtual void endElement (const XMLCh* const name)
Receive notification of the end of an element
virtual void ignorableWhitespace ( const XMLCh* const chars, const unsigned int length )
Receive notification of ignorable whitespace in element content
virtual void processingInstruction ( const XMLCh* const target, const XMLCh* const data )
Receive notification of a processing instruction
Default implementation of DocumentHandler interface
virtual void setDocumentLocator (Locator* const locator)
Receive a Locator object for document events
virtual void startDocument ()
Receive notification of the beginning of the document
virtual void startElement ( const XMLCh* const name, AttributeList& attributes )
Receive notification of the start of an element
Default implementation of DTDHandler interface.
virtual void notationDecl ( const XMLCh* const name, const XMLCh* const publicId, const XMLCh* const systemId )
Receive notification of a notation declaration
virtual void unparsedEntityDecl ( const XMLCh* const name, const XMLCh* const publicId, const XMLCh* const systemId, const XMLCh* const notationName )
Receive notification of an unparsed entity declaration
Default implementation of the EntityResolver interface.
virtual InputSource* resolveEntity ( const XMLCh* const publicId, const XMLCh* const systemId )
Resolve an external entity
Default implementation of the ErrorHandler interface
virtual void error (const SAXParseException& exception)
Receive notification of a recoverable parser error
virtual void fatalError (const SAXParseException& exception)
Report a fatal XML parsing error
virtual void warning (const SAXParseException& exception)
Receive notification of a parser warning

Inherited from EntityResolver:

Public

private :
EntityResolver(const EntityResolver&)
Copy constructor
void operator=(const EntityResolver&)
Assignment operator

Constructors and Destructor

EntityResolver()
Default Constructor
virtual ~EntityResolver()
Destructor

The EntityResolver interface

virtual InputSource* resolveEntity( const XMLCh* const publicId, const XMLCh* const systemId )
Allow the application to resolve external entities

Inherited from DTDHandler:

Public

The DTD handler interface

virtual void notationDecl( const XMLCh* const name, const XMLCh* const publicId, const XMLCh* const systemId )
Receive notification of a notation declaration event
virtual void unparsedEntityDecl( const XMLCh* const name, const XMLCh* const publicId, const XMLCh* const systemId, const XMLCh* const notationName )
Receive notification of an unparsed entity declaration event

private Unimplemented constructors and operators

DTDHandler(const DTDHandler&)
Copy constructor
void operator=(const DTDHandler&)
Assignment operator

Inherited from DocumentHandler:

Public

The virtual document handler interface

virtual void characters( const XMLCh* const chars, const unsigned int length )
Receive notification of character data
virtual void endDocument()
Receive notification of the end of a document
virtual void endElement(const XMLCh* const name)
Receive notification of the end of an element
virtual void ignorableWhitespace( const XMLCh* const chars, const unsigned int length )
Receive notification of ignorable whitespace in element content
virtual void processingInstruction( const XMLCh* const target, const XMLCh* const data )
Receive notification of a processing instruction
virtual void setDocumentLocator(Locator* const locator)
Receive an object for locating the origin of SAX document events
virtual void startDocument()
Receive notification of the beginning of a document
virtual void startElement( const XMLCh* const name, AttributeList& attrs )
Receive notification of the beginning of an element

private Unimplemented Constructors and operators

DocumentHandler(const DocumentHandler&)
Copy constructor
void operator=(const DocumentHandler&)
Assignment operator

Inherited from ErrorHandler:

Public

The error handler interface

virtual void warning(const SAXParseException& exception)
Receive notification of a warning
virtual void error(const SAXParseException& exception)
Receive notification of a recoverable error
virtual void fatalError(const SAXParseException& exception)
Receive notification of a non-recoverable error

Documentation

Default base class for handlers.

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.

$Log: HandlerBase.hpp,v $ Revision 1.1.1.1 1999/11/09 01:07:45 twl Initial checkin Revision 1.2 1999/11/08 20:45:00 rahul Swat for adding in Product name and CVS comment log variable.
Default handlers for the DocumentHandler interface

virtual void characters( const XMLCh* const chars, const unsigned int length )
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).

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
chars - The characters.
length - The number of characters to use from the character array.
See Also:
characters

virtual void endDocument()
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).

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
See Also:
endDocument

virtual void endElement(const XMLCh* const name)
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).

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
name - The element type name.
See Also:
endElement

virtual void ignorableWhitespace( const XMLCh* const chars, const unsigned int length )
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).

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
chars - The whitespace characters.
length - The number of characters to use from the character array.
See Also:
ignorableWhitespace

virtual void processingInstruction( const XMLCh* const target, const XMLCh* const data )
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
target - The processing instruction target.
data - The processing instruction data, or null if none is supplied.
See Also:
processingInstruction

Default implementation of DocumentHandler interface

virtual void setDocumentLocator(Locator* const 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.

Parameters:
locator - A locator for all SAX document events.
See Also:
setDocumentLocator
Locator

virtual void startDocument()
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).

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
See Also:
startDocument

virtual void startElement( const XMLCh* const name, AttributeList& attributes )
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).

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
name - The element type name.
attributes - The specified or defaulted attributes.
See Also:
startElement

Default implementation of the EntityResolver interface.

virtual InputSource* resolveEntity( const XMLCh* const publicId, const XMLCh* const systemId )
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Returns:
The new input source, or null to require the default behaviour.
Parameters:
publicId - The public identifer, or null if none is available.
systemId - The system identifier provided in the XML document.
See Also:
resolveEntity

Default implementation of the ErrorHandler interface

virtual void error(const SAXParseException& exception)
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
exception - The warning information encoded as an exception.
See Also:
warning
SAXParseException

virtual void fatalError(const SAXParseException& exception)
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
e - The error information encoded as an exception.
See Also:
fatalError
SAXParseException

virtual void warning(const SAXParseException& exception)
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.

Throws:
SAXException Any SAX exception, possibly wrapping another exception.
Parameters:
e - The warning information encoded as an exception.
See Also:
warning
SAXParseException

Default implementation of DTDHandler interface.

virtual void notationDecl( const XMLCh* const name, const XMLCh* const publicId, const XMLCh* const 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.

Parameters:
name - The notation name.
publicId - The notation public identifier, or null if not available.
systemId - The notation system identifier.
See Also:
notationDecl

virtual void unparsedEntityDecl( const XMLCh* const name, const XMLCh* const publicId, const XMLCh* const systemId, const XMLCh* const 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.

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


This class has no child classes.
See Also:
EntityResolver
DTDHandler
DocumentHandler
ErrorHandler

alphabetic index hierarchy of classes


XML Parser for C++ 2.0
Copyright © IBM Corp, 1999
Center for Java Technology
10275 N. De Anza Blvd.
Cupertino CA 95014 USA
Email: xml4c@us.ibm.com

IBM Logo