Package org.dom4j.dom

Class DOMDocument

java.lang.Object

org.dom4j.tree.AbstractNode

org.dom4j.tree.AbstractBranch

org.dom4j.tree.AbstractDocument

org.dom4j.tree.DefaultDocument

org.dom4j.dom.DOMDocument

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Branch, Document, Node, org.w3c.dom.Document, org.w3c.dom.Node

public class DOMDocument
extends DefaultDocument
implements org.w3c.dom.Document

DOMDocument implements an XML document which supports the W3C DOM API.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dom4j.tree.AbstractDocument

encoding

Fields inherited from class org.dom4j.tree.AbstractBranch

DEFAULT_CONTENT_LIST_SIZE

Fields inherited from class org.dom4j.tree.AbstractNode

NODE_TYPE_NAMES

Fields inherited from interface org.dom4j.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 org.w3c.dom.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
DOMDocument()
DOMDocument(java.lang.String name)
DOMDocument(java.lang.String name, DOMElement rootElement, DOMDocumentType docType)
DOMDocument(DOMDocumentType docType)
DOMDocument(DOMElement rootElement)
DOMDocument(DOMElement rootElement, DOMDocumentType docType)

Method Summary

Modifier and Type	Method	Description
org.w3c.dom.Node	adoptNode(org.w3c.dom.Node source)
org.w3c.dom.Node	appendChild(org.w3c.dom.Node newChild)
org.w3c.dom.Node	cloneNode(boolean deep)
short	compareDocumentPosition(org.w3c.dom.Node other)
org.w3c.dom.Attr	createAttribute(java.lang.String name)
org.w3c.dom.Attr	createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName)
org.w3c.dom.CDATASection	createCDATASection(java.lang.String data)
org.w3c.dom.Comment	createComment(java.lang.String data)
org.w3c.dom.DocumentFragment	createDocumentFragment()
org.w3c.dom.Element	createElement(java.lang.String name)
org.w3c.dom.Element	createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName)
org.w3c.dom.EntityReference	createEntityReference(java.lang.String name)
org.w3c.dom.ProcessingInstruction	createProcessingInstruction(java.lang.String target, java.lang.String data)
org.w3c.dom.Text	createTextNode(java.lang.String data)
org.w3c.dom.NamedNodeMap	getAttributes()
java.lang.String	getBaseURI()
org.w3c.dom.DocumentType	getDoctype()
org.w3c.dom.Element	getDocumentElement()
protected DocumentFactory	getDocumentFactory()
java.lang.String	getDocumentURI()
org.w3c.dom.DOMConfiguration	getDomConfig()
org.w3c.dom.Element	getElementById(java.lang.String elementId)
org.w3c.dom.NodeList	getElementsByTagName(java.lang.String name)
org.w3c.dom.NodeList	getElementsByTagNameNS(java.lang.String namespace, java.lang.String name)
java.lang.Object	getFeature(java.lang.String feature, java.lang.String version)
org.w3c.dom.Node	getFirstChild()
org.w3c.dom.NodeList	getChildNodes()
org.w3c.dom.DOMImplementation	getImplementation()
java.lang.String	getInputEncoding()
org.w3c.dom.Node	getLastChild()
java.lang.String	getLocalName()
java.lang.String	getNamespaceURI()
org.w3c.dom.Node	getNextSibling()
java.lang.String	getNodeName()
java.lang.String	getNodeValue()
org.w3c.dom.Document	getOwnerDocument()
org.w3c.dom.Node	getParentNode()
java.lang.String	getPrefix()
org.w3c.dom.Node	getPreviousSibling()
boolean	getStrictErrorChecking()
java.lang.String	getTextContent()
java.lang.Object	getUserData(java.lang.String key)
java.lang.String	getXmlEncoding()
boolean	getXmlStandalone()
java.lang.String	getXmlVersion()
boolean	hasAttributes()
boolean	hasChildNodes()
org.w3c.dom.Node	importNode(org.w3c.dom.Node importedNode, boolean deep)
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)
boolean	isDefaultNamespace(java.lang.String namespaceURI)
boolean	isEqualNode(org.w3c.dom.Node other)
boolean	isSameNode(org.w3c.dom.Node other)
boolean	isSupported(java.lang.String feature, java.lang.String version)
java.lang.String	lookupNamespaceURI(java.lang.String prefix)
java.lang.String	lookupPrefix(java.lang.String namespaceURI)
void	normalizeDocument()
org.w3c.dom.Node	removeChild(org.w3c.dom.Node oldChild)
org.w3c.dom.Node	renameNode(org.w3c.dom.Node n, java.lang.String namespaceURI, java.lang.String qualifiedName)
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)
void	setDocumentURI(java.lang.String documentURI)
void	setNodeValue(java.lang.String nodeValue)
void	setPrefix(java.lang.String prefix)
void	setStrictErrorChecking(boolean strictErrorChecking)
void	setTextContent(java.lang.String textContent)
java.lang.Object	setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)
void	setXmlStandalone(boolean xmlStandalone)
void	setXmlVersion(java.lang.String xmlVersion)
boolean	supports(java.lang.String feature, java.lang.String version)

