|
|
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
XMLEntityHandler Class ReferenceThis abstract class is a callback mechanism for the scanner.
More...
#include <XMLEntityHandler.hpp>
Inheritance diagram for XMLEntityHandler:
List of all members.Public Methods
|
|
|
- virtual void endInputSource (const InputSource& inputSource) = 0
- This method get called after the scanner has finished reading from the given input source while processing external entity references. More...
- virtual bool expandSystemId ( const XMLCh* const systemId , XMLBuffer& toFill ) = 0
- 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. More...
- virtual void resetEntities () = 0
- This method allows the entity handler to reset itself, so that it can be used again. More...
- virtual InputSource* resolveEntity ( const XMLCh* const publicId , const XMLCh* const systemId ) = 0
- This method allows the entity handler to provide customized application specific entity resolution. More...
- virtual void startInputSource (const InputSource& inputSource) = 0
- This method will be called before the scanner starts reading from an input source while processing external entity references. More...
Protected Methods
|
Detailed Description
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.
Constructor & Destructor Documentation
XMLEntityHandler::~XMLEntityHandler () [virtual] |
|
XMLEntityHandler::XMLEntityHandler () [protected] |
|
Protected default constructor.
Member Function Documentation
void XMLEntityHandler::endInputSource (
|
const InputSource & inputSource) [pure virtual] |
|
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
|
Reimplemented in DOMParser, and SAXParser.
bool XMLEntityHandler::expandSystemId (
|
const XMLCh * const systemId, |
|
XMLBuffer & toFill) [pure virtual] |
|
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.
|
Reimplemented in DOMParser, and SAXParser.
void XMLEntityHandler::resetEntities () [pure virtual] |
|
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.
Reimplemented in DOMParser, and SAXParser.
InputSource * XMLEntityHandler::resolveEntity (
|
const XMLCh * const publicId, |
|
const XMLCh * const systemId) [pure virtual] |
|
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.
|
Reimplemented in DOMParser, and SAXParser.
void XMLEntityHandler::startInputSource (
|
const InputSource & inputSource) [pure virtual] |
|
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.
|
Reimplemented in DOMParser, and SAXParser.
The documentation for this class was generated from the following file: