Package org.htmlunit.cyberneko.xerces.dom

Class NodeImpl

  • All Implemented Interfaces:
    Cloneable, EventTarget, Node, NodeList
    Direct Known Subclasses:
    AttrImpl, ChildNode
    public abstract class NodeImpl
extends Object
implements Node, NodeList, EventTarget, Cloneable
    NodeImpl provides the basic structure of a DOM tree. It is never used directly, but instead is subclassed to add type and data information, and additional methods, appropriate to each node of the tree. Only its subclasses should be instantiated -- and those, with the exception of Document itself, only through a specific Document's factory methods.

    The Node interface provides shared behaviors such as siblings and children, both for consistancy and so that the most common tree operations may be performed without constantly having to downcast to specific node types. When there is no obvious mapping for one of these queries, it will respond with null. Note that the default behavior is that children are forbidden. To permit them, the subclass ParentNode overrides several methods.

    NodeImpl also implements NodeList, so it can return itself in response to the getChildNodes() query. This eliminiates the need for a separate ChildNodeList object. Note that this is an IMPLEMENTATION DETAIL; applications should _never_ assume that this identity exists.

    All nodes in a single document must originate in that document. (Note that this is much tighter than "must be same implementation") Nodes are all aware of their ownerDocument, and attempts to mismatch will throw WRONG_DOCUMENT_ERR.

    However, to save memory not all nodes always have a direct reference to their ownerDocument. When a node is owned by another node it relies on its owner to store its ownerDocument. Parent nodes always store it though, so there is never more than one level of indirection. And when a node doesn't have an owner, ownerNode refers to its ownerDocument.

    This class doesn't directly support mutation events, however, it still implements the EventTarget interface and forward all related calls to the document so that the document class do so.

    Author:
    Arnaud Le Hors, IBM, Joe Kesselman, IBM

    • Constructor Detail

      • NodeImpl

        protected NodeImpl​(CoreDocumentImpl ownerDocument)
        No public constructor; only subclasses of Node should be instantiated, and those normally via a Document's factory methods

        Every Node knows what Document it belongs to.

        Parameters:
        ownerDocument - the owner document

    • Method Detail

      • getNodeType

        public abstract 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.
        Specified by:
        getNodeType in interface Node

      • getNodeName

        public abstract String getNodeName()
        the name of this node.
        Specified by:
        getNodeName in interface Node

      • getOwnerDocument

        public Document getOwnerDocument()
        Find the Document that this Node belongs to (the document in whose context the Node was created). The Node may or may not currently be part of that Document's actual contents.
        Specified by:
        getOwnerDocument in interface Node

      • getNodeNumber

        protected int getNodeNumber()
        Returns:
        the node number

      • getParentNode

        public Node getParentNode()
        Obtain the DOM-tree parent of this node, or null if it is not currently active in the DOM tree (perhaps because it has just been created or removed). Note that Document, DocumentFragment, and Attribute will never have parents.
        Specified by:
        getParentNode in interface Node

      • getNextSibling

        public Node getNextSibling()
        The next child of this node's parent, or null if none
        Specified by:
        getNextSibling in interface Node

      • getPreviousSibling

        public Node getPreviousSibling()
        The previous child of this node's parent, or null if none
        Specified by:
        getPreviousSibling in interface Node

      • getAttributes

        public NamedNodeMap getAttributes()
        Return the collection of attributes associated with this node, or null if none. At this writing, Element is the only type of node which will ever have attributes.
        Specified by:
        getAttributes in interface Node
        See Also:
        ElementImpl

      • hasAttributes

        public boolean hasAttributes()
        Returns whether this node (if it is an element) has any attributes.
        Specified by:
        hasAttributes in interface Node
        Returns:
        true if this node has any attributes, false otherwise.
        See Also:
        ElementImpl

      • hasChildNodes

        public boolean hasChildNodes()
        Test whether this node has any children. Convenience shorthand for (Node.getFirstChild()!=null)

        By default we do not have any children, ParentNode overrides this.

        Specified by:
        hasChildNodes in interface Node
        See Also:
        ParentNode

      • getChildNodes

        public NodeList getChildNodes()
        Obtain a NodeList enumerating all children of this node. If there are none, an (initially) empty NodeList is returned.

        NodeLists are "live"; as children are added/removed the NodeList will immediately reflect those changes. Also, the NodeList refers to the actual nodes, so changes to those nodes made via the DOM tree will be reflected in the NodeList and vice versa.

        In this implementation, Nodes implement the NodeList interface and provide their own getChildNodes() support. Other DOMs may solve this differently.

        Specified by:
        getChildNodes in interface Node

      • getFirstChild

        public Node getFirstChild()
        The first child of this Node, or null if none.

        By default we do not have any children, ParentNode overrides this.

        Specified by:
        getFirstChild in interface Node
        See Also:
        ParentNode

      • getLastChild

        public Node getLastChild()
        The first child of this Node, or null if none.

        By default we do not have any children, ParentNode overrides this.

        Specified by:
        getLastChild in interface Node
        See Also:
        ParentNode

      • insertBefore

        public Node insertBefore​(Node newChild,
                         Node refChild)
                  throws DOMException
        Move one or more node(s) to our list of children. Note that this implicitly removes them from their previous parent.

        By default we do not accept any children, ParentNode overrides this.

        Specified by:
        insertBefore in interface Node
        Parameters:
        newChild - The Node to be moved to our subtree. As a convenience feature, inserting a DocumentNode will instead insert all its children.
        refChild - Current child which newChild should be placed immediately before. If refChild is null, the insertion occurs after all existing Nodes, like appendChild().
        Returns:
        newChild, in its new state (relocated, or emptied in the case of DocumentNode.)
        Throws:
        DOMException - HIERARCHY_REQUEST_ERR if newChild is of a type that shouldn't be a child of this node, or if newChild is an ancestor of this node.
        DOMException - WRONG_DOCUMENT_ERR if newChild has a different owner document than we do.
        DOMException - NOT_FOUND_ERR if refChild is not a child of this node.
        DOMException - NO_MODIFICATION_ALLOWED_ERR if this node is read-only.
        See Also:
        ParentNode

      • removeChild

        public Node removeChild​(Node oldChild)
                 throws DOMException
        Remove a child from this Node. The removed child's subtree remains intact so it may be re-inserted elsewhere.

        By default we do not have any children, ParentNode overrides this.

        Specified by:
        removeChild in interface Node
        Returns:
        oldChild, in its new state (removed).
        Throws:
        DOMException - NOT_FOUND_ERR if oldChild is not a child of this node.
        DOMException - NO_MODIFICATION_ALLOWED_ERR if this node is read-only.
        See Also:
        ParentNode

      • replaceChild

        public Node replaceChild​(Node newChild,
                         Node oldChild)
                  throws DOMException
        Make newChild occupy the location that oldChild used to have. Note that newChild will first be removed from its previous parent, if any. Equivalent to inserting newChild before oldChild, then removing oldChild.

        By default we do not have any children, ParentNode overrides this.

        Specified by:
        replaceChild in interface Node
        Returns:
        oldChild, in its new state (removed).
        Throws:
        DOMException - HIERARCHY_REQUEST_ERR if newChild is of a type that shouldn't be a child of this node, or if newChild is one of our ancestors.
        DOMException - WRONG_DOCUMENT_ERR if newChild has a different owner document than we do.
        DOMException - NOT_FOUND_ERR if oldChild is not a child of this node.
        DOMException - NO_MODIFICATION_ALLOWED_ERR if this node is read-only.
        See Also:
        ParentNode

      • getLength

        public int getLength()
        NodeList method: Count the immediate children of this node

        By default we do not have any children, ParentNode overrides this.

        Specified by:
        getLength in interface NodeList

      • item

        public Node item​(int index)
        NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.

        By default we do not have any children, ParentNode overrides this.

        Specified by:
        item in interface NodeList

      • normalize

        public void normalize()
        Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are no adjacent Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

        Note that this implementation simply calls normalize() on this Node's children. It is up to implementors or Node to override normalize() to take action.

        Specified by:
        normalize in interface Node

      • isSupported

        public boolean isSupported​(String feature,
                           String version)
        Introduced in DOM Level 2.

        Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

        Specified by:
        isSupported in interface Node
        Parameters:
        feature - The package name of the feature to test. This is the same name as what can be passed to the method hasFeature on DOMImplementation.
        version - This is the version number of the package name to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.
        Returns:
        boolean Returns true if this node defines a subtree within which the specified feature is supported, false otherwise.

      • getNamespaceURI

        public String getNamespaceURI()
        Introduced in DOM Level 2.

        The namespace URI of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE, this is always null and setting it has no effect.

        This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.

        For nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is null.

        Specified by:
        getNamespaceURI in interface Node
        See Also:
        AttrNSImpl, ElementNSImpl

      • getPrefix

        public String getPrefix()
        Introduced in DOM Level 2.

        The namespace prefix of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is always null and setting it has no effect.

        For nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is null.

        Specified by:
        getPrefix in interface Node
        See Also:
        AttrNSImpl, ElementNSImpl

      • setPrefix

        public void setPrefix​(String prefix)
               throws DOMException
        Introduced in DOM Level 2.

        The namespace prefix of this node, or null if it is unspecified. When this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is always null and setting it has no effect.

        For nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is null.

        Note that setting this attribute changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.

        Specified by:
        setPrefix in interface Node
        Throws:
        DOMException - INVALID_CHARACTER_ERR Raised if the specified prefix contains an invalid character.
        See Also:
        AttrNSImpl, ElementNSImpl

      • getLocalName

        public String getLocalName()
        Introduced in DOM Level 2.

        Returns the local part of the qualified name of this node. For nodes created with a DOM Level 1 method, such as createElement from the Document interface, and for nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this is the same as the nodeName attribute.

        Specified by:
        getLocalName in interface Node
        See Also:
        AttrNSImpl, ElementNSImpl

      • 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)
        Specified by:
        getBaseURI in interface Node

      • compareDocumentPosition

        public short compareDocumentPosition​(Node other)
                              throws DOMException
        Compares a node with this node with regard to their position in the document.
        Specified by:
        compareDocumentPosition in interface Node
        Parameters:
        other - The node to compare against this node.
        Returns:
        Returns how the given node is positioned relatively to this node.
        Throws:
        DOMException

      • getTextContent

        public String getTextContent()
                      throws DOMException
        This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
        The string returned is made of the text content of this node depending on its type, as defined below:
        Node type Content
        ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
        ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
        DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
        Specified by:
        getTextContent in interface Node
        Throws:
        DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

      • setTextContent

        public void setTextContent​(String textContent)
                    throws DOMException
        This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
        The string returned is made of the text content of this node depending on its type, as defined below:
        Node type Content
        ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
        ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
        DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
        Specified by:
        setTextContent in interface Node
        Throws:
        DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

      • isSameNode

        public boolean isSameNode​(Node other)
        Returns whether this node is the same node as the given one.
        This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
        Specified by:
        isSameNode in interface Node
        Parameters:
        other - The node to test against.
        Returns:
        Returns true if the nodes are the same, false otherwise.

      • isDefaultNamespace

        public boolean isDefaultNamespace​(String namespaceURI)
        DOM Level 3: Experimental This method checks if the specified namespaceURI is the default namespace or not.
        Specified by:
        isDefaultNamespace in interface Node
        Parameters:
        namespaceURI - The namespace URI to look for.
        Returns:
        true if the specified namespaceURI is the default namespace, false otherwise.

      • lookupPrefix

        public String lookupPrefix​(String namespaceURI)
        DOM Level 3 - Experimental: Look up the prefix associated to the given namespace URI, starting from this node.
        Specified by:
        lookupPrefix in interface Node
        Parameters:
        namespaceURI - the namespace uri
        Returns:
        the prefix for the namespace

      • lookupNamespaceURI

        public String lookupNamespaceURI​(String specifiedPrefix)
        DOM Level 3 - Experimental: Look up the namespace URI associated to the given prefix, starting from this node. Use lookupNamespaceURI(null) to lookup the default namespace
        Specified by:
        lookupNamespaceURI in interface Node

      • isEqualNode

        public boolean isEqualNode​(Node arg)
        Tests whether two nodes are equal.
        This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode. All nodes that are the same will also be equal, though the reverse may not be true.
        Two nodes are equal if and only if the following conditions are satisfied: The two nodes are of the same type.The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue , baseURI. This is: they are both null, or they have the same length and are character for character identical. The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. This is true for Attr nodes as for any other type of node. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
        For two DocumentType nodes to be equal, the following conditions must also be satisfied: The following string attributes are equal: publicId, systemId, internalSubset.The entities NamedNodeMaps are equal.The notations NamedNodeMaps are equal.
        On the other hand, the following do not affect equality: the ownerDocument attribute, the specified attribute for Attr nodes, the isWhitespaceInElementContent attribute for Text nodes, as well as any user data or event listeners registered on the nodes.
        Specified by:
        isEqualNode in interface Node
        Parameters:
        arg - The node to compare equality with.
        Returns:
        If the nodes, and possibly subtrees are equal, true otherwise false.

      • setUserData

        public Object setUserData​(String key,
                          Object data,
                          UserDataHandler handler)
        Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.
        Specified by:
        setUserData in interface Node
        Parameters:
        key - The key to associate the object to.
        data - The object to associate to the given key, or null to remove any existing association to that key.
        handler - The handler to associate to that key, or null.
        Returns:
        Returns the DOMObject previously associated to the given key on this node, or null if there was none.

      • getUserData

        public Object getUserData​(String key)
        Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.
        Specified by:
        getUserData in interface Node
        Parameters:
        key - The key the object is associated to.
        Returns:
        Returns the DOMObject associated to the given key on this node, or null if there was none.

      • changed

        protected void changed()
        Denotes that this node has changed.

      • changes

        protected int changes()
        Returns:
        the number of changes to this node.

      • needsSyncChildren

        public final void needsSyncChildren​(boolean value)