org.apache.xerces.dom
Class DeferredEntityImpl

java.lang.Object
  |
  +--org.apache.xerces.dom.NodeImpl
        |
        +--org.apache.xerces.dom.ChildNode
              |
              +--org.apache.xerces.dom.ParentNode
                    |
                    +--org.apache.xerces.dom.EntityImpl
                          |
                          +--org.apache.xerces.dom.DeferredEntityImpl

public class DeferredEntityImpl

extends EntityImpl

implements DeferredNode

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 int

fNodeIndex Node index.

Fields inherited from class org.apache.xerces.dom.EntityImpl

encoding, name, notationName, publicId, systemId, 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

Method Summary

int	getNodeIndex() Returns the node index.
protected void	synchronizeChildren() Synchronize the children.
protected void	synchronizeData() Synchronize the entity data.

Methods inherited from class org.apache.xerces.dom.EntityImpl

cloneNode, getEncoding, getNodeName, getNodeType, getNotationName, getPublicId, getSystemId, getVersion, setEncoding, setNotationName, setPublicId, setSystemId, setVersion

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, insertBefore, item, normalize, removeChild, replaceChild, setReadOnly

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, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fNodeIndex

protected transient int fNodeIndex

Node index.

Method Detail

getNodeIndex

public int getNodeIndex()

Returns the node index.

Specified by:

getNodeIndex in interface DeferredNode

synchronizeData

protected void synchronizeData()

Synchronize the entity data. This is special because of the way that the "fast" version stores the information.

Overrides:

synchronizeData in class NodeImpl

synchronizeChildren

protected void synchronizeChildren()

Synchronize the children.

Overrides:

synchronizeChildren in class ParentNode