Methods inherited from class org.dom4j.tree.DefaultDocument

addDocType, addNode, addNode, clearContent, clone, contentList, getDocType, getEntityResolver, getName, getRootElement, getXMLEncoding, processingInstruction, processingInstructions, processingInstructions, removeNode, removeProcessingInstruction, rootElementAdded, setContent, setDocType, setDocumentFactory, setEntityResolver, setName

Methods inherited from class org.dom4j.tree.AbstractDocument

accept, add, addComment, addElement, addElement, addElement, addProcessingInstruction, addProcessingInstruction, asXML, asXPathResult, getDocument, getNodeType, getPath, getStringValue, getUniquePath, checkAddElementAllowed, childAdded, childRemoved, normalize, remove, setRootElement, setXMLEncoding, toString, write

Methods inherited from class org.dom4j.tree.AbstractBranch

add, add, add, addElement, appendContent, content, contentRemoved, createContentList, createContentList, createEmptyList, createResultList, createSingleResultList, elementByID, elementID, getContentAsStringValue, getContentAsText, getText, getTextTrim, hasContent, indexOf, invalidNodeTypeAddException, isReadOnly, node, nodeCount, nodeIterator, remove, remove, remove, setProcessingInstructions

Methods inherited from class org.dom4j.tree.AbstractNode

createPattern, createXPath, createXPathFilter, createXPathResult, detach, getNodeTypeName, getParent, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dom4j.Branch

add, add, add, appendContent, content, elementByID, indexOf, node, nodeCount, nodeIterator, remove, remove, remove, setProcessingInstructions

Methods inherited from interface org.dom4j.Node

createXPath, detach, getNodeTypeName, getParent, getPath, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf

Methods inherited from interface org.w3c.dom.Node

getNodeType, normalize

Constructor Detail

DOMDocument

public DOMDocument()

DOMDocument

public DOMDocument(java.lang.String name)

DOMDocument

public DOMDocument(DOMElement rootElement)

DOMDocument

public DOMDocument(DOMDocumentType docType)

DOMDocument

public DOMDocument(DOMElement rootElement,
                   DOMDocumentType docType)

DOMDocument

public DOMDocument(java.lang.String name,
                   DOMElement rootElement,
                   DOMDocumentType docType)

Method Detail

supports

public boolean supports(java.lang.String feature,
                        java.lang.String version)

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface org.w3c.dom.Node

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface org.w3c.dom.Node

setPrefix

public void setPrefix(java.lang.String prefix)
               throws org.w3c.dom.DOMException

Specified by:

setPrefix in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface org.w3c.dom.Node

getNodeName

public java.lang.String getNodeName()

Specified by:

getNodeName in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException

Specified by:

getNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
                  throws org.w3c.dom.DOMException

Specified by:

setNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getParentNode

public org.w3c.dom.Node getParentNode()

Specified by:

getParentNode in interface org.w3c.dom.Node

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

Specified by:

getChildNodes in interface org.w3c.dom.Node

getFirstChild

public org.w3c.dom.Node getFirstChild()

Specified by:

getFirstChild in interface org.w3c.dom.Node

getLastChild

public org.w3c.dom.Node getLastChild()

Specified by:

getLastChild in interface org.w3c.dom.Node

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

Specified by:

getPreviousSibling in interface org.w3c.dom.Node

getNextSibling

public org.w3c.dom.Node getNextSibling()

Specified by:

getNextSibling in interface org.w3c.dom.Node

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

Specified by:

getAttributes in interface org.w3c.dom.Node

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

Specified by:

getOwnerDocument in interface org.w3c.dom.Node

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
                              throws org.w3c.dom.DOMException

Specified by:

insertBefore in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)
                              throws org.w3c.dom.DOMException

Specified by:

replaceChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                             throws org.w3c.dom.DOMException

Specified by:

removeChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                             throws org.w3c.dom.DOMException

Specified by:

appendChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface org.w3c.dom.Node

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)

Specified by:

cloneNode in interface org.w3c.dom.Node

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)

Specified by:

isSupported in interface org.w3c.dom.Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface org.w3c.dom.Node

getElementsByTagName

public org.w3c.dom.NodeList getElementsByTagName(java.lang.String name)

Specified by:

getElementsByTagName in interface org.w3c.dom.Document

getElementsByTagNameNS

public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespace,
                                                   java.lang.String name)

Specified by:

getElementsByTagNameNS in interface org.w3c.dom.Document

getDoctype

public org.w3c.dom.DocumentType getDoctype()

Specified by:

getDoctype in interface org.w3c.dom.Document

getImplementation

public org.w3c.dom.DOMImplementation getImplementation()

Specified by:

getImplementation in interface org.w3c.dom.Document

getDocumentElement

public org.w3c.dom.Element getDocumentElement()

Specified by:

getDocumentElement in interface org.w3c.dom.Document

createElement

public org.w3c.dom.Element createElement(java.lang.String name)
                                  throws org.w3c.dom.DOMException

