Package org.htmlunit.cyberneko.xerces.dom

Class 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

    • 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. 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

      • 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 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()
        The absolute base URI of this node or null if undefined. This value is computed according to . However, when the Document supports the feature "HTML" , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.
        When the node is an Element, a Document or a a ProcessingInstruction, this attribute represents the properties [base URI] defined in . When the node is a Notation, an Entity, or an EntityReference, this attribute represents the properties [declaration base URI] in the . How will this be affected by resolution of relative namespace URIs issue?It's not.Should this only be on Document, Element, ProcessingInstruction, Entity, and Notation nodes, according to the infoset? If not, what is it equal to on other nodes? Null? An empty string? I think it should be the parent's.No.Should this be read-only and computed or and actual read-write attribute?Read-only and computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML element is not yet attached to a document, does the insert change the Document.baseURI? Yes. (F2F 26 Sep 2001) 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)