|
OpenTop 1.3 | |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | Cross-Platform C++ | ||||
SUMMARY: CONSTRUCTOR | METHOD | DETAIL: CONSTRUCTOR | METHOD |
#include "ot/sax/InputSource.h"
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).
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(InputStream* pByteStream)
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.
systemId
- InputSource(Reader* pCharacterStream)
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.
InputSource(const String& systemId)
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.
byteStream
- Method Detail |
RefPtr< InputStream > getByteStream() const
The getEncoding() method will return the character encoding for this byte stream, or the empty string if unknown.
RefPtr< Reader > getCharacterStream() const
String getEncoding() const
String getPublicId() const
String getSystemId() const
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.
systemId
- void setByteStream(InputStream* pByteStream)
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.
byteStream
- void setCharacterStream(Reader* pCharacterStream)
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.
characterStream
- void setEncoding(const String& encoding)
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.
encoding
- void setPublicId(const String& publicId)
The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.
publicId
- void setSystemId(const String& systemId)
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.
systemId
-
|
OpenTop 1.3 | |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | Cross-Platform C++ | ||||
SUMMARY: CONSTRUCTOR | METHOD | DETAIL: CONSTRUCTOR | METHOD |