Class DOMElement

java.lang.Object

org.dom4j.tree.AbstractNode

org.dom4j.tree.AbstractBranch

org.dom4j.tree.AbstractElement

org.dom4j.tree.DefaultElement

org.dom4j.dom.DOMElement

All Implemented Interfaces:

Serializable, Cloneable, Branch, Element, Node, Element, Node

public class DOMElement
extends DefaultElement
implements Element

DOMElement implements an XML element which supports the W3C DOM API.

Version:

$Revision: 1.23 $

Author:

James Strachan

See Also:

• Serialized Form

Field Summary

Fields inherited from class AbstractElement

USE_STRINGVALUE_SEPARATOR, VERBOSE_TOSTRING

Fields inherited from class AbstractBranch

DEFAULT_CONTENT_LIST_SIZE

Fields inherited from class AbstractNode

NODE_TYPE_NAMES

Fields inherited from interface Node

ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

Fields inherited from interface Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor	Description
DOMElement(String name)
DOMElement(String name, Namespace namespace)
DOMElement(QName qname)
DOMElement(QName qname, int attributeCount)

Method Summary

Modifier and Type	Method	Description
Node	appendChild(Node newChild)
protected Attribute	attribute(String namespaceURI, String localName)
protected Attribute	attribute(Attr attr)
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
protected Attribute	createAttribute(Attr newAttr)
String	getAttribute(String name)
Attr	getAttributeNode(String name)
Attr	getAttributeNodeNS(String namespaceURI, String localName)
String	getAttributeNS(String namespaceURI, String localName)
NamedNodeMap	getAttributes()
String	getBaseURI()
NodeList	getChildNodes()
protected DocumentFactory	getDocumentFactory()
NodeList	getElementsByTagName(String name)
NodeList	getElementsByTagNameNS(String namespace, String lName)
Object	getFeature(String feature, String version)
Node	getFirstChild()
Node	getLastChild()
String	getLocalName()
String	getNamespaceURI()	Returns the URI mapped to the namespace of this element if one exists otherwise an empty String is returned.
Node	getNextSibling()
String	getNodeName()
String	getNodeValue()
Document	getOwnerDocument()
Node	getParentNode()
String	getPrefix()
Node	getPreviousSibling()
protected QName	getQName(String namespace, String qualifiedName)
TypeInfo	getSchemaTypeInfo()
String	getTagName()
String	getTextContent()
Object	getUserData(String key)
boolean	hasAttribute(String name)
boolean	hasAttributeNS(String namespaceURI, String localName)
boolean	hasAttributes()
boolean	hasChildNodes()
Node	insertBefore(Node newChild, Node refChild)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node other)
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	removeAttribute(String name)
Attr	removeAttributeNode(Attr oldAttr)
void	removeAttributeNS(String namespaceURI, String localName)
Node	removeChild(Node oldChild)
Node	replaceChild(Node newChild, Node oldChild)
void	setAttribute(String name, String value)
Attr	setAttributeNode(Attr newAttr)
Attr	setAttributeNodeNS(Attr newAttr)
void	setAttributeNS(String namespaceURI, String qualifiedName, String value)
void	setIdAttribute(String name, boolean isId)
void	setIdAttributeNode(Attr idAttr, boolean isId)
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId)
void	setNodeValue(String nodeValue)
void	setPrefix(String prefix)
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
boolean	supports(String feature, String version)

Methods inherited from class DefaultElement

add, additionalNamespaces, additionalNamespaces, addNewNode, attribute, attribute, attribute, attribute, attributeCount, attributeIterator, attributeList, attributeList, attributes, clearContent, clone, contentList, declaredNamespaces, element, element, element, getDocument, getNamespaceForPrefix, getNamespaceForURI, getParent, getQName, getStringValue, getText, indexOf, node, nodeCount, nodeIterator, processingInstruction, processingInstructions, processingInstructions, remove, removeNode, removeProcessingInstruction, setAttributeList, setAttributes, setContent, setDocument, setParent, setQName, supportsParent

Methods inherited from class AbstractElement

accept, add, add, add, add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addElement, addEntity, addNamespace, addNewNode, addNode, addNode, addProcessingInstruction, addProcessingInstruction, addText, appendAttributes, asXML, attributeValue, attributeValue, attributeValue, attributeValue, childAdded, childRemoved, createAttributeList, createAttributeList, createCopy, createCopy, createCopy, createElement, createElement, createSingleIterator, elementIterator, elementIterator, elementIterator, elementIterator, elements, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, ensureAttributesCapacity, getData, getName, getNamespace, getNamespacePrefix, getNamespacesForURI, getNodeType, getPath, getQName, getQualifiedName, getUniquePath, getXPathNameStep, getXPathResult, hasMixedContent, isRootElement, isTextOnly, normalize, remove, remove, remove, remove, remove, remove, remove, remove, setAttributes, setAttributeValue, setAttributeValue, setData, setName, setNamespace, setText, toString, write

Methods inherited from class AbstractBranch

