class XMLEntityHandler

This abstract class is a callback mechanism for the scanner

Inheritance:


Public

protected Constructor
XMLEntityHandler ()
Protected default constructor
Destructor
virtual ~XMLEntityHandler ()
Default destructor
The pure virtual methods in this interface.
virtual void endInputSource (const InputSource& inputSource)
This method get called after the scanner has finished reading from the given input source while processing external entity references
virtual bool expandSystemId ( const XMLCh* const systemId, XMLBuffer& toFill )
This method allows the passes the scanned systemId to the entity handler, thereby giving it a chance to provide any customized handling like resolving relative path names
virtual void resetEntities ()
This method allows the entity handler to reset itself, so that it can be used again
virtual InputSource* resolveEntity ( const XMLCh* const publicId, const XMLCh* const systemId )
This method allows the entity handler to provide customized application specific entity resolution
virtual void startInputSource (const InputSource& inputSource)
This method will be called before the scanner starts reading from an input source while processing external entity references

Documentation

This abstract class is a callback mechanism for the scanner. By creating a derivative of this class and plugging into the scanner, the scanner will call back on the object's methods to entity events. This class is primarily for use by those writing their own parser classes. If you use the standard parser classes, DOMParser and SAXParser, you won't use this API. You will instead use a similar mechanism defined by the SAX API, called EntityResolver.
Destructor

virtual ~XMLEntityHandler()
Default destructor

The pure virtual methods in this interface.

virtual void endInputSource(const InputSource& inputSource)
This method get called after the scanner has finished reading from the given input source while processing external entity references.
Parameters:
inputSource - The input source for the entity

virtual bool expandSystemId( const XMLCh* const systemId, XMLBuffer& toFill )
This method allows the passes the scanned systemId to the entity handler, thereby giving it a chance to provide any customized handling like resolving relative path names. The scanner first calls this method before calling resolveEntity.
Parameters:
systemId - The system id extracted by the scanner from the input source.
toFill - The buffer in which the fully expanded system id needs to be stored.

virtual void resetEntities()
This method allows the entity handler to reset itself, so that it can be used again. It is called prior to a new document parse operation.

virtual InputSource* resolveEntity( const XMLCh* const publicId, const XMLCh* const systemId )
This method allows the entity handler to provide customized application specific entity resolution. This method is defined by SAX 1.0 API.
Parameters:
systemId - The system id of the external entity reference.
publicId - The public id of the external entity reference.

virtual void startInputSource(const InputSource& inputSource)
This method will be called before the scanner starts reading from an input source while processing external entity references.
Parameters:
inputSource - The external input source.

protected Constructor

XMLEntityHandler()
Protected default constructor


Direct child classes:
SAXParser
DOMParser

alphabetic index hierarchy of classes


Xerces-C XML Parser for C++ Version 1.1
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.

generated by doc++