

























|
| |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
SAX2XMLReader Class Reference#include <SAX2XMLReader.hpp>
List of all members.
Public Types |
enum | ValSchemes { Val_Never,
Val_Always,
Val_Auto
} |
Public Methods |
|
| SAX2XMLReader () |
| The default constructor.
|
virtual | ~SAX2XMLReader () |
| The destructor.
|
|
virtual int | getErrorCount ()const=0 |
| Get error count from the last parse operation. More...
|
virtual ContentHandler* | getContentHandler ()const=0 |
| This method returns the installed content handler. More...
|
virtual DTDHandler* | getDTDHandler ()const=0 |
| This method returns the installed DTD handler. More...
|
virtual EntityResolver* | getEntityResolver ()const=0 |
| This method returns the installed entity resolver. More...
|
virtual ErrorHandler* | getErrorHandler ()const=0 |
| This method returns the installed error handler. More...
|
virtual LexicalHandler* | getLexicalHandler ()const=0 |
| This method returns the installed lexical handler. More...
|
virtual bool | getFeature (const XMLCh *const name)const=0 |
| Query the current state of any feature in a SAX2 XMLReader. More...
|
virtual void* | getProperty (const XMLCh *const name)const=0 |
| Query the current value of a property in a SAX2 XMLReader. More...
|
virtual bool | getExitOnFirstFatalError ()const=0 |
| This method returns the state of the parser's exit-on-First-Fatal-Error flag. More...
|
virtual bool | getValidationConstraintFatal ()const=0 |
| This method returns the state of the parser's validation-constraint-fatal flag. More...
|
virtual void | parse (const InputSource &source)=0 |
| Parse an XML document. More...
|
virtual void | parse (const XMLCh *const systemId)=0 |
| Parse an XML document from a system identifier (URI). More...
|
virtual void | parse (const char *const systemId)=0 |
| Parse an XML document from a system identifier (URI). More...
|
virtual void | setContentHandler (ContentHandler *const handler)=0 |
| Allow an application to register a document event handler. More...
|
virtual void | setDTDHandler (DTDHandler *const handler)=0 |
| Allow an application to register a DTD event handler. More...
|
virtual void | setEntityResolver (EntityResolver *const resolver)=0 |
| Allow an application to register a custom entity resolver. More...
|
virtual void | setErrorHandler (ErrorHandler *const handler)=0 |
| Allow an application to register an error event handler. More...
|
virtual void | setLexicalHandler (LexicalHandler *const handler)=0 |
| Allow an application to register a lexical event handler. More...
|
virtual void | setExitOnFirstFatalError (const bool newState)=0 |
| This method allows users to set the parser's behaviour when it encounters the first fatal error. More...
|
virtual void | setValidationConstraintFatal (const bool newState)=0 |
| This method allows users to set the parser's behaviour when it encounters a validtion constraint error. More...
|
virtual void | setFeature (const XMLCh *const name,const bool value)=0 |
| Set the state of any feature in a SAX2 XMLReader. More...
|
virtual void | setProperty (const XMLCh *const name,void *value)=0 |
| Set the value of any property in a SAX2 XMLReader. More...
|
|
virtual bool | parseFirst (const XMLCh *const systemId,XMLPScanToken &toFill,const bool reuseGrammar=false)=0 |
| Begin a progressive parse operation. More...
|
virtual bool | parseFirst (const char *const systemId,XMLPScanToken &toFill,const bool reuseGrammar=false)=0 |
| Begin a progressive parse operation. More...
|
virtual bool | parseFirst (const InputSource &source,XMLPScanToken &toFill,const bool reuseGrammar=false)=0 |
| Begin a progressive parse operation. More...
|
virtual bool | parseNext (XMLPScanToken &token)=0 |
| Continue a progressive parse operation. More...
|
virtual void | parseReset (XMLPScanToken &token)=0 |
| Reset the parser after a progressive parse. More...
|
|
virtual void | setValidator (XMLValidator *valueToAdopt)=0 |
| This method is used to set a validator. More...
|
virtual XMLValidator* | getValidator ()const=0 |
| This method is used to get the current validator. More...
|
|
virtual void | installAdvDocHandler (XMLDocumentHandler *const toInstall)=0 |
| This method installs the specified 'advanced' document callback handler, thereby allowing the user to customize the processing, if they choose to do so. More...
|
virtual bool | removeAdvDocHandler (XMLDocumentHandler *const toRemove)=0 |
| This method removes the 'advanced' document handler callback from the underlying parser scanner. More...
|
Member Enumeration Documentation
enum SAX2XMLReader::ValSchemes
|
|
|
-
Enumeration values:
-
Val_Never
|
|
Val_Always
|
|
Val_Auto
|
|
|
Constructor & Destructor Documentation
SAX2XMLReader::SAX2XMLReader (
|
)
|
|
SAX2XMLReader::~SAX2XMLReader (
|
) [virtual]
|
|
Member Function Documentation
ContentHandler * SAX2XMLReader::getContentHandler (
|
) const [pure virtual]
|
|
|
This method returns the installed content handler.
-
Returns:
-
A pointer to the installed content handler object.
|
DTDHandler * SAX2XMLReader::getDTDHandler (
|
) const [pure virtual]
|
|
|
This method returns the installed DTD handler.
-
Returns:
-
A pointer to the installed DTD handler object.
|
EntityResolver * SAX2XMLReader::getEntityResolver (
|
) const [pure virtual]
|
|
|
This method returns the installed entity resolver.
-
Returns:
-
A pointer to the installed entity resolver object.
|
int SAX2XMLReader::getErrorCount (
|
) const [pure virtual]
|
|
|
Get error count from the last parse operation.
This method returns the error count from the last parse operation. Note that this count is actually stored in the scanner, so this method simply returns what the scanner reports.
-
Returns:
-
number of errors encountered during the latest parse operation.
|
ErrorHandler * SAX2XMLReader::getErrorHandler (
|
) const [pure virtual]
|
|
|
This method returns the installed error handler.
-
Returns:
-
A pointer to the installed error handler object.
|
bool SAX2XMLReader::getExitOnFirstFatalError (
|
) const [pure virtual]
|
|
|
This method returns the state of the parser's exit-on-First-Fatal-Error flag.
-
Returns:
-
true, if the parser is currently configured to exit on the first fatal error, false otherwise.
-
See also:
-
setExitOnFirstFatalError
|
bool SAX2XMLReader::getFeature (
|
const XMLCh *const name ) const [pure virtual]
|
|
|
Query the current state of any feature in a SAX2 XMLReader.
-
Parameters:
-
name
|
The unique identifier (URI) of the feature being set. |
-
Returns:
-
The current state of the feature.
-
Exceptions:
-
SAXNotRecognizedException
|
If the requested feature is not known. |
|
LexicalHandler * SAX2XMLReader::getLexicalHandler (
|
) const [pure virtual]
|
|
|
This method returns the installed lexical handler.
-
Returns:
-
A pointer to the installed lexical handler object.
|
void * SAX2XMLReader::getProperty (
|
const XMLCh *const name ) const [pure virtual]
|
|
|
Query the current value of a property in a SAX2 XMLReader.
-
Parameters:
-
name
|
The unique identifier (URI) of the property being set. |
-
Returns:
-
The current value of the property.
-
Exceptions:
-
SAXNotRecognizedException
|
If the requested property is not known. |
|
bool SAX2XMLReader::getValidationConstraintFatal (
|
) const [pure virtual]
|
|
|
This method returns the state of the parser's validation-constraint-fatal flag.
-
Returns:
-
true, if the parser is currently configured to set validation constraint errors as fatal, false otherwise.
-
See also:
-
setValidationContraintFatal
|
XMLValidator * SAX2XMLReader::getValidator (
|
) const [pure virtual]
|
|
|
This method is used to get the current validator.
SAX2XMLReader assumes responsibility for the validator. It will be deleted when the XMLReader is destroyed.
-
Returns:
-
A pointer to the validator. An application should not deleted the object returned.
|
void SAX2XMLReader::installAdvDocHandler (
|
XMLDocumentHandler *const toInstall ) [pure virtual]
|
|
|
This method installs the specified 'advanced' document callback handler, thereby allowing the user to customize the processing, if they choose to do so.
Any number of advanced callback handlers maybe installed.
The methods in the advanced callback interface represent Xerces-C extensions. There is no specification for this interface. -
Parameters:
-
toInstall
|
A pointer to the users advanced callback handler.
|
-
See also:
-
removeAdvDocHandler
|
void SAX2XMLReader::parse (
|
const char *const systemId ) [pure virtual]
|
|
|
Parse an XML document from a system identifier (URI).
This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:
parse(new URLInputSource(systemId));
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser. -
Parameters:
-
systemId
|
The system identifier (URI). |
-
Exceptions:
-
SAXException
|
Any SAX exception, possibly wrapping another exception. |
XMLException
|
An exception from the parser or client handler code. |
-
See also:
-
parse(InputSource)
|
void SAX2XMLReader::parse (
|
const XMLCh *const systemId ) [pure virtual]
|
|
|
Parse an XML document from a system identifier (URI).
This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:
parse(new URLInputSource(systemId));
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser. -
Parameters:
-
systemId
|
The system identifier (URI). |
-
Exceptions:
-
SAXException
|
Any SAX exception, possibly wrapping another exception. |
XMLException
|
An exception from the parser or client handler code. |
-
See also:
-
parse(InputSource)
|
void SAX2XMLReader::parse (
|
const InputSource & source ) [pure virtual]
|
|
|
Parse an XML document.
The application can use this method to instruct the SAX parser to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).
Applications may not invoke this method while a parse is in progress (they should create a new Parser instead for each additional XML document). Once a parse is complete, an application may reuse the same Parser object, possibly with a different input source. -
Parameters:
-
source
|
The input source for the top-level of the XML document. |
-
Exceptions:
-
SAXException
|
Any SAX exception, possibly wrapping another exception. |
XMLException
|
An exception from the parser or client handler code. |
-
See also:
-
InputSource::InputSource , setEntityResolver , setDTDHandler , setDocumentHandler , setErrorHandler
|
bool SAX2XMLReader::parseFirst (
|
const InputSource & source,
|
|
XMLPScanToken & toFill,
|
|
const bool reuseGrammar = false ) [pure virtual]
|
|
|
Begin a progressive parse operation.
This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.
It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls. -
Parameters:
-
source
|
A const reference to the InputSource object which points to the XML file to be parsed. |
toFill
|
A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls. |
reuseGrammar
|
The flag indicating whether the existing Grammar should be reused or not for this parsing run. If true, there cannot be any internal subset.
|
-
Returns:
-
'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not parse the prolog.
-
See also:
-
parseNext , parseFirst(XMLCh*,...) , parseFirst(char*,...)
|
bool SAX2XMLReader::parseFirst (
|
const char *const systemId,
|
|
XMLPScanToken & toFill,
|
|
const bool reuseGrammar = false ) [pure virtual]
|
|
|
Begin a progressive parse operation.
This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.
It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls. -
Parameters:
-
systemId
|
A pointer to a regular native string represting the path to the XML file to be parsed. |
toFill
|
A token maintaing state information to maintain internal consIstency between invocation of 'parseNext' calls. |
reuseGrammar
|
The flag indicating whether the existing Grammar should be reused or not for this parsing run. If true, there cannot be any internal subset.
|
-
Returns:
-
'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not parse the prolog.
-
See also:
-
parseNext , parseFirst(XMLCh*,...) , parseFirst(InputSource&,...)
|
bool SAX2XMLReader::parseFirst (
|
const XMLCh *const systemId,
|
|
XMLPScanToken & toFill,
|
|
const bool reuseGrammar = false ) [pure virtual]
|
|
|
Begin a progressive parse operation.
This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.
It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls. -
Parameters:
-
systemId
|
A pointer to a Unicode string represting the path to the XML file to be parsed. |
toFill
|
A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls. |
reuseGrammar
|
The flag indicating whether the existing Grammar should be reused or not for this parsing run. If true, there cannot be any internal subset.
|
-
Returns:
-
'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could parse the prolog (which means the token will not be valid.)
-
See also:
-
parseNext , parseFirst(char*,...) , parseFirst(InputSource&,...)
|
bool SAX2XMLReader::parseNext (
|
XMLPScanToken & token ) [pure virtual]
|
|
|
Continue a progressive parse operation.
This method is used to continue with progressive parsing of XML files started by a call to 'parseFirst' method.
It parses the XML file and stops as soon as it comes across a XML token (as defined in the XML specification). Relevant callback handlers are invoked as required by the SAX specification. -
Parameters:
-
token
|
A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.
|
-
Returns:
-
'true', if successful in parsing the next XML token. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not find next token as per the XML specification production rule.
-
See also:
-
parseFirst(XMLCh*,...) , parseFirst(char*,...) , parseFirst(InputSource&,...)
|
void SAX2XMLReader::parseReset (
|
XMLPScanToken & token ) [pure virtual]
|
|
|
Reset the parser after a progressive parse.
If a progressive parse loop exits before the end of the document is reached, the parser has no way of knowing this. So it will leave open any files or sockets or memory buffers that were in use at the time that the parse loop exited.
The next parse operation will cause these open files and such to be closed, but the next parse operation might occur at some unknown future point. To avoid this problem, you should reset the parser if you exit the loop early.
If you exited because of an error, then this cleanup will be done for you. Its only when you exit the file prematurely of your own accord, because you've found what you wanted in the file most likely. -
Parameters:
-
token
|
A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls. |
|
bool SAX2XMLReader::removeAdvDocHandler (
|
XMLDocumentHandler *const toRemove ) [pure virtual]
|
|
|
This method removes the 'advanced' document handler callback from the underlying parser scanner.
If no handler is installed, advanced callbacks are not invoked by the scanner. -
Parameters:
-
toRemove
|
A pointer to the advanced callback handler which should be removed.
|
-
See also:
-
installAdvDocHandler
|
void SAX2XMLReader::setContentHandler (
|
ContentHandler *const handler ) [pure virtual]
|
|
|
Allow an application to register a document event handler.
If the application does not register a document handler, all document events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by HandlerBase).
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately. -
Parameters:
-
handler
|
The document handler. |
-
See also:
-
DocumentHandler::DocumentHandler , HandlerBase::HandlerBase
|
void SAX2XMLReader::setDTDHandler (
|
DTDHandler *const handler ) [pure virtual]
|
|
|
Allow an application to register a DTD event handler.
If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by HandlerBase).
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately. -
Parameters:
-
-
See also:
-
DTDHandler::DTDHandler , HandlerBase::HandlerBase
|
void SAX2XMLReader::setEntityResolver (
|
EntityResolver *const resolver ) [pure virtual]
|
|
|
Allow an application to register a custom entity resolver.
If the application does not register an entity resolver, the SAX parser will resolve system identifiers and open connections to entities itself (this is the default behaviour implemented in DefaultHandler).
Applications may register a new or different entity resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately. -
Parameters:
-
resolver
|
The object for resolving entities. |
-
See also:
-
EntityResolver::EntityResolver , DefaultHandler::DefaultHandler
|
void SAX2XMLReader::setErrorHandler (
|
ErrorHandler *const handler ) [pure virtual]
|
|
|
Allow an application to register an error event handler.
If the application does not register an error event handler, all error events reported by the SAX parser will be silently ignored, except for fatalError, which will throw a SAXException (this is the default behaviour implemented by HandlerBase).
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately. -
Parameters:
-
handler
|
The error handler. |
-
See also:
-
ErrorHandler::ErrorHandler , SAXException::SAXException , HandlerBase::HandlerBase
|
void SAX2XMLReader::setExitOnFirstFatalError (
|
const bool newState ) [pure virtual]
|
|
|
This method allows users to set the parser's behaviour when it encounters the first fatal error.
If set to true, the parser will exit at the first fatal error. If false, then it will report the error and continue processing.
The default value is 'true' and the parser exits on the first fatal error. -
Parameters:
-
newState
|
The value specifying whether the parser should continue or exit when it encounters the first fatal error.
|
-
See also:
-
getExitOnFirstFatalError
|
void SAX2XMLReader::setFeature (
|
const XMLCh *const name,
|
|
const bool value ) [pure virtual]
|
|
void SAX2XMLReader::setLexicalHandler (
|
LexicalHandler *const handler ) [pure virtual]
|
|
|
Allow an application to register a lexical event handler.
If the application does not register a lexical handler, all events reported by the SAX parser will be silently ignored. (this is the default behaviour implemented by HandlerBase).
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately. -
Parameters:
-
handler
|
The error handler. |
-
See also:
-
LexicalHandler::LexicalHandler , SAXException::SAXException , HandlerBase::HandlerBase
|
void SAX2XMLReader::setProperty (
|
const XMLCh *const name,
|
|
void * value ) [pure virtual]
|
|
|
Set the value of any property in a SAX2 XMLReader.
Supported property in SAX2 for xerces-c are:
none -
Parameters:
-
name
|
The unique identifier (URI) of the property being set. |
value
|
The requested value for the property. |
-
Exceptions:
-
SAXNotRecognizedException
|
If the requested property is not known. |
SAXNotSupportedException
|
Property modification is not supported during parse |
|
void SAX2XMLReader::setValidationConstraintFatal (
|
const bool newState ) [pure virtual]
|
|
|
This method allows users to set the parser's behaviour when it encounters a validtion constraint error.
If set to true, and the the parser is set to exit when it encounter the first fatal error, the parser will exit at the first encounter. If false, then it will report the error and continue processing.
The default value is 'false'. -
Parameters:
-
newState
|
The value specifying whether the parser should continue or exit when it encounters a validation constraint error.
|
-
See also:
-
getValidationConstraintFatal
|
void SAX2XMLReader::setValidator (
|
XMLValidator * valueToAdopt ) [pure virtual]
|
|
|
This method is used to set a validator.
SAX2XMLReader assumes responsibility for the validator. It will be deleted when the XMLReader is destroyed. -
Parameters:
-
valueToAdopt
|
A pointer to the validator that the reader should use. |
|
The documentation for this class was generated from the following file:
|
|
|