Specified by:

createElement in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

createDocumentFragment

public org.w3c.dom.DocumentFragment createDocumentFragment()

Specified by:

createDocumentFragment in interface org.w3c.dom.Document

createTextNode

public org.w3c.dom.Text createTextNode(java.lang.String data)

Specified by:

createTextNode in interface org.w3c.dom.Document

createComment

public org.w3c.dom.Comment createComment(java.lang.String data)

Specified by:

createComment in interface org.w3c.dom.Document

createCDATASection

public org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
                                            throws org.w3c.dom.DOMException

Specified by:

createCDATASection in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

createProcessingInstruction

public org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                                     java.lang.String data)
                                                              throws org.w3c.dom.DOMException

Specified by:

createProcessingInstruction in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

createAttribute

public org.w3c.dom.Attr createAttribute(java.lang.String name)
                                 throws org.w3c.dom.DOMException

Specified by:

createAttribute in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

createEntityReference

public org.w3c.dom.EntityReference createEntityReference(java.lang.String name)
                                                  throws org.w3c.dom.DOMException

Specified by:

createEntityReference in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

importNode

public org.w3c.dom.Node importNode(org.w3c.dom.Node importedNode,
                                   boolean deep)
                            throws org.w3c.dom.DOMException

Specified by:

importNode in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

createElementNS

public org.w3c.dom.Element createElementNS(java.lang.String namespaceURI,
                                           java.lang.String qualifiedName)
                                    throws org.w3c.dom.DOMException

Specified by:

createElementNS in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

createAttributeNS

public org.w3c.dom.Attr createAttributeNS(java.lang.String namespaceURI,
                                          java.lang.String qualifiedName)
                                   throws org.w3c.dom.DOMException

Specified by:

createAttributeNS in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

getElementById

public org.w3c.dom.Element getElementById(java.lang.String elementId)

Specified by:

getElementById in interface org.w3c.dom.Document

getDocumentFactory

protected DocumentFactory getDocumentFactory()

Overrides:

getDocumentFactory in class DefaultDocument

getInputEncoding

public java.lang.String getInputEncoding()

Specified by:

getInputEncoding in interface org.w3c.dom.Document

getXmlEncoding

public java.lang.String getXmlEncoding()

Specified by:

getXmlEncoding in interface org.w3c.dom.Document

getXmlStandalone

public boolean getXmlStandalone()

Specified by:

getXmlStandalone in interface org.w3c.dom.Document

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws org.w3c.dom.DOMException

Specified by:

setXmlStandalone in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

getXmlVersion

public java.lang.String getXmlVersion()

Specified by:

getXmlVersion in interface org.w3c.dom.Document

setXmlVersion

public void setXmlVersion(java.lang.String xmlVersion)
                   throws org.w3c.dom.DOMException

Specified by:

setXmlVersion in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

getStrictErrorChecking

public boolean getStrictErrorChecking()

Specified by:

getStrictErrorChecking in interface org.w3c.dom.Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

Specified by:

setStrictErrorChecking in interface org.w3c.dom.Document

getDocumentURI

public java.lang.String getDocumentURI()

Specified by:

getDocumentURI in interface org.w3c.dom.Document

setDocumentURI

public void setDocumentURI(java.lang.String documentURI)

Specified by:

setDocumentURI in interface org.w3c.dom.Document

adoptNode

public org.w3c.dom.Node adoptNode(org.w3c.dom.Node source)
                           throws org.w3c.dom.DOMException

Specified by:

adoptNode in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

getDomConfig

public org.w3c.dom.DOMConfiguration getDomConfig()

Specified by:

getDomConfig in interface org.w3c.dom.Document

normalizeDocument

public void normalizeDocument()

Specified by:

normalizeDocument in interface org.w3c.dom.Document

renameNode

public org.w3c.dom.Node renameNode(org.w3c.dom.Node n,
                                   java.lang.String namespaceURI,
                                   java.lang.String qualifiedName)
                            throws org.w3c.dom.DOMException

Specified by:

renameNode in interface org.w3c.dom.Document

Throws:

org.w3c.dom.DOMException

getBaseURI

public java.lang.String getBaseURI()

Specified by:

getBaseURI in interface org.w3c.dom.Node

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)
                              throws org.w3c.dom.DOMException

Specified by:

compareDocumentPosition in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException

Specified by:

getTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException

Specified by:

setTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)

Specified by:

isSameNode in interface org.w3c.dom.Node

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)

Specified by:

lookupPrefix in interface org.w3c.dom.Node

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)

Specified by:

isDefaultNamespace in interface org.w3c.dom.Node

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)

Specified by:

lookupNamespaceURI in interface org.w3c.dom.Node

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node other)

Specified by:

isEqualNode in interface org.w3c.dom.Node

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)

Specified by:

getFeature in interface org.w3c.dom.Node

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)

Specified by:

setUserData in interface org.w3c.dom.Node

getUserData

public java.lang.Object getUserData(java.lang.String key)

Specified by:

getUserData in interface org.w3c.dom.Node