Cross-Platform C++

ot::sax
class InputSource

#include "ot/sax/InputSource.h"

ot::ManagedObject 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, a system identifier, a byte stream (possibly with a specified encoding), and/or a character stream.

There are two places that the application will deliver this input source to the parser: as the argument to the XMLReader::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 URL 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).

See also:
XMLReader::parse() , EntityResolver::resolveEntity() , io::InputStream , io::Reader



Constructor/Destructor Summary
InputSource()
         Default constructor.
InputSource(InputStream* pByteStream)
         Create a new input source with a system identifier.
InputSource(Reader* pCharacterStream)
         Create a new input source with a character stream.
InputSource(const String& systemId)
         Create a new input source with a byte stream.

Method Summary
 RefPtr< InputStream > getByteStream() const
         Get the byte stream for this input source.
 RefPtr< Reader > getCharacterStream() const
         Get the character stream for this input source.
 String getEncoding() const
         Get the character encoding for a byte stream or URI.
 String getPublicId() const
         Get the public identifier for this input source.
 String getSystemId() const
         Set the system identifier for this input source.
 void setByteStream(InputStream* pByteStream)
         Set the byte stream for this input source.
 void setCharacterStream(Reader* pCharacterStream)
         Set the character stream for this input source.
 void setEncoding(const String& encoding)
         Set the character encoding, if known.
 void setPublicId(const String& publicId)
         Set the public identifier for this input source.
 void setSystemId(const String& systemId)
         Set the system identifier for this input source.

Methods inherited from class ot::ManagedObject
addRef, getRefCount, onFinalRelease, operator=, release

Constructor/Destructor Detail

InputSource

 InputSource()
Default constructor.


InputSource

 InputSource(InputStream* pByteStream)
Create a new input source with a system identifier.

Applications may use setPublicId() to include a public identifier as well, or setEncoding() to specify the character encoding, if known.

If the system identifier is a URL, it should be full resolved.

Parameters:
systemId - The system identifier (URI).
See also:
setPublicId() , setSystemId() , setByteStream() , setEncoding() , setCharacterStream()

InputSource

 InputSource(Reader* pCharacterStream)
Create a new input source with a character stream.

Application writers may use setSystemId() to provide a base for resolving relative URIs, and setPublicId() to include a public identifier.

The character stream must not include a byte order mark.

See also:
setPublicId() , setSystemId() , setByteStream() , setCharacterStream()

InputSource

 InputSource(const String& systemId)
Create a new input source with a byte stream.

Application writers may use setSystemId() to provide a base for resolving relative URIs, setPublicId() to include a public identifier, and/or setEncoding() to specify the byte stream's character encoding.

Parameters:
byteStream - The raw byte stream containing the document.
See also:
setPublicId() , setSystemId() , setEncoding() , setByteStream() , setCharacterStream()

Method Detail

getByteStream

RefPtr< InputStreamgetByteStream() const
Get the byte stream for this input source.

The getEncoding() method will return the character encoding for this byte stream, or the empty string if unknown.

Returns:
The byte stream, or null if none was supplied.
See also:
getEncoding() , setByteStream()

getCharacterStream

RefPtr< ReadergetCharacterStream() const
Get the character stream for this input source.

Returns:
The character stream, or null if none was supplied.
See also:
setCharacterStream()

getEncoding

String getEncoding() const
Get the character encoding for a byte stream or URI.

Returns:
The encoding, or the empty string if none was supplied.
See also:
setByteStream() , getSystemId() , getByteStream()

getPublicId

String getPublicId() const
Get the public identifier for this input source.

Returns:
The public identifier, or the empty string if none was supplied.
See also:
setPublicId()

getSystemId

String getSystemId() const
Set the system identifier for this input source.

The system identifier is optional if there is a byte stream or a character stream, but it is still useful to provide one, since the application can use it to resolve relative URIs and can include it in error messages and warnings (the parser will attempt to open a connection to the URI only if there is no byte stream or character stream specified).

If the application knows the character encoding of the object pointed to by the system identifier, it can specify the encoding using the setEncoding() method.

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

Parameters:
systemId - The system identifier as a string.
See also:
setEncoding() , getSystemId() , Locator::getSystemId() , SAXParseException::getSystemId()

setByteStream

void setByteStream(InputStream* pByteStream)
Set the byte stream for this input source.

The SAX parser will ignore this if there is also a character stream specified, but it will use a byte stream in preference to opening a URL connection itself.

If the application knows the character encoding of the byte stream, it should set it with the setEncoding() method.

Parameters:
byteStream - A byte stream containing an XML document or other entity.
See also:
setEncoding() , getByteStream() , getEncoding() , io::InputStream

setCharacterStream

void setCharacterStream(Reader* pCharacterStream)
Set the character stream for this input source.

If there is a character stream specified, the SAX parser will ignore any byte stream and will not attempt to open a URL connection to the system identifier.

Parameters:
characterStream - The character stream containing the XML document or other entity.
See also:
getCharacterStream() , io::Reader

setEncoding

void setEncoding(const String& encoding)
Set the character encoding, if known.

The encoding must be a string acceptable for an XML encoding declaration (see section 4.3.3 of the XML 1.0 recommendation).

This method has no effect when the application provides a character stream.

Parameters:
encoding - A string describing the character encoding.
See also:
setSystemId() , setByteStream() , getEncoding()

setPublicId

void setPublicId(const String& publicId)
Set the public identifier for this input source.

The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.

Parameters:
publicId - The public identifier as a string.
See also:
getPublicId , Locator::getPublicId() , SAXParseException::getPublicId()

setSystemId

void setSystemId(const String& systemId)
Set the system identifier for this input source.

The system identifier is optional if there is a byte stream or a character stream, but it is still useful to provide one, since the application can use it to resolve relative URIs and can include it in error messages and warnings (the parser will attempt to open a connection to the URI only if there is no byte stream or character stream specified).

If the application knows the character encoding of the object pointed to by the system identifier, it can specify the encoding using the setEncoding() method.

If the system identifier is a URL, it should be fully resolved.

Parameters:
systemId - The system identifier as a string.
See also:
setEncoding() , getSystemId() , Locator::getSystemId() , SAXParseException::getSystemId()


Cross-Platform C++

Found a bug or missing feature? Please email us at support@elcel.com

Copyright © 2000-2003 ElCel Technology   Trademark Acknowledgements