org.apache.xerces.xni.parser

Class XMLInputSource

public class XMLInputSource extends Object

This class represents an input source for an XML document. The basic properties of an input source are the following:

Version: $Id: XMLInputSource.java,v 1.5 2004/02/24 23:15:56 mrglavas Exp $

Author: Andy Clark, IBM

Field Summary
protected StringfBaseSystemId
Base system identifier.
protected InputStreamfByteStream
Byte stream.
protected ReaderfCharStream
Character stream.
protected StringfEncoding
Encoding.
protected StringfPublicId
Public identifier.
protected StringfSystemId
System identifier.
Constructor Summary
XMLInputSource(String publicId, String systemId, String baseSystemId)
Constructs an input source from just the public and system identifiers, leaving resolution of the entity and opening of the input stream up to the caller.
XMLInputSource(XMLResourceIdentifier resourceIdentifier)
Constructs an input source from a XMLResourceIdentifier object, leaving resolution of the entity and opening of the input stream up to the caller.
XMLInputSource(String publicId, String systemId, String baseSystemId, InputStream byteStream, String encoding)
Constructs an input source from a byte stream.
XMLInputSource(String publicId, String systemId, String baseSystemId, Reader charStream, String encoding)
Constructs an input source from a character stream.
Method Summary
StringgetBaseSystemId()
Returns the base system identifier.
InputStreamgetByteStream()
Returns the byte stream.
ReadergetCharacterStream()
Returns the character stream.
StringgetEncoding()
Returns the encoding of the stream, or null if not known.
StringgetPublicId()
Returns the public identifier.
StringgetSystemId()
Returns the system identifier.
voidsetBaseSystemId(String baseSystemId)
Sets the base system identifier.
voidsetByteStream(InputStream byteStream)
Sets the byte stream.
voidsetCharacterStream(Reader charStream)
Sets the character stream.
voidsetEncoding(String encoding)
Sets the encoding of the stream.
voidsetPublicId(String publicId)
Sets the public identifier.
voidsetSystemId(String systemId)
Sets the system identifier.

Field Detail

fBaseSystemId

protected String fBaseSystemId
Base system identifier.

fByteStream

protected InputStream fByteStream
Byte stream.

fCharStream

protected Reader fCharStream
Character stream.

fEncoding

protected String fEncoding
Encoding.

fPublicId

protected String fPublicId
Public identifier.

fSystemId

protected String fSystemId
System identifier.

Constructor Detail

XMLInputSource

public XMLInputSource(String publicId, String systemId, String baseSystemId)
Constructs an input source from just the public and system identifiers, leaving resolution of the entity and opening of the input stream up to the caller.

Parameters: publicId The public identifier, if known. systemId The system identifier. This value should always be set, if possible, and can be relative or absolute. If the system identifier is relative, then the base system identifier should be set. baseSystemId The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.

XMLInputSource

public XMLInputSource(XMLResourceIdentifier resourceIdentifier)
Constructs an input source from a XMLResourceIdentifier object, leaving resolution of the entity and opening of the input stream up to the caller.

Parameters: resourceIdentifier the XMLResourceIdentifier containing the information

XMLInputSource

public XMLInputSource(String publicId, String systemId, String baseSystemId, InputStream byteStream, String encoding)
Constructs an input source from a byte stream.

Parameters: publicId The public identifier, if known. systemId The system identifier. This value should always be set, if possible, and can be relative or absolute. If the system identifier is relative, then the base system identifier should be set. baseSystemId The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible. byteStream The byte stream. encoding The encoding of the byte stream, if known.

XMLInputSource

public XMLInputSource(String publicId, String systemId, String baseSystemId, Reader charStream, String encoding)
Constructs an input source from a character stream.

Parameters: publicId The public identifier, if known. systemId The system identifier. This value should always be set, if possible, and can be relative or absolute. If the system identifier is relative, then the base system identifier should be set. baseSystemId The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible. charStream The character stream. encoding The original encoding of the byte stream used by the reader, if known.

Method Detail

getBaseSystemId

public String getBaseSystemId()
Returns the base system identifier.

getByteStream

public InputStream getByteStream()
Returns the byte stream.

getCharacterStream

public Reader getCharacterStream()
Returns the character stream.

getEncoding

public String getEncoding()
Returns the encoding of the stream, or null if not known.

getPublicId

public String getPublicId()
Returns the public identifier.

getSystemId

public String getSystemId()
Returns the system identifier.

setBaseSystemId

public void setBaseSystemId(String baseSystemId)
Sets the base system identifier.

Parameters: baseSystemId The new base system identifier.

setByteStream

public void setByteStream(InputStream byteStream)
Sets the byte stream. If the byte stream is not already opened when this object is instantiated, then the code that opens the stream should also set the byte stream on this object. Also, if the encoding is auto-detected, then the encoding should also be set on this object.

Parameters: byteStream The new byte stream.

setCharacterStream

public void setCharacterStream(Reader charStream)
Sets the character stream. If the character stream is not already opened when this object is instantiated, then the code that opens the stream should also set the character stream on this object. Also, the encoding of the byte stream used by the reader should also be set on this object, if known.

Parameters: charStream The new character stream.

See Also: XMLInputSource

setEncoding

public void setEncoding(String encoding)
Sets the encoding of the stream.

Parameters: encoding The new encoding.

setPublicId

public void setPublicId(String publicId)
Sets the public identifier.

Parameters: publicId The new public identifier.

setSystemId

public void setSystemId(String systemId)
Sets the system identifier.

Parameters: systemId The new system identifier.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.