org.apache.xerces.dom
Class EntityImpl

java.lang.Object
  |
  +--org.apache.xerces.dom.NodeImpl
        |
        +--org.apache.xerces.dom.ChildNode
              |
              +--org.apache.xerces.dom.ParentNode
                    |
                    +--org.apache.xerces.dom.EntityImpl
All Implemented Interfaces:
java.lang.Cloneable, Entity, EventTarget, Node, NodeList, java.io.Serializable
Direct Known Subclasses:
DeferredEntityImpl

public class EntityImpl
extends ParentNode
implements Entity

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.

Since:
PR-DOM-Level-1-19980818.
Version:
 
See Also:
Serialized Form

Field Summary
protected  java.lang.String encoding
          Encoding
protected  java.lang.String name
          Entity name.
protected  java.lang.String notationName
          Notation name.
protected  java.lang.String publicId
          Public identifier.
protected  java.lang.String systemId
          System identifier.
protected  java.lang.String version
          Version
 
Fields inherited from class org.apache.xerces.dom.ParentNode
fCachedChild, fCachedChildIndex, fCachedLength, firstChild, ownerDocument
 
Fields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
 
Fields inherited from class org.apache.xerces.dom.NodeImpl
ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, IGNORABLEWS, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, UNNORMALIZED
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
EntityImpl(CoreDocumentImpl ownerDoc, java.lang.String name)
          Factory constructor.
 
Method Summary
 Node cloneNode(boolean deep)
          Clone node.
 java.lang.String getEncoding()
          DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.
 java.lang.String getNodeName()
          Returns the entity name
 short getNodeType()
          A short integer indicating what type of node this is.
 java.lang.String getNotationName()
          Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them.
 java.lang.String getPublicId()
          The public identifier associated with the entity.
 java.lang.String getSystemId()
          The system identifier associated with the entity.
 java.lang.String getVersion()
          DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.
 void setEncoding(java.lang.String value)
          DOM Level 3 WD - experimental encoding - An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.
 void setNotationName(java.lang.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(java.lang.String id)
          DOM Level 2: The public identifier associated with the entity.
 void setSystemId(java.lang.String id)
          DOM Level 2: The system identifier associated with the entity.
 void setVersion(java.lang.String value)
          DOM Level 3 WD - experimental version - An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity.
 
Methods inherited from class org.apache.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, insertBefore, item, normalize, removeChild, replaceChild, setReadOnly, synchronizeChildren
 
Methods inherited from class org.apache.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
 
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, appendChild, changed, changes, dispatchEvent, getAttributes, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, hasAttributes, isSupported, removeEventListener, setNodeValue, setPrefix, setUserData, synchronizeData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Field Detail

name

protected java.lang.String name
Entity name.

publicId

protected java.lang.String publicId
Public identifier.

systemId

protected java.lang.String systemId
System identifier.

encoding

protected java.lang.String encoding
Encoding

version

protected java.lang.String version
Version

notationName

protected java.lang.String notationName
Notation name.
Constructor Detail

EntityImpl

public EntityImpl(CoreDocumentImpl ownerDoc,
                  java.lang.String name)
Factory constructor.
Method Detail

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.
Specified by:
getNodeType in interface Node
Overrides:
getNodeType in class NodeImpl

getNodeName

public java.lang.String getNodeName()
Returns the entity name
Specified by:
getNodeName in interface Node
Overrides:
getNodeName in class NodeImpl

cloneNode

public Node cloneNode(boolean deep)
Clone node.
Specified by:
cloneNode in interface Node
Overrides:
cloneNode in class ParentNode
Following copied from interface: org.w3c.dom.Node
Parameters:
deepIf - true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
Returns:
The duplicate node.

getPublicId

public java.lang.String getPublicId()
The public identifier associated with the entity. If not specified, this will be null.
Specified by:
getPublicId in interface Entity

getSystemId

public java.lang.String getSystemId()
The system identifier associated with the entity. If not specified, this will be null.
Specified by:
getSystemId in interface Entity

getVersion

public java.lang.String getVersion()
DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.
Specified by:
getVersion in interface Entity

getEncoding

public java.lang.String getEncoding()
DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.
Specified by:
getEncoding in interface Entity

getNotationName

public java.lang.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.
Specified by:
getNotationName in interface Entity

setPublicId

public void setPublicId(java.lang.String id)
DOM Level 2: The public identifier associated with the entity. If not specified, this will be null.

setEncoding

public void setEncoding(java.lang.String value)
DOM Level 3 WD - experimental 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
Specified by:
setEncoding in interface Entity

setVersion

public void setVersion(java.lang.String value)
DOM Level 3 WD - experimental 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
Specified by:
setVersion in interface Entity

setSystemId

public void setSystemId(java.lang.String id)
DOM Level 2: The system identifier associated with the entity. If not specified, this will be null.

setNotationName

public void setNotationName(java.lang.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.


Copyright 1999-2001 Apache XML Project. All Rights Reserved.