Xerces-C++: DefaultHandler Class Reference (original) (raw)

Default base class for SAX2 handlers. More...

#include <[xercesc/sax2/DefaultHandler.hpp](DefaultHandler%5F8hpp%5Fsource.html)>

Public Member Functions
Default handlers for the DocumentHandler interface
virtual void	characters (const XMLCh *const chars, const XMLSize_t 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 uri, const XMLCh *const localname, const XMLCh *const qname)
	Receive notification of the end of an element.
virtual void	ignorableWhitespace (const XMLCh *const chars, const XMLSize_t 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	resetDocument ()
	Reset the Document object on its reuse.
Default implementation of DocumentHandler interface
virtual void	setDocumentLocator (const 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 uri, const XMLCh *const localname, const XMLCh *const qname, const Attributes &attrs)
	Receive notification of the start of an element.
virtual void	startPrefixMapping (const XMLCh *const prefix, const XMLCh *const uri)
	Receive notification of the start of an namespace prefix mapping.
virtual void	endPrefixMapping (const XMLCh *const prefix)
	Receive notification of the end of an namespace prefix mapping.
virtual void	skippedEntity (const XMLCh *const name)
	Receive notification of a skipped entity.
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 &exc)
	Receive notification of a recoverable parser error.
virtual void	fatalError (const SAXParseException &exc)
	Report a fatal XML parsing error.
virtual void	warning (const SAXParseException &exc)
	Receive notification of a parser warning.
virtual void	resetErrors ()
	Reset the Error handler object on its reuse.
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	resetDocType ()
	Reset the DTD object on its reuse.
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 LexicalHandler interface.
virtual void	comment (const XMLCh *const chars, const XMLSize_t length)
	Receive notification of comments.
virtual void	endCDATA ()
	Receive notification of the end of a CDATA section.
virtual void	endDTD ()
	Receive notification of the end of the DTD declarations.
virtual void	endEntity (const XMLCh *const name)
	Receive notification of the end of an entity.
virtual void	startCDATA ()
	Receive notification of the start of a CDATA section.
virtual void	startDTD (const XMLCh *const name, const XMLCh *const publicId, const XMLCh *const systemId)
	Receive notification of the start of the DTD declarations.
virtual void	startEntity (const XMLCh *const name)
	Receive notification of the start of an entity.
Public Member Functions inherited from EntityResolver
	EntityResolver ()
	Default Constructor.
virtual	~EntityResolver ()
	Destructor.
Public Member Functions inherited from DTDHandler
	DTDHandler ()
	Default Constructor.
virtual	~DTDHandler ()
	Destructor.
Public Member Functions inherited from ContentHandler
	ContentHandler ()
	Default constructor.
virtual	~ContentHandler ()
	Destructor.
Public Member Functions inherited from ErrorHandler
	ErrorHandler ()
	Default constructor.
virtual	~ErrorHandler ()
	Destructor.
Public Member Functions inherited from LexicalHandler
	LexicalHandler ()
	Default constructor.
virtual	~LexicalHandler ()
	Destructor.
Public Member Functions inherited from DeclHandler
	DeclHandler ()
	Default constructor.
virtual	~DeclHandler ()
	Destructor.

Default base class for SAX2 handlers.

This class implements the default behaviour for SAX2 interfaces: EntityResolver, DTDHandler, ContentHandler, ErrorHandler, LexicalHandler, and DeclHandler.

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.

See also

EntityResolver::EntityResolver

DTDHandler::DTDHandler

ContentHandler::ContentHandler

ErrorHandler::ErrorHandler

LexicalHandler::LexicalHandler

DeclHandler::DeclHandler

◆ ~DefaultHandler()

◆ attributeDecl()

Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported.

Parameters

Exceptions

Implements DeclHandler.

◆ characters()

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

Parameters

Exceptions

See also

DocumentHandler::characters

Implements ContentHandler.

◆ comment()

Receive notification of comments.

The Parser will call this method to report each occurrence of a comment in the XML document.

