Interface Summary : IParser

Basic interface for SAX (Simple API for XML) parsers.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This was the main event supplier interface for SAX1; it has been replaced in SAX2 by IXMLReader, which includes Namespace support and sophisticated configurability and extensibility.

All SAX1 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 SAX1 parsers must also implement a zero-argument constructor (though other constructors are also allowed).

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


Deprecated : This interface has been replaced by the SAX2 {@IXMLReader IXMLReader} interface, which includes Namespace support.
Since : SAX 1.0
See : IEntityResolver
See : IDTDHandler
See : IDocumentHandler
See : IErrorHandler
See : TInputSource

Methods

procedure setLocale(SAXString)
procedure setEntityResolver(IEntityResolver)
procedure setDTDHandler(IDTDHandler)
procedure setDocumentHandler(IDocumentHandler)
procedure setErrorHandler(IErrorHandler)
procedure parse(IInputSource)
procedure parse(SAXString)


procedure setLocale(const locale : SAXString);

Allow an application to request a locale for errors and warnings.

SAX parsers are not required to provide localisation for errors and warnings; if they cannot support the requested locale, however, they must throw a SAX exception. Applications may not request a locale change in the middle of a parse.


Parameter : locale A string representing the locale. This can be used to determine a locale for the specific system
Exception : ESAXException Throws an exception (using the previous or default locale) if the requested locale is not supported.
See : ESAXException
See : ESAXParseException

Top


procedure setEntityResolver(const resolver : IEntityResolver);

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

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.


Parameter : resolver The object for resolving entities.
See : IEntityResolver

Top


procedure setDTDHandler(const handler : IDTDHandler);

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

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.


Parameter : handler The DTD handler.
See : IDTDHandler

Top


procedure setDocumentHandler(const handler : IDocumentHandler);

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

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.


Parameter : handler The document handler.
See : IDocumentHandler

Top


procedure setErrorHandler(const handler : IErrorHandler);

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 ESAXException

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.


Parameter : handler The error handler.
See : IErrorHandler
See : ESAXException

Top


procedure parse(const input : IInputSource);

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 IParser instead for each additional XML document). Once a parse is complete, an application may reuse the same IParser object, possibly with a different input source.


Parameter : source The input source for the top-level of the XML document.
Exception : ESAXException Any SAX exception.
Exception : Exception An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See : TInputSource
See : IParser.parse(SAXString)
See : IParser.setEntityResolver
See : IParser.setDTDHandler
See : IParser.setDocumentHandler
See : IParser.setErrorHandler

Top


procedure parse(const systemId : SAXString);

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:

 input:= TInputSource.Create(systemId) as IInputSource;
 try
   parse(input);
 finally
   input:= nil;
 end;
 

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


Parameter : systemId The system identifier (URI).
Exception : ESAXException Any SAX exception.
Exception : Exception An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See : IParser.parse(TInputSource)

Top