Top Description Fields Constructors Methods
com.sun.org.apache.xerces.internal.dom

public Class DeferredEntityImpl

extends EntityImpl
implements DeferredNode
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.xerces.internal.dom.DeferredNode, org.w3c.dom.Node

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.

Field Summary

Modifier and TypeField and Description
protected transient int
fNodeIndex

Node index.

pack-priv static final long
Inherited from com.sun.org.apache.xerces.internal.dom.EntityImpl:
baseURIencodinginputEncodingnamenotationNamepublicIdsystemIdversion

Constructor Summary

AccessConstructor and Description
pack-priv
DeferredEntityImpl(DeferredDocumentImpl ownerDocument, int nodeIndex)

This is the deferred constructor.

Method Summary

Modifier and TypeMethod and Description
public int
protected void
protected void
Inherited from com.sun.org.apache.xerces.internal.dom.EntityImpl:
cloneNodegetBaseURIgetInputEncodinggetNodeNamegetNodeTypegetNotationNamegetPublicIdgetSystemIdgetXmlEncodinggetXmlVersionsetBaseURIsetInputEncodingsetNodeValuesetNotationNamesetPrefixsetPublicIdsetSystemIdsetXmlEncodingsetXmlVersion

Field Detail

fNodeIndexback to summary
protected transient int fNodeIndex

Node index.

serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides com.sun.org.apache.xerces.internal.dom.EntityImpl.serialVersionUID.

Serialization version.

Constructor Detail

DeferredEntityImplback to summary
pack-priv DeferredEntityImpl(DeferredDocumentImpl ownerDocument, int nodeIndex)

This is the deferred constructor. Only the fNodeIndex is given here. All other data, can be requested from the ownerDocument via the index.

Method Detail

getNodeIndexback to summary
public int getNodeIndex()

Implements com.sun.org.apache.xerces.internal.dom.DeferredNode.getNodeIndex.

Returns the node index.

synchronizeChildrenback to summary
protected void synchronizeChildren()

Overrides com.sun.org.apache.xerces.internal.dom.ParentNode.synchronizeChildren.

Synchronize the children.

synchronizeDataback to summary
protected void synchronizeData()

Overrides com.sun.org.apache.xerces.internal.dom.NodeImpl.synchronizeData.

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