Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

saxIParser Interface Reference

Basic interface for SAX (Simple API for XML) parsers. More...

#include <saxIParser.idl>

Inheritance diagram for saxIParser

Inheritance graph

[legend]
Collaboration diagram for saxIParser:

Collaboration graph

[legend]
List of all members.

Public Methods

void parseInputSource (in saxIInputSource source)
 Parse an XML document. More...

void parseURI (in string uri)
 Parse an XML document from a system identifier (URI). More...

void setEntityResolver (in saxIEntityResolver resolver)
 Allow an application to register a custom entity resolver. More...

void setDTDHandler (in saxIDTDHandler handler)
 Allow an application to register a DTD event handler. More...

void setDocumentHandler (in saxIDocumentHandler handler)
 Allow an application to register a document event handler. More...

void setErrorHandler (in saxIErrorHandler handler)
 Allow an application to register an error event handler. More...


Detailed Description

Basic interface for SAX (Simple API for XML) parsers.

All SAX parsers must implement this basic interface: it allows applications to register handlers for different types of events and to initiate a parse from a URI, or a character stream.

All SAX parsers must also implement a zero-argument constructor (though other constructors are also allowed).

SAX parsers are reusable but not re-entrant: the application may reuse a parser object (possibly with a different input source) once the first parse has completed successfully, but it may not invoke the parse() methods recursively within a parse.

Version:
Revision:
See also:
EntityResolver::EntityResolver , DTDHandler::DTDHandler , DocumentHandler::DocumentHandler , ErrorHandler::ErrorHandler , HandlerBase::HandlerBase , InputSource::InputSource

Definition at line 45 of file saxIParser.idl.


Member Function Documentation

void saxIParser::parseInputSource ( in saxIInputSource source )
 

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.
See also:
InputSource::InputSource , parse(String) , setEntityResolver , setDTDHandler , setDocumentHandler , setErrorHandler

void saxIParser::parseURI ( in string uri )
 

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 InputSource(uri));

If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.

Parameters:
uri   The system identifier (URI).
See also:
parse(InputSource)

void saxIParser::setDTDHandler ( in saxIDTDHandler handler )
 

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 saxIParser::setDocumentHandler ( in saxIDocumentHandler handler )
 

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 saxIParser::setEntityResolver ( in saxIEntityResolver resolver )
 

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

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

void saxIParser::setErrorHandler ( in saxIErrorHandler handler )
 

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


The documentation for this interface was generated from the following file:
Generated at Tue Sep 12 17:04:53 2000 by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000