addElement, addElement, addElement, appendContent, content, contentRemoved, createContentList, createContentList, createEmptyList, createResultList, createSingleResultList, elementByID, elementID, getContentAsStringValue, getContentAsText, getTextTrim, hasContent, invalidNodeTypeAddException, isReadOnly, setProcessingInstructions

Methods inherited from class AbstractNode

asXPathResult, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getNodeTypeName, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Branch

addElement, addElement, appendContent, content, elementByID, setProcessingInstructions

Methods inherited from interface Element

getTextTrim

Methods inherited from interface Node

asXPathResult, createXPath, detach, getNodeTypeName, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf

Methods inherited from interface Node

getNodeType, normalize

Constructor Details

DOMElement

public DOMElement(String name)

DOMElement

public DOMElement(QName qname)

DOMElement

public DOMElement(QName qname,
 int attributeCount)

DOMElement

public DOMElement(String name,
 Namespace namespace)

Method Details

supports

public boolean supports(String feature,
 String version)

getNamespaceURI

public String getNamespaceURI()

Description copied from interface: Element

Returns the URI mapped to the namespace of this element if one exists otherwise an empty String is returned.

Specified by:

getNamespaceURI in interface Element

Specified by:

getNamespaceURI in interface Node

Overrides:

getNamespaceURI in class AbstractElement

Returns:

the URI for the Namespace of this element or an empty String

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Specified by:

setPrefix in interface Node

Throws:

DOMException

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

Specified by:

setNodeValue in interface Node

Throws:

DOMException

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

getChildNodes

public NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public Node getLastChild()

Specified by:

getLastChild in interface Node

getPreviousSibling

public Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

getAttributes

public NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

insertBefore

public Node insertBefore(Node newChild,
 Node refChild)
                  throws DOMException

Specified by:

insertBefore in interface Node

Throws:

DOMException

replaceChild

public Node replaceChild(Node newChild,
 Node oldChild)
                  throws DOMException

Specified by:

replaceChild in interface Node

Throws:

DOMException

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Specified by:

removeChild in interface Node

Throws:

DOMException

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Specified by:

appendChild in interface Node

Throws:

DOMException

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

cloneNode

public Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

isSupported

public boolean isSupported(String feature,
 String version)

Specified by:

isSupported in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

getTagName

public String getTagName()

Specified by:

getTagName in interface Element

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute in interface Element

setAttribute

public void setAttribute(String name,
 String value)
                  throws DOMException

Specified by:

setAttribute in interface Element

Throws:

DOMException

removeAttribute

public void removeAttribute(String name)
                     throws DOMException

Specified by:

removeAttribute in interface Element

Throws:

DOMException

getAttributeNode

public Attr getAttributeNode(String name)

Specified by:

getAttributeNode in interface Element

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
                      throws DOMException

Specified by:

setAttributeNode in interface Element

Throws:

DOMException

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)
                         throws DOMException

Specified by:

removeAttributeNode in interface Element

Throws:

DOMException

getAttributeNS

public String getAttributeNS(String namespaceURI,
 String localName)

Specified by:

getAttributeNS in interface Element

setAttributeNS

public void setAttributeNS(String namespaceURI,
 String qualifiedName,
 String value)
                    throws DOMException

Specified by:

setAttributeNS in interface Element

Throws:

DOMException

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
 String localName)
                       throws DOMException

Specified by:

removeAttributeNS in interface Element

Throws:

DOMException

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
 String localName)

Specified by:

getAttributeNodeNS in interface Element

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
                        throws DOMException

Specified by:

setAttributeNodeNS in interface Element

Throws:

DOMException

getElementsByTagName

public NodeList getElementsByTagName(String name)

Specified by:

getElementsByTagName in interface Element

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespace,
 String lName)

Specified by:

getElementsByTagNameNS in interface Element

hasAttribute

public boolean hasAttribute(String name)

Specified by:

hasAttribute in interface Element

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
 String localName)

Specified by:

hasAttributeNS in interface Element

getDocumentFactory

protected DocumentFactory getDocumentFactory()

Overrides:

getDocumentFactory in class DefaultElement

attribute

protected Attribute attribute(Attr attr)

attribute

protected Attribute attribute(String namespaceURI,
 String localName)

createAttribute

protected Attribute createAttribute(Attr newAttr)

getQName

protected QName getQName(String namespace,
 String qualifiedName)

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface Element

setIdAttribute

public void setIdAttribute(String name,
 boolean isId)
                    throws DOMException

Specified by:

setIdAttribute in interface Element

Throws:

DOMException

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
 String localName,
 boolean isId)
                      throws DOMException

Specified by:

setIdAttributeNS in interface Element

Throws:

DOMException

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
 boolean isId)
                        throws DOMException

Specified by:

setIdAttributeNode in interface Element

Throws:

DOMException

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

isEqualNode

public boolean isEqualNode(Node other)

Specified by:

isEqualNode in interface Node

getFeature

public Object getFeature(String feature,
 String version)

Specified by:

getFeature in interface Node

setUserData

public Object setUserData(String key,
 Object data,
 UserDataHandler handler)

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node