Entity nodes hold the reference data for an XML Entity -- either
parsed or unparsed. The nodeName (inherited from Node) will contain
the name (if any) of the Entity. Its data will be contained in the
Entity's children, in exactly the structure which an
EntityReference to this name will present within the document's
body.
Note that this object models the actual entity, _not_ the entity
declaration or the entity reference.
An XML processor may choose to completely expand entities before
the structure model is passed to the DOM; in this case, there will
be no EntityReferences in the DOM tree.
Quoting the 10/01 DOM Proposal,
"The DOM Level 1 does not support editing Entity nodes; if a user
wants to make changes to the contents of an Entity, every related
EntityReference node has to be replaced in the structure model by
a clone of the Entity's contents, and then the desired changes
must be made to each of those clones instead. All the
descendants of an Entity node are readonly."
I'm interpreting this as: It is the parser's responsibilty to call
the non-DOM operation setReadOnly(true,true) after it constructs
the Entity. Since the DOM explicitly decided not to deal with this,
_any_ answer will involve a non-DOM operation, and this is the
simplest solution.
baseURI
protected String baseURI
base uri
encoding
protected String encoding
Encoding
inputEncoding
protected String inputEncoding
Input Encoding
name
protected String name
Entity name.
notationName
protected String notationName
Notation name.
publicId
protected String publicId
Public identifier.
systemId
protected String systemId
System identifier.
version
protected String version
Version
cloneNode
public org.w3c.dom.Node cloneNode(boolean deep)
Clone node.
- cloneNode in interface org.w3c.dom.Node
- cloneNode in interface ParentNode
getBaseURI
public String getBaseURI()
Returns the absolute base URI of this node or null if the implementation
wasn't able to obtain an absolute URI. Note: If the URI is malformed, a
null is returned.
- getBaseURI in interface org.w3c.dom.Node
- getBaseURI in interface NodeImpl
- The absolute base URI of this node or null.
getInputEncoding
public String getInputEncoding()
An attribute specifying the encoding used for this entity at the tiome
of parsing, when it is an external parsed entity. This is
null
if it an entity from the internal subset or if it
is not known..
- getInputEncoding in interface org.w3c.dom.Entity
getNodeType
public short getNodeType()
A short integer indicating what type of node this is. The named
constants for this value are defined in the org.w3c.dom.Node interface.
- getNodeType in interface org.w3c.dom.Node
- getNodeType in interface NodeImpl
getNotationName
public String getNotationName()
Unparsed entities -- which contain non-XML data -- have a
"notation name" which tells applications how to deal with them.
Parsed entities, which are in XML format, don't need this and
set it to null.
- getNotationName in interface org.w3c.dom.Entity
getPublicId
public String getPublicId()
The public identifier associated with the entity. If not specified,
this will be null.
- getPublicId in interface org.w3c.dom.Entity
getSystemId
public String getSystemId()
The system identifier associated with the entity. If not specified,
this will be null.
- getSystemId in interface org.w3c.dom.Entity
getXmlEncoding
public String getXmlEncoding()
DOM Level 3 WD - experimental
the encoding of this entity, when it is an external parsed entity.
- getXmlEncoding in interface org.w3c.dom.Entity
getXmlVersion
public String getXmlVersion()
DOM Level 3 WD - experimental
the version number of this entity, when it is an external parsed entity.
- getXmlVersion in interface org.w3c.dom.Entity
setBaseURI
public void setBaseURI(String uri)
NON-DOM: set base uri
setInputEncoding
public void setInputEncoding(String inputEncoding)
NON-DOM, used to set the input encoding.
setNotationName
public void setNotationName(String name)
DOM Level 2: Unparsed entities -- which contain non-XML data -- have a
"notation name" which tells applications how to deal with them.
Parsed entities, which are in XML format, don't need this and
set it to null.
setPublicId
public void setPublicId(String id)
DOM Level 2: The public identifier associated with the entity. If not specified,
this will be null.
setSystemId
public void setSystemId(String id)
DOM Level 2: The system identifier associated with the entity. If not
specified, this will be null.
setXmlEncoding
public void setXmlEncoding(String value)
NON-DOM
encoding - An attribute specifying, as part of the text declaration,
the encoding of this entity, when it is an external parsed entity.
This is null otherwise
setXmlVersion
public void setXmlVersion(String value)
NON-DOM
version - An attribute specifying, as part of the text declaration,
the version number of this entity, when it is an external parsed entity.
This is null otherwise