|
| | |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
SAX2XMLReader Class Reference#include <SAX2XMLReader.hpp>
List of all members.
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::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. |
|
|
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::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::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::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:
|
|
|
