#include <HandlerBase.hpp>
Inheritance diagram for HandlerBase:
Public Member Functions | |
Default handlers for the DocumentHandler interface | |
virtual void | characters (const XMLCh *const chars, const unsigned int length) |
virtual void | endDocument () |
virtual void | endElement (const XMLCh *const name) |
virtual void | ignorableWhitespace (const XMLCh *const chars, const unsigned int length) |
virtual void | processingInstruction (const XMLCh *const target, const XMLCh *const data) |
virtual void | resetDocument () |
Default implementation of DocumentHandler interface | |
virtual void | setDocumentLocator (const Locator *const locator) |
virtual void | startDocument () |
virtual void | startElement (const XMLCh *const name, AttributeList &attributes) |
Default implementation of the EntityResolver interface. | |
virtual InputSource * | resolveEntity (const XMLCh *const publicId, const XMLCh *const systemId) |
Default implementation of the ErrorHandler interface | |
virtual void | error (const SAXParseException &exception) |
virtual void | fatalError (const SAXParseException &exception) |
virtual void | warning (const SAXParseException &exception) |
virtual void | resetErrors () |
Default implementation of DTDHandler interface. | |
virtual void | notationDecl (const XMLCh *const name, const XMLCh *const publicId, const XMLCh *const systemId) |
virtual void | resetDocType () |
virtual void | unparsedEntityDecl (const XMLCh *const name, const XMLCh *const publicId, const XMLCh *const systemId, const XMLCh *const notationName) |
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.
Definition at line 143 of file HandlerBase.hpp.
void HandlerBase::characters | ( | const XMLCh *const | chars, | |
const unsigned int | length | |||
) | [inline, virtual] |
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).
chars | The characters. | |
length | The number of characters to use from the character array. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements DocumentHandler.
Definition at line 456 of file HandlerBase.hpp.
void HandlerBase::endDocument | ( | ) | [inline, virtual] |
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).
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements DocumentHandler.
Definition at line 461 of file HandlerBase.hpp.
void HandlerBase::endElement | ( | const XMLCh *const | name | ) | [inline, virtual] |
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).
name | The element type name. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements DocumentHandler.
Definition at line 465 of file HandlerBase.hpp.
void HandlerBase::error | ( | const SAXParseException & | exception | ) | [inline, virtual] |
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.
exception | The warning information encoded as an exception. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements ErrorHandler.
Definition at line 469 of file HandlerBase.hpp.
void HandlerBase::fatalError | ( | const SAXParseException & | exception | ) | [inline, virtual] |
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.
exception | The error information encoded as an exception. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements ErrorHandler.
Definition at line 473 of file HandlerBase.hpp.
void HandlerBase::ignorableWhitespace | ( | const XMLCh *const | chars, | |
const unsigned int | length | |||
) | [inline, virtual] |
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).
chars | The whitespace characters. | |
length | The number of characters to use from the character array. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements DocumentHandler.
Definition at line 479 of file HandlerBase.hpp.
void HandlerBase::notationDecl | ( | const XMLCh *const | name, | |
const XMLCh *const | publicId, | |||
const XMLCh *const | systemId | |||
) | [inline, virtual] |
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.
name | The notation name. | |
publicId | The notation public identifier, or null if not available. | |
systemId | The notation system identifier. |
Implements DTDHandler.
Definition at line 484 of file HandlerBase.hpp.
void HandlerBase::processingInstruction | ( | const XMLCh *const | target, | |
const XMLCh *const | data | |||
) | [inline, virtual] |
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.
target | The processing instruction target. | |
data | The processing instruction data, or null if none is supplied. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements DocumentHandler.
Definition at line 491 of file HandlerBase.hpp.
void HandlerBase::resetDocType | ( | ) | [inline, virtual] |
Reset the DTD object on its reuse
Implements DTDHandler.
Definition at line 504 of file HandlerBase.hpp.
void HandlerBase::resetDocument | ( | ) | [inline, virtual] |
Reset the Docuemnt object on its reuse
Implements DocumentHandler.
Definition at line 500 of file HandlerBase.hpp.
void HandlerBase::resetErrors | ( | ) | [inline, virtual] |
Reset the Error handler object on its reuse
Implements ErrorHandler.
Definition at line 496 of file HandlerBase.hpp.
InputSource * HandlerBase::resolveEntity | ( | const XMLCh *const | publicId, | |
const XMLCh *const | systemId | |||
) | [inline, virtual] |
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.
publicId | The public identifer, or null if none is available. | |
systemId | The system identifier provided in the XML document. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements EntityResolver.
Definition at line 509 of file HandlerBase.hpp.
void HandlerBase::setDocumentLocator | ( | const Locator *const | locator | ) | [inline, virtual] |
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.
locator | A locator for all SAX document events. |
Implements DocumentHandler.
Definition at line 523 of file HandlerBase.hpp.
void HandlerBase::startDocument | ( | ) | [inline, virtual] |
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).
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements DocumentHandler.
Definition at line 527 of file HandlerBase.hpp.
void HandlerBase::startElement | ( | const XMLCh *const | name, | |
AttributeList & | attributes | |||
) | [inline, virtual] |
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).
name | The element type name. | |
attributes | The specified or defaulted attributes. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements DocumentHandler.
Definition at line 532 of file HandlerBase.hpp.
void HandlerBase::unparsedEntityDecl | ( | const XMLCh *const | name, | |
const XMLCh *const | publicId, | |||
const XMLCh *const | systemId, | |||
const XMLCh *const | notationName | |||
) | [inline, virtual] |
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.
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. |
Implements DTDHandler.
Definition at line 516 of file HandlerBase.hpp.
void HandlerBase::warning | ( | const SAXParseException & | exception | ) | [inline, virtual] |
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.
exception | The warning information encoded as an exception. |
SAXException | Any SAX exception, possibly wrapping another exception. |
Implements ErrorHandler.
Definition at line 537 of file HandlerBase.hpp.