public class

EntityImpl

extends ParentNode
implements Entity
java.lang.Object
   ↳ org.apache.xerces.dom.NodeImpl
     ↳ org.apache.xerces.dom.ChildNode
       ↳ org.apache.xerces.dom.ParentNode
         ↳ org.apache.xerces.dom.EntityImpl
Known Direct Subclasses

Class Overview

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.@xerces.internal

Summary

[Expand]
Inherited Constants
From class org.apache.xerces.dom.NodeImpl
From interface org.w3c.dom.Node
Fields
protected String baseURI base uri
protected String encoding Encoding
protected String inputEncoding Input Encoding
protected String name Entity name.
protected String notationName Notation name.
protected String publicId Public identifier.
protected String systemId System identifier.
protected String version Version
[Expand]
Inherited Fields
From class org.apache.xerces.dom.ParentNode
From class org.apache.xerces.dom.ChildNode
From class org.apache.xerces.dom.NodeImpl
Public Constructors
EntityImpl(CoreDocumentImpl ownerDoc, String name)
Factory constructor.
Public Methods
Node cloneNode(boolean deep)
Clone node.
String getBaseURI()
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
String getInputEncoding()
An attribute specifying the encoding used for this entity at the tiome of parsing, when it is an external parsed entity.
String getNodeName()
Returns the entity name
short getNodeType()
A short integer indicating what type of node this is.
String getNotationName()
Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them.
String getPublicId()
The public identifier associated with the entity.
String getSystemId()
The system identifier associated with the entity.
String getXmlEncoding()
DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.
String getXmlVersion()
DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.
void setBaseURI(String uri)
NON-DOM: set base uri
void setInputEncoding(String inputEncoding)
NON-DOM, used to set the input encoding.
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.
void setPublicId(String id)
DOM Level 2: The public identifier associated with the entity.
void setSystemId(String id)
DOM Level 2: The system identifier associated with the entity.
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.
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.
[Expand]
Inherited Methods
From class org.apache.xerces.dom.ParentNode
From class org.apache.xerces.dom.ChildNode
From class org.apache.xerces.dom.NodeImpl
From class java.lang.Object
From interface org.w3c.dom.Entity
From interface org.w3c.dom.Node
From interface org.w3c.dom.NodeList
From interface org.w3c.dom.events.EventTarget

Fields

protected String baseURI

base uri

protected String encoding

Encoding

protected String inputEncoding

Input Encoding

protected String name

Entity name.

protected String notationName

Notation name.

protected String publicId

Public identifier.

protected String systemId

System identifier.

protected String version

Version

Public Constructors

public EntityImpl (CoreDocumentImpl ownerDoc, String name)

Factory constructor.

Public Methods

public Node cloneNode (boolean deep)

Clone node.

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.

Returns
  • The absolute base URI of this node or null.

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..

public String getNodeName ()

Returns the entity name

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.

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.

public String getPublicId ()

The public identifier associated with the entity. If not specified, this will be null.

public String getSystemId ()

The system identifier associated with the entity. If not specified, this will be null.

public String getXmlEncoding ()

DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.

public String getXmlVersion ()

DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.

public void setBaseURI (String uri)

NON-DOM: set base uri

public void setInputEncoding (String inputEncoding)

NON-DOM, used to set the input encoding.

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.

public void setPublicId (String id)

DOM Level 2: The public identifier associated with the entity. If not specified, this will be null.

public void setSystemId (String id)

DOM Level 2: The system identifier associated with the entity. If not specified, this will be null.

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

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