Cross-Platform C++

ot::sax
class LexicalHandler  (abstract)

#include "ot/sax/LexicalHandler.h"

ot::ManagedObject SAX2 extension handler for lexical events.

This is an optional extension handler for SAX2 to provide lexical information about an XML document, such as comments and CDATA section boundaries; XML readers are not required to support this handler, and it is not part of the core SAX2 specification. The default XMLReader supplied with OpenTop does support the LexicalHandler interface.

The events in the lexical handler apply to the entire document, not just to the document element, and all lexical handler events appear between the content handler's startDocument and endDocument events.

To set the DeclHandler for an XML reader, use the XMLReader::setDeclHandler() method. This differs from the Java SAX 2.0 distribution, where it is necessary to to use a generic setProperty() method.




Method Summary
 virtual void comment(const CharType* pComment, size_t length)=0
         Report an XML comment anywhere in the document.
 virtual void endCDATA()=0
         Report the end of a CDATA section.
 virtual void endDTD()=0
         Report the end of DTD declarations.
 virtual void endEntity(const String& name)=0
         Report the end of an entity.
 virtual void startCDATA()=0
         Report the start of a CDATA section.
 virtual void startDTD(const String& name, const String& publicId, const String& systemId)=0
         Report the start of DTD declarations, if any.
 virtual void startEntity(const String& name)=0
         Report the beginning of some internal and external XML entities.

Methods inherited from class ot::ManagedObject
addRef, getRefCount, onFinalRelease, operator=, release

Method Detail

comment

virtual void comment(const CharType* pComment,
                     size_t length)=0
Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD will be properly nested inside start/endDTD and start/endEntity events (if used).

Note: comments will only be reported to the application when the feature http://elcel.com/sax/features/report-document-comments is set to true. See XMLReader::setFeature() for further information.

Parameters:
pComment - The start of a CharType array holding the characters in the comment.
length - The size of the array.
Exceptions:
SAXException - The application may throw an exception during processing. If so, the SAX XML parser will stop parsing the current document.
See also:
XMLReader::setFeature()

endCDATA

virtual void endCDATA()=0
Report the end of a CDATA section.

Exceptions:
SAXException - The application may throw an exception during processing. If so, the SAX XML parser will stop parsing the current document.
See also:
startCDATA()

endDTD

virtual void endDTD()=0
Report the end of DTD declarations.

This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

Exceptions:
SAXException - The application may throw an exception during processing. If so, the SAX XML parser will stop parsing the current document.
See also:
startDTD()

endEntity

virtual void endEntity(const String& name)=0
Report the end of an entity.

Parameters:
name - The name of the entity that is ending.
Exceptions:
SAXException - The application may throw an exception during processing. If so, the SAX XML parser will stop parsing the current document.
See also:
startEntity()

startCDATA

virtual void startCDATA()=0
Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular ContentHandler::characters() event; this event is intended only to report the boundary.

Exceptions:
SAXException - The application may throw an exception during processing. If so, the SAX XML parser will stop parsing the current document.
See also:
endCDATA()

startDTD

virtual void startDTD(const String& name,
                      const String& publicId,
                      const String& systemId)=0
Report the start of DTD declarations, if any.

This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

All declarations reported through DTDHandler or DeclHandler events must appear between the startDTD() and endDTD() events. Declarations are assumed to belong to the internal DTD subset unless they appear between startEntity() and endEntity() events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however.

Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first ContentHandler::startElement() event.

Parameters:
name - The document type name.
publicId - The declared public identifier for the external DTD subset, or the empty string if none was declared.
systemId - The declared system identifier for the external DTD subset, or the empty string if none was declared.
Exceptions:
SAXException - The application may throw an exception during processing. If so, the SAX XML parser will stop parsing the current document.
See also:
endDTD() , startEntity()

startEntity

virtual void startEntity(const String& name)=0
Report the beginning of some internal and external XML entities.

The reporting of parameter entities (including the external DTD subset) is controlled by the http://xml.org/sax/features/lexical-handler/parameter-entities feature which is false by default.

General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".

When a SAX2 driver is providing these events, all other events will be properly nested within start/endEntity events. There is no additional requirement that events from DeclHandler or DTDHandler be properly ordered.

Note that skipped entities will be reported through the ContentHandler::skippedEntity() event, which is part of the ContentHandler interface.

Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:

These will be silently expanded, with no indication of where the original entity boundaries were.

Note also that the boundaries of character references (which are not really entities anyway) are not reported.

All start/endEntity events will be properly nested.

Parameters:
name - The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".
Exceptions:
SAXException - The application may throw an exception during processing. If so, the SAX XML parser will stop parsing the current document.
See also:
endEntity() , DeclHandler::internalEntityDecl() , DeclHandler::externalEntityDecl()


Cross-Platform C++

Found a bug or missing feature? Please email us at support@elcel.com

Copyright © 2000-2003 ElCel Technology   Trademark Acknowledgements