gnu.xml.dom
Class DomElement

java.lang.Object
  |
  +--gnu.xml.dom.DomNode
        |
        +--gnu.xml.dom.DomNsNode
              |
              +--gnu.xml.dom.DomElement
All Implemented Interfaces:
java.lang.Cloneable, org.w3c.dom.events.DocumentEvent, org.w3c.dom.Element, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.w3c.dom.NodeList

public class DomElement
extends DomNsNode
implements org.w3c.dom.Element

"Element" implementation.

Version:
$Date: 2001/11/20 04:53:46 $
Author:
David Brownell

Field Summary
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
protected DomElement(org.w3c.dom.Document owner, java.lang.String namespaceURI, java.lang.String name)
          Constructs an Element node associated with the specified document.
 
Method Summary
 java.lang.Object clone()
          Shallow clone of the element, except that associated attributes are (deep) cloned.
 java.lang.String getAttribute(java.lang.String name)
          DOM L1 Returns the value of the specified attribute, or an empty string.
 org.w3c.dom.Attr getAttributeNode(java.lang.String name)
          DOM L1 Returns the appropriate attribute node; the name is the nodeName property of the attribute.
 org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespace, java.lang.String localPart)
          DOM L2 Returns the appropriate attribute node; the name combines the namespace name and the local part.
 java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.String local)
          DOM L2 Returns the value of the specified attribute, or an empty string.
 org.w3c.dom.NamedNodeMap getAttributes()
          DOM L1 Returns the element's attributes
 short getNodeType()
          DOM L1 Returns the constant ELEMENT_NODE.
 java.lang.String getTagName()
          DOM L1 Returns the element name (same as getNodeName).
 boolean hasAttribute(java.lang.String name)
          DOM L2 Returns true if the element has an attribute with the specified name (specified or DTD defaulted).
 boolean hasAttributeNS(java.lang.String namespaceURI, java.lang.String local)
          DOM L2 Returns true if the element has an attribute with the specified name (specified or DTD defaulted).
 boolean hasAttributes()
          DOM L2> Returns true iff this is an element node with attributes.
 void makeReadonly()
          Marks this element, its children, and its associated attributes as readonly.
 void removeAttribute(java.lang.String name)
          DOM L1 Removes the appropriate attribute node.
 org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr node)
          DOM L1 Removes the appropriate attribute node; the name is the nodeName property of the attribute.
 void removeAttributeNS(java.lang.String namespace, java.lang.String localPart)
          DOM L2 Removes the appropriate attribute node; the name combines the namespace name and the local part.
 void setAttribute(java.lang.String name, java.lang.String value)
          DOM L1 Modifies an existing attribute to have the specified value, or creates a new one with that value.
 org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr attr)
          DOM L1 Stores the specified attribute, optionally overwriting any existing one with that name.
 org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr attr)
          DOM L2 Stores the specified attribute, optionally overwriting any existing one with that name.
 void setAttributeNS(java.lang.String uri, java.lang.String aname, java.lang.String value)
          DOM L2 Modifies an existing attribute to have the specified value, or creates a new one with that value.
 
Methods inherited from class gnu.xml.dom.DomNsNode
getLocalName, getNamespaceURI, getNodeName, getPrefix, setPrefix
 
Methods inherited from class gnu.xml.dom.DomNode
addEventListener, appendChild, cloneNode, compact, createEvent, dispatchEvent, getChildNodes, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getLastChild, getLength, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isReadonly, isSupported, item, nameAndTypeEquals, normalize, removeChild, removeEventListener, replaceChild, setNodeValue, trimToSize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Element
getElementsByTagName, getElementsByTagNameNS
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Constructor Detail

DomElement

protected DomElement(org.w3c.dom.Document owner,
                     java.lang.String namespaceURI,
                     java.lang.String name)
Constructs an Element node associated with the specified document.

This constructor should only be invoked by a Document as part of its createElement functionality, or through a subclass which is similarly used in a "Sub-DOM" style layer.

Parameters:
owner - The document with which this node is associated
namespaceURI - Combined with the local part of the name, this is used to uniquely identify a type of element
name - Name of this element, which may include a prefix
Method Detail

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()
DOM L1 Returns the element's attributes

