Module org.htmlunit.cyberneko
Package org.htmlunit.cyberneko.xerces.dom

Class EntityImpl

java.lang.Object
org.htmlunit.cyberneko.xerces.dom.NodeImpl
org.htmlunit.cyberneko.xerces.dom.ChildNode
org.htmlunit.cyberneko.xerces.dom.ParentNode
org.htmlunit.cyberneko.xerces.dom.EntityImpl
All Implemented Interfaces:
Cloneable, Entity, EventTarget, Node, NodeList
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.

Author:
Elena Litani, IBM

  • Constructor Details

  • Method Details

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

    • getNodeName

      public String getNodeName()
      Returns the name of this node. Returns the entity name
      Specified by:
      getNodeName in interface Node
      Specified by:
      getNodeName in class NodeImpl

    • cloneNode

      public Node cloneNode(boolean deep)
      Returns a duplicate of a given node. You can consider this a generic "copy constructor" for nodes. The newly returned object should be completely independent of the source object's subtree, so changes in one after the clone has been made will not affect the other.

      Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior.

      Returns a duplicate of a given node. You can consider this a generic "copy constructor" for nodes. The newly returned object should be completely independent of the source object's subtree, so changes in one after the clone has been made will not affect the other.

      Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior. Returns a duplicate of a given node. You can consider this a generic "copy constructor" for nodes. The newly returned object should be completely independent of the source object's subtree, so changes in one after the clone has been made will not affect the other.

      Example: Cloning a Text node will copy both the node and the text it contains.

      Example: Cloning something that has children -- Element or Attr, for example -- will _not_ clone those children unless a "deep clone" has been requested. A shallow clone of an Attr node will yield an empty Attr of the same name.

      NOTE: Clones will always be read/write, even if the node being cloned is read-only, to permit applications using only the DOM API to obtain editable copies of locked portions of the tree.

      Clone node.
      Specified by:
      cloneNode in interface Node
      Overrides:
      cloneNode in class ParentNode
      Parameters:
      deep - whether to recursively clone all children in the subtree
      Returns:
      the cloned node
      See Also:

    • getPublicId

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

    • getSystemId

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

    • getXmlVersion

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

    • getXmlEncoding

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

    • getNotationName

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

    • setPublicId

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

    • setXmlEncoding

      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

    • getInputEncoding

      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 is an entity from the internal subset or if it is not known.
      Specified by:
      getInputEncoding in interface Entity

    • setInputEncoding

      public void setInputEncoding(String inputEncoding)

    • setXmlVersion

      public void setXmlVersion(String value)

    • setSystemId

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

    • setNotationName

      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.
      Parameters:
      name - the name

    • getBaseURI

      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.
      Specified by:
      getBaseURI in interface Node
      Overrides:
      getBaseURI in class NodeImpl
      Returns:
      The absolute base URI of this node or null.

    • setBaseURI

      public void setBaseURI(String uri)