Class ElementImpl

  • All Implemented Interfaces:
    java.lang.Cloneable, org.w3c.dom.Element, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.w3c.dom.NodeList, org.w3c.dom.TypeInfo
    Direct Known Subclasses:
    ElementNSImpl, HTMLElementImpl

    public class ElementImpl
    extends ParentNode
    implements org.w3c.dom.Element, org.w3c.dom.TypeInfo
    Elements represent most of the "markup" and structure of the document. They contain both the data for the element itself (element name and attributes), and any contained nodes, including document text (as children).

    Elements may have Attributes associated with them; the API for this is defined in Node, but the function is implemented here. In general, XML applications should retrive Attributes as Nodes, since they may contain entity references and hence be a fairly complex sub-tree. HTML users will be dealing with simple string values, and convenience methods are provided to work in terms of Strings.

    ElementImpl does not support Namespaces. ElementNSImpl, which inherits from it, does.

    See Also:
    ElementNSImpl
    • Field Detail

      • name_

        protected java.lang.String name_
        Element name.
      • attributes_

        protected AttributeMap attributes_
        Attributes.
    • Constructor Detail

      • ElementImpl

        public ElementImpl​(CoreDocumentImpl ownerDoc,
                           java.lang.String name)
    • Method Detail

      • rename

        void rename​(java.lang.String name)
      • 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 org.w3c.dom.Node
        Specified by:
        getNodeType in class NodeImpl
      • getNodeName

        public java.lang.String getNodeName()
        the name of this node. Returns the element name
        Specified by:
        getNodeName in interface org.w3c.dom.Node
        Specified by:
        getNodeName in class NodeImpl
      • getAttributes

        public org.w3c.dom.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. Retrieve all the Attributes as a set. Note that this API is inherited from Node rather than specified on Element; in fact only Elements will ever have Attributes, but they want to allow folks to "blindly" operate on the tree as a set of Nodes.
        Specified by:
        getAttributes in interface org.w3c.dom.Node
        Overrides:
        getAttributes in class NodeImpl
        See Also:
        ElementImpl
      • cloneNode

        public org.w3c.dom.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. Return a duplicate copy of this Element. Note that its children will not be copied unless the "deep" flag is true, but Attributes are always replicated.

        Specified by:
        cloneNode in interface org.w3c.dom.Node
        Overrides:
        cloneNode in class ParentNode
        See Also:
        Node.cloneNode(boolean)
      • getBaseURI

        public java.lang.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) DOM Level 3 WD - Experimental. Retrieve baseURI
        Specified by:
        getBaseURI in interface org.w3c.dom.Node
        Overrides:
        getBaseURI in class NodeImpl
      • getXMLBaseAttribute

        protected org.w3c.dom.Attr getXMLBaseAttribute()
      • getAttribute

        public java.lang.String getAttribute​(java.lang.String name)
        Look up a single Attribute by name. Returns the Attribute's string value, or an empty string (NOT null!) to indicate that the name did not map to a currently defined attribute.

        Note: Attributes may contain complex node trees. This method returns the "flattened" string obtained from Attribute.getValue(). If you need the structure information, see getAttributeNode().

        Specified by:
        getAttribute in interface org.w3c.dom.Element
      • getAttributeNode

        public org.w3c.dom.Attr getAttributeNode​(java.lang.String name)
        Look up a single Attribute by name. Returns the Attribute Node, so its complete child tree is available. This could be important in XML, where the string rendering may not be sufficient information.

        If no matching attribute is available, returns null.

        Specified by:
        getAttributeNode in interface org.w3c.dom.Element
      • getElementsByTagName

        public org.w3c.dom.NodeList getElementsByTagName​(java.lang.String tagname)
        Returns a NodeList of all descendent nodes (children, grandchildren, and so on) which are Elements and which have the specified tag name.

        Note: NodeList is a "live" view of the DOM. Its contents will change as the DOM changes, and alterations made to the NodeList will be reflected in the DOM.

        Specified by:
        getElementsByTagName in interface org.w3c.dom.Element
        Parameters:
        tagname - The type of element to gather. To obtain a list of all elements no matter what their names, use the wild-card tag name "*".
        See Also:
        DeepNodeListImpl
      • getTagName

        public java.lang.String getTagName()
        Returns the name of the Element. Note that Element.nodeName() is defined to also return the tag name.

        This is case-preserving in XML. HTML should uppercasify it on the way in.

        Specified by:
        getTagName in interface org.w3c.dom.Element
      • removeAttribute

        public void removeAttribute​(java.lang.String name)
        Remove the named attribute from this Element. If the removed Attribute has a default value, it is immediately replaced thereby.

        The default logic is actually implemented in NamedNodeMapImpl. PR-DOM-Level-1-19980818 doesn't fully address the DTD, so some of this behavior is likely to change in future versions. ?????

        Note that this call "succeeds" even if no attribute by this name existed -- unlike removeAttributeNode, which will throw a not-found exception in that case.

        Specified by:
        removeAttribute in interface org.w3c.dom.Element
      • removeAttributeNode

        public org.w3c.dom.Attr removeAttributeNode​(org.w3c.dom.Attr oldAttr)
                                             throws org.w3c.dom.DOMException
        Remove the specified attribute/value pair. If the removed Attribute has a default value, it is immediately replaced.

        NOTE: Specifically removes THIS NODE -- not the node with this name, nor the node with these contents. If the specific Attribute object passed in is not stored in this Element, we throw a DOMException. If you really want to remove an attribute by name, use removeAttribute().

        Specified by:
        removeAttributeNode in interface org.w3c.dom.Element
        Returns:
        the Attribute object that was removed.
        Throws:
        org.w3c.dom.DOMException - NOT_FOUND_ERR if oldattr is not an attribute of this Element.
      • setAttribute

        public void setAttribute​(java.lang.String name,
                                 java.lang.String value)
        Add a new name/value pair, or replace the value of the existing attribute having that name.

        Note: this method supports only the simplest kind of Attribute, one whose value is a string contained in a single Text node. If you want to assert a more complex value (which XML permits, though HTML doesn't), see setAttributeNode().

        The attribute is created with specified=true, meaning it's an explicit value rather than inherited from the DTD as a default. Again, setAttributeNode can be used to achieve other results.

        Specified by:
        setAttribute in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException - INVALID_NAME_ERR if the name is not acceptable. (Attribute factory will do that test for us.)
      • setAttributeNode

        public org.w3c.dom.Attr setAttributeNode​(org.w3c.dom.Attr newAttr)
                                          throws org.w3c.dom.DOMException
        Add a new attribute/value pair, or replace the value of the existing attribute with that name.

        This method allows you to add an Attribute that has already been constructed, and hence avoids the limitations of the simple setAttribute() call. It can handle attribute values that have arbitrarily complex tree structure -- in particular, those which had entity references mixed into their text.

        Specified by:
        setAttributeNode in interface org.w3c.dom.Element
        Throws:
        org.w3c.dom.DOMException - INUSE_ATTRIBUTE_ERR if the Attribute object has already been assigned to another Element.
      • getAttributeNS

        public java.lang.String getAttributeNS​(java.lang.String namespaceURI,
                                               java.lang.String localName)
        Introduced in DOM Level 2.

        Retrieves an attribute value by local name and namespace URI.

        Specified by:
        getAttributeNS in interface org.w3c.dom.Element
        Parameters:
        namespaceURI - The namespace URI of the attribute to retrieve.
        localName - The local name of the attribute to retrieve.
        Returns:
        String The Attr value as a string, or empty string if that attribute does not have a specified or default value.
      • setAttributeNS

        public void setAttributeNS​(java.lang.String namespaceURI,
                                   java.lang.String qualifiedName,
                                   java.lang.String value)
        Introduced in DOM Level 2.

        Adds a new attribute. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the new attribute is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces]. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.

        Specified by:
        setAttributeNS in interface org.w3c.dom.Element
        Parameters:
        namespaceURI - The namespace URI of the attribute to create or alter.
        qualifiedName - The qualified name of the attribute to create or alter.
        value - The value to set in string form.
      • removeAttributeNS

        public void removeAttributeNS​(java.lang.String namespaceURI,
                                      java.lang.String localName)
        Introduced in DOM Level 2.

        Removes an attribute by local name and namespace URI. If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.

        Specified by:
        removeAttributeNS in interface org.w3c.dom.Element
        Parameters:
        namespaceURI - The namespace URI of the attribute to remove.
        localName - The local name of the attribute to remove.
      • getAttributeNodeNS

        public org.w3c.dom.Attr getAttributeNodeNS​(java.lang.String namespaceURI,
                                                   java.lang.String localName)
        Retrieves an Attr node by local name and namespace URI.
        Specified by:
        getAttributeNodeNS in interface org.w3c.dom.Element
        Parameters:
        namespaceURI - The namespace URI of the attribute to retrieve.
        localName - The local name of the attribute to retrieve.
        Returns:
        Attr The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.
      • setAttributeNodeNS

        public org.w3c.dom.Attr setAttributeNodeNS​(org.w3c.dom.Attr newAttr)
                                            throws org.w3c.dom.DOMException
        Introduced in DOM Level 2.

        Adds a new attribute. If an attribute with that local name and namespace URI is already present in the element, it is replaced by the new one.

        Specified by:
        setAttributeNodeNS in interface org.w3c.dom.Element
        Parameters:
        newAttr - The Attr node to add to the attribute list. When the Node has no namespaceURI, this method behaves like setAttributeNode.
        Returns:
        Attr If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the * previously existing Attr node is returned, otherwise null is returned.
        Throws:
        org.w3c.dom.DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
        org.w3c.dom.DOMException - INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
      • hasAttributes

        public boolean hasAttributes()
        Returns whether this node (if it is an element) has any attributes. Introduced in DOM Level 2.
        Specified by:
        hasAttributes in interface org.w3c.dom.Node
        Overrides:
        hasAttributes in class NodeImpl
        Returns:
        true if this node has any attributes, false otherwise.
        See Also:
        ElementImpl
      • hasAttribute

        public boolean hasAttribute​(java.lang.String name)
        Introduced in DOM Level 2.
        Specified by:
        hasAttribute in interface org.w3c.dom.Element
      • hasAttributeNS

        public boolean hasAttributeNS​(java.lang.String namespaceURI,
                                      java.lang.String localName)
        Introduced in DOM Level 2.
        Specified by:
        hasAttributeNS in interface org.w3c.dom.Element
      • getElementsByTagNameNS

        public org.w3c.dom.NodeList getElementsByTagNameNS​(java.lang.String namespaceURI,
                                                           java.lang.String localName)
        Introduced in DOM Level 2.

        Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree, starting from this node.

        Specified by:
        getElementsByTagNameNS in interface org.w3c.dom.Element
        Parameters:
        namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces. When it is null or an empty string, this method behaves like getElementsByTagName.
        localName - The local name of the elements to match on. The special value "*" matches all local names.
        Returns:
        NodeList A new NodeList object containing all the matched Elements.
      • isEqualNode

        public boolean isEqualNode​(org.w3c.dom.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. DOM Level 3 WD- Experimental. Override inherited behavior from NodeImpl to support deep equal. DOM Level 3 WD- Experimental. Override inherited behavior from NodeImpl and ParentNode to check on attributes
        Specified by:
        isEqualNode in interface org.w3c.dom.Node
        Overrides:
        isEqualNode in class ParentNode
        Parameters:
        arg - The node to compare equality with.
        Returns:
        If the nodes, and possibly subtrees are equal, true otherwise false.
      • setIdAttributeNode

        public void setIdAttributeNode​(org.w3c.dom.Attr at,
                                       boolean makeId)
        DOM Level 3: register the given attribute node as an ID attribute
        Specified by:
        setIdAttributeNode in interface org.w3c.dom.Element
      • setIdAttribute

        public void setIdAttribute​(java.lang.String name,
                                   boolean makeId)
        DOM Level 3: register the given attribute node as an ID attribute
        Specified by:
        setIdAttribute in interface org.w3c.dom.Element
      • setIdAttributeNS

        public void setIdAttributeNS​(java.lang.String namespaceURI,
                                     java.lang.String localName,
                                     boolean makeId)
        DOM Level 3: register the given attribute node as an ID attribute
        Specified by:
        setIdAttributeNS in interface org.w3c.dom.Element
      • getTypeName

        public java.lang.String getTypeName()
        Specified by:
        getTypeName in interface org.w3c.dom.TypeInfo
        See Also:
        TypeInfo.getTypeName()
      • getTypeNamespace

        public java.lang.String getTypeNamespace()
        Specified by:
        getTypeNamespace in interface org.w3c.dom.TypeInfo
        See Also:
        TypeInfo.getTypeNamespace()
      • isDerivedFrom

        public boolean isDerivedFrom​(java.lang.String typeNamespaceArg,
                                     java.lang.String typeNameArg,
                                     int derivationMethod)
        Introduced in DOM Level 3.

        Checks if a type is derived from another by restriction. See: http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom

        Specified by:
        isDerivedFrom in interface org.w3c.dom.TypeInfo
        Parameters:
        typeNamespaceArg - The namspace of the ancestor type declaration
        typeNameArg - The name of the ancestor type declaration
        derivationMethod - The derivation method
        Returns:
        boolean True if the type is derived by restriciton for the reference type
      • getSchemaTypeInfo

        public org.w3c.dom.TypeInfo getSchemaTypeInfo()
        Method getSchemaTypeInfo.
        Specified by:
        getSchemaTypeInfo in interface org.w3c.dom.Element
        Returns:
        TypeInfo
      • moveSpecifiedAttributes

        void moveSpecifiedAttributes​(ElementImpl el)