Save This Page
Home » openjdk-7 » com.sun.org.apache.xerces.internal » dom » [javadoc | source]
com.sun.org.apache.xerces.internal.dom
public class: EntityImpl [javadoc | source]
java.lang.Object
   com.sun.org.apache.xerces.internal.dom.NodeImpl
      com.sun.org.apache.xerces.internal.dom.ChildNode
         com.sun.org.apache.xerces.internal.dom.ParentNode
            com.sun.org.apache.xerces.internal.dom.EntityImpl

All Implemented Interfaces:
    Entity, Cloneable, Node, EventTarget, Serializable, NodeList

Direct Known Subclasses:
    DeferredEntityImpl

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.
Field Summary
static final  long serialVersionUID    Serialization version. 
protected  String name    Entity name. 
protected  String publicId    Public identifier. 
protected  String systemId    System identifier. 
protected  String encoding    Encoding 
protected  String inputEncoding    Input Encoding 
protected  String version    Version 
protected  String notationName    Notation name. 
protected  String baseURI    base uri 
Fields inherited from com.sun.org.apache.xerces.internal.dom.ParentNode:
serialVersionUID,  ownerDocument,  firstChild,  fNodeListCache
Fields inherited from com.sun.org.apache.xerces.internal.dom.ChildNode:
serialVersionUID,  fBufferStr,  previousSibling,  nextSibling
Fields inherited from com.sun.org.apache.xerces.internal.dom.NodeImpl:
TREE_POSITION_PRECEDING,  TREE_POSITION_FOLLOWING,  TREE_POSITION_ANCESTOR,  TREE_POSITION_DESCENDANT,  TREE_POSITION_EQUIVALENT,  TREE_POSITION_SAME_NODE,  TREE_POSITION_DISCONNECTED,  DOCUMENT_POSITION_DISCONNECTED,  DOCUMENT_POSITION_PRECEDING,  DOCUMENT_POSITION_FOLLOWING,  DOCUMENT_POSITION_CONTAINS,  DOCUMENT_POSITION_IS_CONTAINED,  DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC,  serialVersionUID,  ELEMENT_DEFINITION_NODE,  ownerNode,  flags,  READONLY,  SYNCDATA,  SYNCCHILDREN,  OWNED,  FIRSTCHILD,  SPECIFIED,  IGNORABLEWS,  HASSTRING,  NORMALIZED,  ID
Constructor:
 public EntityImpl(CoreDocumentImpl ownerDoc,
    String name) 
    Factory constructor.
Method from com.sun.org.apache.xerces.internal.dom.EntityImpl Summary:
cloneNode,   getBaseURI,   getInputEncoding,   getNodeName,   getNodeType,   getNotationName,   getPublicId,   getSystemId,   getXmlEncoding,   getXmlVersion,   setBaseURI,   setInputEncoding,   setNodeValue,   setNotationName,   setPrefix,   setPublicId,   setSystemId,   setXmlEncoding,   setXmlVersion
Methods from com.sun.org.apache.xerces.internal.dom.ParentNode:
checkNormalizationAfterInsert,   checkNormalizationAfterRemove,   cloneNode,   getChildNodes,   getChildNodesUnoptimized,   getFirstChild,   getLastChild,   getLength,   getOwnerDocument,   getTextContent,   getTextContent,   hasChildNodes,   hasTextContent,   insertBefore,   internalInsertBefore,   internalRemoveChild,   isEqualNode,   item,   lastChild,   lastChild,   normalize,   ownerDocument,   removeChild,   replaceChild,   setOwnerDocument,   setReadOnly,   setTextContent,   synchronizeChildren
Methods from com.sun.org.apache.xerces.internal.dom.ChildNode:
cloneNode,   getNextSibling,   getParentNode,   getPreviousSibling,   parentNode,   previousSibling
Methods from com.sun.org.apache.xerces.internal.dom.NodeImpl:
addEventListener,   appendChild,   changed,   changes,   cloneNode,   compareDocumentPosition,   compareTreePosition,   dispatchEvent,   getAttributes,   getBaseURI,   getChildNodes,   getContainer,   getElementAncestor,   getFeature,   getFirstChild,   getLastChild,   getLength,   getLocalName,   getNamespaceURI,   getNextSibling,   getNodeName,   getNodeNumber,   getNodeType,   getNodeValue,   getOwnerDocument,   getParentNode,   getPrefix,   getPreviousSibling,   getReadOnly,   getTextContent,   getTextContent,   getUserData,   getUserData,   getUserDataRecord,   hasAttributes,   hasChildNodes,   hasStringValue,   hasStringValue,   insertBefore,   internalIsIgnorableWhitespace,   isDefaultNamespace,   isEqualNode,   isFirstChild,   isFirstChild,   isIdAttribute,   isIdAttribute,   isIgnorableWhitespace,   isNormalized,   isNormalized,   isOwned,   isOwned,   isReadOnly,   isReadOnly,   isSameNode,   isSpecified,   isSpecified,   isSupported,   item,   lookupNamespacePrefix,   lookupNamespaceURI,   lookupPrefix,   needsSyncChildren,   needsSyncChildren,   needsSyncData,   needsSyncData,   normalize,   ownerDocument,   parentNode,   previousSibling,   removeChild,   removeEventListener,   replaceChild,   setNodeValue,   setOwnerDocument,   setPrefix,   setReadOnly,   setTextContent,   setUserData,   setUserData,   synchronizeData,   toString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.sun.org.apache.xerces.internal.dom.EntityImpl Detail:
 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.
 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 setNodeValue(String x) throws DOMException 
    Sets the node value.
 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 setPrefix(String prefix) throws DOMException 
    The namespace prefix of this node
 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