
	API Docs for SAX and DOM

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

Constructors and Destructor

SAX2XMLReader ()

The default constructor.

virtual ~SAX2XMLReader ()

The destructor.

The XMLReader interfaces

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 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 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...

Validator: setters and getters (Xerces-C specific)

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...

Member Enumeration Documentation

enum SAX2XMLReader::ValSchemes

Enumeration values:

Val_Never

Val_Always

Val_Auto

Constructor & Destructor Documentation

SAX2XMLReader::SAX2XMLReader ( )

The default constructor.

SAX2XMLReader::~SAX2XMLReader ( ) [virtual]

The destructor.

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.

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::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

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:

handler The DTD handler.

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]

Set the state of any feature in a SAX2 XMLReader.
Supported features in SAX2 for xerces-c are:

http://xml.org/sax/features/validation (default: true)
http://xml.org/sax/features/namespaces (default: true)
http://xml.org/sax/features/namespace-prefixes (default: true)
http://apache.org/xml/features/validation/dynamic (default: false)
http://apache.org/xml/features/validation/reuse-validator (default: false)
Parameters:

name The unique identifier (URI) of the feature.

value The requested state of the feature (true or false).

Exceptions:

SAXNotRecognizedException If the requested feature is not known.

SAXNotSupportedException Property modification is not supported during parse

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:

SAX2XMLReader.hpp