org.apache.xerces.dom
Class EntityImpl

java.lang.Object
  |
  +--org.apache.xerces.dom.NodeImpl
        |
        +--org.apache.xerces.dom.NodeContainer
              |
              +--org.apache.xerces.dom.EntityImpl

Direct Known Subclasses:

DeferredEntityImpl

public class EntityImpl

extends NodeContainer

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	notationName Notation name.
protected java.lang.String	publicId Public identifier.
protected java.lang.String	systemId System identifier.

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

firstChild, kidOK, lastChild, nodeListChanges, nodeListIndex, nodeListLength, nodeListNode, syncChildren

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

ELEMENT_DEFINITION_NODE, fInternalSetNodeValue, MUTATION_AGGREGATE, MUTATION_ALL, MUTATION_LOCAL, MUTATION_NONE, MUTATIONEVENTS, name, nextSibling, ownerDocument, parentNode, previousSibling, readOnly, syncData, userData, value

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(DocumentImpl ownerDoc, java.lang.String name)
Factory constructor.

Method Summary

short	getNodeType() A short integer indicating what type of node this is.
java.lang.String	getNodeValue() Returns the node value.
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.
void	setNodeValue(java.lang.String value) EntityReferences never have a nodeValue.
void	setNotationName(java.lang.String name) NON-DOM 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) NON-DOM The public identifier associated with the entity.
void	setSystemId(java.lang.String id) NON-DOM The system identifier associated with the entity.

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

appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getLength, hasChildNodes, insertBefore, item, normalize, removeChild, replaceChild, setReadOnly, synchronizeChildren

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

addEventListener, changed, dispatchEvent, finalize, getAttributes, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getReadOnly, getUserData, removeEventListener, setPrefix, setUserData, supports, synchronizeData, toString

Methods inherited from class java.lang.Object

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

Field Detail

publicId

protected java.lang.String publicId

Public identifier.

systemId

protected java.lang.String systemId

System identifier.

notationName

protected java.lang.String notationName

Notation name.

Constructor Detail

EntityImpl

public EntityImpl(DocumentImpl 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.

Overrides:

getNodeType in class NodeImpl

getNodeValue

public java.lang.String getNodeValue()

Returns the node value.

Overrides:

getNodeValue in class NodeImpl

Tags copied from interface: Node

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setNodeValue

public void setNodeValue(java.lang.String value)
                  throws DOMException

EntityReferences never have a nodeValue.

Overrides:

setNodeValue in class NodeImpl

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) -

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

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)

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

setSystemId

public void setSystemId(java.lang.String id)

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

setNotationName

public void setNotationName(java.lang.String name)

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