File Doc Category Size Date Package
DOMInputImpl.java API Doc Java SE 5 API 17610 Fri Aug 26 14:55:42 BST 2005 com.sun.org.apache.xerces.internal.dom

DOMInputImpl

java.lang.Object

public class DOMInputImpl extends Object implements LSInput

This Class DOMInputImpl represents a single input source for an XML entity.

This Class allows an 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.

The exact definitions of a byte stream and a character stream are binding dependent.

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

The DOMParser will use the LSInput 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 LSInput object belongs to the application: the parser shall never modify it in any way (it may modify a copy if necessary). Eventhough all attributes in this interface are writable the DOM implementation is expected to never mutate a LSInput.

author: Gopal Sharma, SUN Microsystems Inc.
version: $Id: DOMInputImpl.java,v 1.2 2003/11/17 13:48:40 venu Exp $

Fields Summary
protected String
fPublicId
protected String
fSystemId
protected String
fBaseSystemId
protected InputStream
fByteStream
protected Reader
fCharStream
protected String
fData
protected String
fEncoding
protected boolean
fCertifiedText
Constructors Summary
public DOMInputImpl()
Default Constructor, constructs an input source
public DOMInputImpl(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.
param
publicId The public identifier, if known.
param
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.
param
baseSystemId The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.
fPublicId = publicId; fSystemId = systemId; fBaseSystemId = baseSystemId;
public DOMInputImpl(String publicId, String systemId, String baseSystemId, InputStream byteStream, String encoding)
Constructs an input source from a byte stream.
param
publicId The public identifier, if known.
param
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.
param
baseSystemId The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.
param
byteStream The byte stream.
param
encoding The encoding of the byte stream, if known.
fPublicId = publicId; fSystemId = systemId; fBaseSystemId = baseSystemId; fByteStream = byteStream; fEncoding = encoding;
public DOMInputImpl(String publicId, String systemId, String baseSystemId, Reader charStream, String encoding)
Constructs an input source from a character stream.
param
publicId The public identifier, if known.
param
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.
param
baseSystemId The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.
param
charStream The character stream.
param
encoding The original encoding of the byte stream used by the reader, if known.
fPublicId = publicId; fSystemId = systemId; fBaseSystemId = baseSystemId; fCharStream = charStream; fEncoding = encoding;
public DOMInputImpl(String publicId, String systemId, String baseSystemId, String data, String encoding)
Constructs an input source from a String.
param
publicId The public identifier, if known.
param
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.
param
baseSystemId The base system identifier. This value should always be set to the fully expanded URI of the base system identifier, if possible.
param
data The String Data.
param
encoding The original encoding of the byte stream used by the reader, if known.
fPublicId = publicId; fSystemId = systemId; fBaseSystemId = baseSystemId; fData = data; fEncoding = encoding;
Methods Summary
public java.lang.String getBaseURI()
The base URI to be used (see section 5.1.4 in ) for resolving relative URIs to absolute URIs. If the baseURI is itself a relative URI, the behavior is implementation dependent.
return fBaseSystemId;
public java.io.InputStream getByteStream()
An attribute of a language-binding dependent type that represents a stream of bytes.
The 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 the encoding property. Setting the encoding in this way will override any encoding specified in the XML declaration itself.
return fByteStream;
public boolean getCertifiedText()
If set to true, assume that the input is certified (see section 2.13 in [XML 1.1]) when parsing [XML 1.1].
return fCertifiedText;
public java.io.Reader getCharacterStream()
An attribute of a language-binding dependent type that represents a stream of 16-bit units. Application must encode the stream using UTF-16 (defined in and Amendment 1 of ).
If a character stream is specified, the parser will ignore any byte stream and will not attempt to open a URI connection to the system identifier.
return fCharStream;
public java.lang.String getEncoding()
The character encoding, if known. The encoding must be a string acceptable for an XML encoding declaration ( section 4.3.3 "Character Encoding in Entities").
This attribute has no effect when the application provides a character stream. For other sources of input, an encoding specified by means of this attribute will override any encoding specified in the XML claration or the Text Declaration, or an encoding obtained from a higher level protocol, such as HTTP .
return fEncoding;
public java.lang.String getPublicId()
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.
return fPublicId;
public java.lang.String getStringData()
A string attribute that represents a sequence of 16 bit units (utf-16 encoded characters).
If string data is available in the input source, the parser will ignore the character stream and the byte stream and will not attempt to open a URI connection to the system identifier.
return fData;
public java.lang.String getSystemId()
The system identifier, a URI reference , 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 fetch the ressource identifier by the URI reference 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 by setting the encoding attribute.
If the system ID is a relative URI reference (see section 5 in ), the behavior is implementation dependent.
return fSystemId;
public void setBaseURI(java.lang.String baseURI)
The base URI to be used (see section 5.1.4 in ) for resolving relative URIs to absolute URIs. If the baseURI is itself a relative URI, the behavior is implementation dependent.
fBaseSystemId = baseURI;
public void setByteStream(java.io.InputStream byteStream)
An attribute of a language-binding dependent type that represents a stream of bytes.
The 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 the encoding property. Setting the encoding in this way will override any encoding specified in the XML declaration itself.
fByteStream = byteStream;
public void setCertifiedText(boolean certifiedText)
If set to true, assume that the input is certified (see section 2.13 in [XML 1.1]) when parsing [XML 1.1].
fCertifiedText = certifiedText;
public void setCharacterStream(java.io.Reader characterStream)
An attribute of a language-binding dependent type that represents a stream of 16-bit units. Application must encode the stream using UTF-16 (defined in and Amendment 1 of ).
If a character stream is specified, the parser will ignore any byte stream and will not attempt to open a URI connection to the system identifier.
fCharStream = characterStream;
public void setEncoding(java.lang.String encoding)
The character encoding, if known. The encoding must be a string acceptable for an XML encoding declaration ( section 4.3.3 "Character Encoding in Entities").
This attribute has no effect when the application provides a character stream. For other sources of input, an encoding specified by means of this attribute will override any encoding specified in the XML claration or the Text Declaration, or an encoding obtained from a higher level protocol, such as HTTP .
fEncoding = encoding;
public void setPublicId(java.lang.String publicId)
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.
fPublicId = publicId;
public void setStringData(java.lang.String stringData)
A string attribute that represents a sequence of 16 bit units (utf-16 encoded characters).
If string data is available in the input source, the parser will ignore the character stream and the byte stream and will not attempt to open a URI connection to the system identifier.
fData = stringData;
public void setSystemId(java.lang.String systemId)
The system identifier, a URI reference , 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 fetch the ressource identifier by the URI reference 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 by setting the encoding attribute.
If the system ID is a relative URI reference (see section 5 in ), the behavior is implementation dependent.
fSystemId = systemId;