Class InputSource
A single input source for an XML entity.
Inheritance
Inherited Members
Namespace: Sax
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class InputSourceRemarks
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.
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 can deliver an input source to the parser: as the argument to the IParser.Parse(InputSource) method, or as the return value of the ResolveEntity(String, String) 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, disregarding any text encoding declaration found in that stream. If there is no character stream, but there is a byte stream, the parser will use that byte stream, using the encoding specified in the InputSource or else (if no encoding is specified) autodetecting the character encoding using an algorithm such as the one in the XML specification. 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). However, standard processing of both byte and character streams is to close them on as part of end-of-parse cleanup, so applications should not attempt to re-use such streams after they have been handed to a parser.
Constructors
| Improve this Doc View SourceInputSource()
Zero-argument default constructor.
Declaration
public InputSource()See Also
| Improve this Doc View SourceInputSource(Stream)
Create a new input source with a byte stream.
Declaration
public InputSource(Stream byteStream)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | byteStream | The raw byte stream containing the document. |
Remarks
Application writers should use SystemId to provide a base for resolving relative URIs, may use PublicId to include a public identifier, and may use Encoding to specify the object's character encoding.
See Also
| Improve this Doc View SourceInputSource(TextReader)
Create a new input source with a character stream.
Declaration
public InputSource(TextReader characterStream)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.TextReader | characterStream |
Remarks
Application writers should use SystemId to provide a base for resolving relative URIs, and may use PublicId to include a public identifier.
The character stream shall not include a byte order mark.
See Also
| Improve this Doc View SourceInputSource(String)
Create a new input source with a system identifier.
Declaration
public InputSource(string systemId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | systemId | The system identifier (URI). |
Remarks
Applications may use PublicId to include a public identifier as well, or Encoding to specify the character encoding, if known.
If the system identifier is a URL, it must be fully resolved (it may not be a relative URL).
See Also
Properties
| Improve this Doc View SourceEncoding
Gets or Sets the character encoding.
Declaration
public virtual Encoding Encoding { get; set; }Property Value
| Type | Description |
|---|---|
| System.Text.Encoding |
Remarks
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.
See Also
| Improve this Doc View SourcePublicId
Gets or Sets the public identifier for this input source.
Declaration
public virtual string PublicId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.
See Also
| Improve this Doc View SourceStream
Gets or Sets the byte stream for this input source.
Declaration
public virtual Stream Stream { get; set; }Property Value
| Type | Description |
|---|---|
| System.IO.Stream |
Remarks
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 URI connection itself.
If the application knows the character encoding of the byte stream, it should set it with the setEncoding method.
See Also
| Improve this Doc View SourceSystemId
Gets or Sets the system identifier for this input source.
Declaration
public virtual string SystemId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
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 register the encoding using the Encoding property setter.
If the system identifier is a URL, it must be fully resolved(it may not be a relative URL).
See Also
| Improve this Doc View SourceTextReader
Gets or Sets the character stream for this input source.
Declaration
public virtual TextReader TextReader { get; set; }Property Value
| Type | Description |
|---|---|
| System.IO.TextReader |
Remarks
If there is a character stream specified, the SAX parser will ignore any byte stream and will not attempt to open a URI connection to the system identifier.