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

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.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

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

Constructor Summary

Constructors

Constructor and Description
DOMDocument()
DOMDocument(DOMDocumentType docType)
DOMDocument(DOMElement rootElement)
DOMDocument(DOMElement rootElement, DOMDocumentType docType)
DOMDocument(java.lang.String name)
DOMDocument(java.lang.String name, DOMElement rootElement, DOMDocumentType docType)

Method Summary

Modifier and Type	Method and 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.NodeList	getChildNodes()
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.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, checkAddElementAllowed, childAdded, childRemoved, getDocument, getNodeType, getPath, getStringValue, getUniquePath, 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.w3c.dom.Node

getNodeType, normalize

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

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()

getPrefix

public java.lang.String getPrefix()

setPrefix

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

Throws:

org.w3c.dom.DOMException

getLocalName

public java.lang.String getLocalName()

getNodeName

public java.lang.String getNodeName()

getNodeValue

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

Throws:

org.w3c.dom.DOMException

setNodeValue

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

Throws:

org.w3c.dom.DOMException

getParentNode

public org.w3c.dom.Node getParentNode()

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

getFirstChild

public org.w3c.dom.Node getFirstChild()

getLastChild

public org.w3c.dom.Node getLastChild()

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

getNextSibling

public org.w3c.dom.Node getNextSibling()

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

insertBefore

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

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

Throws:

org.w3c.dom.DOMException

removeChild

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

Throws:

org.w3c.dom.DOMException

appendChild

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

Throws:

org.w3c.dom.DOMException

hasChildNodes

public boolean hasChildNodes()

cloneNode

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

isSupported

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

hasAttributes

public boolean hasAttributes()

getElementsByTagName

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

getElementsByTagNameNS

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

getDoctype

public org.w3c.dom.DocumentType getDoctype()

getImplementation

public org.w3c.dom.DOMImplementation getImplementation()

getDocumentElement

public org.w3c.dom.Element getDocumentElement()

createElement

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

Throws:

org.w3c.dom.DOMException

createDocumentFragment

public org.w3c.dom.DocumentFragment createDocumentFragment()

createTextNode

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

createComment

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

createCDATASection

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

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

Throws:

org.w3c.dom.DOMException

createAttribute

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

Throws:

org.w3c.dom.DOMException

createEntityReference

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

Throws:

org.w3c.dom.DOMException

importNode

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

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

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

Throws:

org.w3c.dom.DOMException

getElementById

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

getDocumentFactory

protected DocumentFactory getDocumentFactory()

Overrides:

getDocumentFactory in class DefaultDocument

getInputEncoding

public java.lang.String getInputEncoding()

getXmlEncoding

public java.lang.String getXmlEncoding()

getXmlStandalone

public boolean getXmlStandalone()

setXmlStandalone

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

Throws:

org.w3c.dom.DOMException

getXmlVersion

public java.lang.String getXmlVersion()

setXmlVersion

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

Throws:

org.w3c.dom.DOMException

getStrictErrorChecking

public boolean getStrictErrorChecking()

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

getDocumentURI

public java.lang.String getDocumentURI()

setDocumentURI

public void setDocumentURI(java.lang.String documentURI)

adoptNode

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

Throws:

org.w3c.dom.DOMException

getDomConfig

public org.w3c.dom.DOMConfiguration getDomConfig()

normalizeDocument

public void normalizeDocument()

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

Throws:

org.w3c.dom.DOMException

getBaseURI

public java.lang.String getBaseURI()

compareDocumentPosition

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

Throws:

org.w3c.dom.DOMException

getTextContent

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

Throws:

org.w3c.dom.DOMException

setTextContent

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

Throws:

org.w3c.dom.DOMException

isSameNode

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

lookupPrefix

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

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)

lookupNamespaceURI

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

isEqualNode

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

getFeature

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

setUserData

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

getUserData

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