Specified by:
getAttributes in interface org.w3c.dom.Node
Overrides:
getAttributes in class DomNode

hasAttributes

public boolean hasAttributes()
DOM L2> Returns true iff this is an element node with attributes.

Specified by:
hasAttributes in interface org.w3c.dom.Node
Overrides:
hasAttributes in class DomNode

clone

public java.lang.Object clone()
Shallow clone of the element, except that associated attributes are (deep) cloned.

Overrides:
clone in class DomNode

makeReadonly

public void makeReadonly()
Marks this element, its children, and its associated attributes as readonly.

Overrides:
makeReadonly in class DomNode

getTagName

public final java.lang.String getTagName()
DOM L1 Returns the element name (same as getNodeName).

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

getNodeType

public final short getNodeType()
DOM L1 Returns the constant ELEMENT_NODE.

Specified by:
getNodeType in interface org.w3c.dom.Node

getAttribute

public java.lang.String getAttribute(java.lang.String name)
DOM L1 Returns the value of the specified attribute, or an empty string.

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

hasAttribute

public boolean hasAttribute(java.lang.String name)
DOM L2 Returns true if the element has an attribute with the specified name (specified or DTD defaulted).

Specified by:
hasAttribute in interface org.w3c.dom.Element

hasAttributeNS

public boolean hasAttributeNS(java.lang.String namespaceURI,
                              java.lang.String local)
DOM L2 Returns true if the element has an attribute with the specified name (specified or DTD defaulted).

Specified by:
hasAttributeNS in interface org.w3c.dom.Element

getAttributeNS

public java.lang.String getAttributeNS(java.lang.String namespaceURI,
                                       java.lang.String local)
DOM L2 Returns the value of the specified attribute, or an empty string.

Specified by:
getAttributeNS in interface org.w3c.dom.Element

getAttributeNode

public org.w3c.dom.Attr getAttributeNode(java.lang.String name)
DOM L1 Returns the appropriate attribute node; the name is the nodeName property of the attribute.

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

getAttributeNodeNS

public org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespace,
                                           java.lang.String localPart)
DOM L2 Returns the appropriate attribute node; the name combines the namespace name and the local part.

Specified by:
getAttributeNodeNS in interface org.w3c.dom.Element

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)
DOM L1 Modifies an existing attribute to have the specified value, or creates a new one with that value. The name used is the nodeName value.

Specified by:
setAttribute in interface org.w3c.dom.Element

setAttributeNS

public void setAttributeNS(java.lang.String uri,
                           java.lang.String aname,
                           java.lang.String value)
DOM L2 Modifies an existing attribute to have the specified value, or creates a new one with that value.

Specified by:
setAttributeNS in interface org.w3c.dom.Element

setAttributeNode

public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr attr)
DOM L1 Stores the specified attribute, optionally overwriting any existing one with that name.

Specified by:
setAttributeNode in interface org.w3c.dom.Element

setAttributeNodeNS

public org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr attr)
DOM L2 Stores the specified attribute, optionally overwriting any existing one with that name.

Specified by:
setAttributeNodeNS in interface org.w3c.dom.Element

removeAttribute

public void removeAttribute(java.lang.String name)
DOM L1 Removes the appropriate attribute node. If there is no such node, this is (bizarrely enough) a NOP so you won't see exceptions if your code deletes non-existent attributes.

Note that since there is no portable way for DOM to record DTD information, default values for attributes will never be provided automatically.

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

removeAttributeNode

public org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr node)
DOM L1 Removes the appropriate attribute node; the name is the nodeName property of the attribute.

Note that since there is no portable way for DOM to record DTD information, default values for attributes will never be provided automatically.

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

removeAttributeNS

public void removeAttributeNS(java.lang.String namespace,
                              java.lang.String localPart)
DOM L2 Removes the appropriate attribute node; the name combines the namespace name and the local part.

Note that since there is no portable way for DOM to record DTD information, default values for attributes will never be provided automatically.

Specified by:
removeAttributeNS in interface org.w3c.dom.Element


Source code is under GPL (with library exception) in the JAXP project at http://www.gnu.org/software/classpathx/jaxp
This documentation was derived from that source code on 2003-06-07.