The application must not attempt to read from the array outside of the specified range.

Parameters

Exceptions

Implements LexicalHandler.

◆ elementDecl()

Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all parameter entities are fully resolved and all whitespace is removed,and will include the enclosing parentheses. Other normalization (such as removing redundant parentheses or simplifying occurrence indicators) is at the discretion of the parser.

Parameters

Exceptions

Implements DeclHandler.

◆ endCDATA()

Receive notification of the end of a CDATA section.

The SAX parser will invoke this method at the end of each CDATA parsed.

Exceptions

Implements LexicalHandler.

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

Exceptions

See also

DocumentHandler::endDocument

Implements ContentHandler.

◆ endDTD()

Receive notification of the end of the DTD declarations.

The SAX parser will invoke this method at the end of the DTD

Exceptions

Implements LexicalHandler.

◆ endElement()

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

Parameters

Exceptions

See also

DocumentHandler::endElement

Implements ContentHandler.

◆ endEntity()

Receive notification of the end of an entity.

The SAX parser will invoke this method at the end of an entity

Parameters

Exceptions

Implements LexicalHandler.

◆ endPrefixMapping()

Receive notification of the end of an namespace prefix mapping.

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

Parameters

Exceptions

See also

DocumentHandler::endPrefixMapping

Implements ContentHandler.

◆ error()

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.

Parameters

Exceptions

See also

ErrorHandler::warning

SAXParseException::SAXParseException

Implements ErrorHandler.

◆ externalEntityDecl()

Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.

Parameters

Exceptions

Implements DeclHandler.

◆ fatalError()

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.

Parameters

Exceptions

See also

ErrorHandler::fatalError

SAXParseException::SAXParseException

Implements ErrorHandler.

◆ ignorableWhitespace()

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

Parameters

Exceptions

See also

DocumentHandler::ignorableWhitespace

Implements ContentHandler.

◆ internalEntityDecl()

Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported. All parameter entities in the value will be expanded, but general entities will not.

Parameters

Exceptions

Implements DeclHandler.

◆ notationDecl()

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

See also

DTDHandler::notationDecl

Implements DTDHandler.

◆ processingInstruction()

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.

Parameters

Exceptions

See also

DocumentHandler::processingInstruction

Implements ContentHandler.

◆ resetDocType()

◆ resetDocument()

◆ resetErrors()

◆ resolveEntity()

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.

Parameters

Returns

The new input source, or null to require the default behaviour. The returned InputSource is owned by the parser which is responsible to clean up the memory.

Exceptions

See also

EntityResolver::resolveEntity

Implements EntityResolver.

◆ setDocumentLocator()

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

See also

DocumentHandler::setDocumentLocator

Locator

Implements ContentHandler.

◆ skippedEntity()

◆ startCDATA()

Receive notification of the start of a CDATA section.

The SAX parser will invoke this method at the start of each CDATA parsed.

Exceptions

Implements LexicalHandler.

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

Exceptions

See also

DocumentHandler::startDocument

Implements ContentHandler.

◆ startDTD()

Receive notification of the start of the DTD declarations.

The SAX parser will invoke this method at the start of the DTD

Parameters

Exceptions

Implements LexicalHandler.

◆ startElement()

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

Parameters

Exceptions

See also

DocumentHandler::startElement

Implements ContentHandler.

◆ startEntity()

Receive notification of the start of an entity.

The SAX parser will invoke this method at the start of an entity

Parameters

Exceptions

Implements LexicalHandler.

◆ startPrefixMapping()

Receive notification of the start of an namespace prefix 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 mapping.

Parameters

Exceptions

See also

DocumentHandler::startPrefixMapping

Implements ContentHandler.

◆ unparsedEntityDecl()

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

See also

DTDHandler::unparsedEntityDecl

Implements DTDHandler.

◆ warning()

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.

Parameters

Exceptions

See also

ErrorHandler::warning

SAXParseException::SAXParseException

Implements ErrorHandler.

The documentation for this class was generated from the following file:

• DefaultHandler.hpp