| java.lang.Object
 org.apache.xerces.dom.DOMInputImpl
| DOMInputImpl | | public class DOMInputImpl implements LSInput(Code) | | 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.
See also the Document Object Model (DOM) Level 3 Abstract Schemas and Load
and Save Specification.
author:
Gopal Sharma, SUN Microsystems Inc.
version:
$Id: DOMInputImpl.java 447266 2006-09-18 05:57:49Z mrglavas $ |
| Constructor Summary | |
| public | DOMInputImpl()
| | 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.
Parameters:
publicId - The public identifier, if known.
Parameters:
systemId - The system identifier. | | public | DOMInputImpl(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.
Parameters:
systemId - The system identifier. | | public | DOMInputImpl(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.
Parameters:
systemId - The system identifier. | | public | DOMInputImpl(String publicId, String systemId, String baseSystemId, String data, String encoding)
Constructs an input source from a String.
Parameters:
publicId - The public identifier, if known.
Parameters:
systemId - The system identifier. |
| Method Summary | |
| public String | getBaseURI()
The base URI to be used (see section 5.1.4 in ) for resolving relative
URIs to absolute URIs. | | public 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. | | 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]. | | public Reader | getCharacterStream()
An attribute of a language-binding dependent type that represents a
stream of 16-bit units. | | public String | getEncoding()
The character encoding, if known. | | public String | getPublicId()
The public identifier for this input source. | | public String | getStringData()
A string attribute that represents a sequence of 16 bit units (utf-16
encoded characters). | | public String | getSystemId()
The system identifier, a URI reference , for this input source. | | public void | setBaseURI(String baseURI)
The base URI to be used (see section 5.1.4 in ) for resolving relative
URIs to absolute URIs. | | public void | setByteStream(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. | | 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]. | | public void | setCharacterStream(Reader characterStream)
An attribute of a language-binding dependent type that represents a
stream of 16-bit units. | | public void | setEncoding(String encoding)
The character encoding, if known. | | public void | setPublicId(String publicId)
The public identifier for this input source. | | public void | setStringData(String stringData)
A string attribute that represents a sequence of 16 bit units (utf-16
encoded characters). | | public void | setSystemId(String systemId)
The system identifier, a URI reference , for this input source. |
| fCertifiedText | | protected boolean fCertifiedText(Code) | | |
| DOMInputImpl | | public DOMInputImpl()(Code) | | Default Constructor, constructs an input source
|
| DOMInputImpl | | public DOMInputImpl(String publicId, String systemId, String baseSystemId)(Code) | | 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.
Parameters:
systemId - The system identifier. This value shouldalways be set, if possible, and can berelative or absolute. If the system identifieris relative, then the base system identifiershould be set.
Parameters:
baseSystemId - The base system identifier. This value shouldalways be set to the fully expanded URI of thebase system identifier, if possible. |
| DOMInputImpl | | public DOMInputImpl(String publicId, String systemId, String baseSystemId, InputStream byteStream, String encoding)(Code) | | Constructs an input source from a byte stream.
Parameters:
publicId - The public identifier, if known.
Parameters:
systemId - The system identifier. This value shouldalways be set, if possible, and can berelative or absolute. If the system identifieris relative, then the base system identifiershould be set.
Parameters:
baseSystemId - The base system identifier. This value shouldalways be set to the fully expanded URI of thebase system identifier, if possible.
Parameters:
byteStream - The byte stream.
Parameters:
encoding - The encoding of the byte stream, if known. |
| DOMInputImpl | | public DOMInputImpl(String publicId, String systemId, String baseSystemId, Reader charStream, String encoding)(Code) | | Constructs an input source from a character stream.
Parameters:
publicId - The public identifier, if known.
Parameters:
systemId - The system identifier. This value shouldalways be set, if possible, and can berelative or absolute. If the system identifieris relative, then the base system identifiershould be set.
Parameters:
baseSystemId - The base system identifier. This value shouldalways be set to the fully expanded URI of thebase system identifier, if possible.
Parameters:
charStream - The character stream.
Parameters:
encoding - The original encoding of the byte streamused by the reader, if known. |
| DOMInputImpl | | public DOMInputImpl(String publicId, String systemId, String baseSystemId, String data, String encoding)(Code) | | Constructs an input source from a String.
Parameters:
publicId - The public identifier, if known.
Parameters:
systemId - The system identifier. This value shouldalways be set, if possible, and can berelative or absolute. If the system identifieris relative, then the base system identifiershould be set.
Parameters:
baseSystemId - The base system identifier. This value shouldalways be set to the fully expanded URI of thebase system identifier, if possible.
Parameters:
data - The String Data.
Parameters:
encoding - The original encoding of the byte streamused by the reader, if known. |
| getBaseURI | | public String getBaseURI()(Code) | | 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.
|
| getByteStream | | public InputStream getByteStream()(Code) | | 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.
|
| getCertifiedText | | public boolean getCertifiedText()(Code) | | If set to true, assume that the input is certified (see section 2.13
in [XML 1.1]) when
parsing [XML 1.1].
|
| getCharacterStream | | public Reader getCharacterStream()(Code) | | 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.
|
| getEncoding | | public String getEncoding()(Code) | | 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 .
|
| getPublicId | | public String getPublicId()(Code) | | 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.
|
| getStringData | | public String getStringData()(Code) | | 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.
|
| getSystemId | | public String getSystemId()(Code) | | 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.
|
| setBaseURI | | public void setBaseURI(String baseURI)(Code) | | 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.
|
| setByteStream | | public void setByteStream(InputStream byteStream)(Code) | | 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.
|
| setCertifiedText | | public void setCertifiedText(boolean certifiedText)(Code) | | If set to true, assume that the input is certified (see section 2.13
in [XML 1.1]) when
parsing [XML 1.1].
|
| setCharacterStream | | public void setCharacterStream(Reader characterStream)(Code) | | 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.
|
| setEncoding | | public void setEncoding(String encoding)(Code) | | 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 .
|
| setPublicId | | public void setPublicId(String publicId)(Code) | | 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.
|
| setStringData | | public void setStringData(String stringData)(Code) | | 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.
|
| setSystemId | | public void setSystemId(String systemId)(Code) | | 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.
|
|
|