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

saxIInputSource Interface Reference

A single input source for an XML entity. More...

#include <saxIInputSource.idl>

Inheritance diagram for saxIInputSource

Inheritance graph

[legend]
Collaboration diagram for saxIInputSource:

Collaboration graph

[legend]
List of all members.

Public Methods

wstring getPublicId ()
 Get the public identifier for this input source. More...

wstring getSystemId ()
 Get the system identifier for this input source. More...

wstring getEncoding ()
 Get the character encoding for a byte stream or URI. More...

nsIInputStream getByteStream ()
 Get the byte stream for this input source. More...


Detailed Description

A single input source for an XML entity.

This class allows a SAX application to encapsulate information about an input source in a single object, which may include a public identifier or a system identifier

There are two places that the application will deliver this input source to the parser: as the argument to the Parser.parse method, or as the return value of the EntityResolver.resolveEntity method.

The SAX parser will use the InputSource object to determine how to read XML input. If there is a character stream available, the parser will read that stream directly; if not, the parser will use a byte stream, if available; if neither a character stream nor a byte stream is available, the parser will attempt to open a URI connection to the resource identified by the system identifier.

An InputSource object belongs to the application: the SAX parser shall never modify it in any way (it may modify a copy if necessary).

Version:
Revision:
See also:
Parser::parse , EntityResolver::resolveEntity , InputStream , Reader

Definition at line 46 of file saxIInputSource.idl.


Member Function Documentation

nsIInputStream saxIInputSource::getByteStream ( )
 

Get the byte stream for this input source.

The getEncoding method will return the character encoding for this byte stream, or null if unknown.

wstring saxIInputSource::getEncoding ( )
 

Get the character encoding for a byte stream or URI.

The encoding, or null if none was supplied.

wstring saxIInputSource::getPublicId ( )
 

Get the public identifier for this input source.

Returns:
The public identifier, or null if none was supplied.
See also:
setPublicId

wstring saxIInputSource::getSystemId ( )
 

Get the system identifier for this input source.

The getEncoding method will return the character encoding of the object pointed to, or null if unknown.

If the system ID is a URL, it will be fully resolved.

Returns:
The system identifier.
See also:
setSystemId , getEncoding


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