Class AbstractDocument
- All Implemented Interfaces:
Serializable
,Cloneable
,Branch
,Document
,Node
- Direct Known Subclasses:
DefaultDocument
AbstractDocument
is an abstract base class for tree
implementors to use for implementation inheritence.
- Version:
- $Revision: 1.33 $
- Author:
- James Strachan
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
The encoding of this document as stated in the XML declarationFields 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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
method is theVisitor Pattern
method.void
Adds the givenElement
to this branch.addComment
(String comment) Adds a newComment
node with the given text to this branch.addElement
(String name) Adds a newElement
node with the given name to this branch and returns a reference to the new node.addElement
(String qualifiedName, String namespaceURI) Adds a newElement
node with the given qualified name and namespace URI to this branch and returns a reference to the new node.addElement
(QName qName) Adds a newElement
node with the givenQName
to this branch and returns a reference to the new node.addProcessingInstruction
(String target, String data) Adds a processing instruction for the given targetaddProcessingInstruction
(String target, Map data) Adds a processing instruction for the given targetasXML()
asXML
returns the textual XML representation of this node.asXPathResult
(Element parent) asXPathResult
returns a version of this node which is capable of being an XPath result.protected void
checkAddElementAllowed
(Element element) protected void
childAdded
(Node node) Called when a new child node has been added to me to allow any parent relationships to be created or events to be fired.protected void
childRemoved
(Node node) Called when a child node has been removed to allow any parent relationships to be deleted or events to be fired.getDocument
returns theDocument
that thisNode
is part of if this node supports the parent relationship.short
Returns the code according to the type of node.Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.Returns the XPath string-value of this node.getUniquePath
(Element context) Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node.Return the encoding of this document, as part of the XML declaration This isnull
when unspecified or when it is not known (such as when the Document was created in memory) or when the implementation does not support this operation.void
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes.boolean
Removes the givenElement
if the node is an immediate child of this branch.protected abstract void
rootElementAdded
(Element rootElement) Called to set the root element variablevoid
setRootElement
(Element rootElement) Sets the root element for this documentvoid
setXMLEncoding
(String enc) Sets the encoding of this document as it will appear in the XML declaration part of the document.toString()
void
write
writes this node as the default XML notation for this node.Methods inherited from class org.dom4j.tree.AbstractBranch
add, add, add, addElement, addNode, addNode, appendContent, content, contentList, contentRemoved, createContentList, createContentList, createEmptyList, createResultList, createSingleResultList, elementByID, elementID, getContentAsStringValue, getContentAsText, getText, getTextTrim, hasContent, indexOf, invalidNodeTypeAddException, isReadOnly, node, nodeCount, nodeIterator, remove, remove, remove, removeNode, setProcessingInstructions
Methods inherited from class org.dom4j.tree.AbstractNode
clone, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getDocumentFactory, getName, getNodeTypeName, getParent, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, 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, clearContent, content, elementByID, indexOf, node, nodeCount, nodeIterator, processingInstruction, processingInstructions, processingInstructions, remove, remove, remove, removeProcessingInstruction, setContent, setProcessingInstructions
Methods inherited from interface org.dom4j.Document
addDocType, getDocType, getEntityResolver, getRootElement, setDocType, setEntityResolver
Methods inherited from interface org.dom4j.Node
clone, createXPath, detach, getName, getNodeTypeName, getParent, getPath, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf
-
Field Details
-
encoding
The encoding of this document as stated in the XML declaration
-
-
Constructor Details
-
AbstractDocument
public AbstractDocument()
-
-
Method Details
-
getNodeType
public short getNodeType()Description copied from interface:Node
Returns the code according to the type of node. This makes processing nodes polymorphically much easier as the switch statement can be used instead of multiple if (instanceof) statements.- Specified by:
getNodeType
in interfaceNode
- Overrides:
getNodeType
in classAbstractNode
- Returns:
- a W3C DOM complient code for the node type such as ELEMENT_NODE or ATTRIBUTE_NODE
-
getPath
Description copied from interface:Node
Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c. No indexing will be used to restrict the path if multiple elements with the same name occur on the path.- Specified by:
getPath
in interfaceNode
- Parameters:
context
- is the parent context from which the relative path should start. If the context is null or the context is not an ancestor of this node then the path will be absolute and start from the document and so begin with the '/' character.- Returns:
- the XPath expression relative to the given context which will return a nodeset containing at least this node.
-
getUniquePath
Description copied from interface:Node
Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. This method will use the XPath index operator to restrict the path if multiple elements with the same name occur on the path.
- Specified by:
getUniquePath
in interfaceNode
- Parameters:
context
- is the parent context from which the path should start. If the context is null or the context is not an ancestor of this node then the path will start from the document and so begin with the '/' character.- Returns:
- the XPath expression relative to the given context which will return a nodeset containing just this node.
-
getDocument
Description copied from interface:Node
getDocument
returns theDocument
that thisNode
is part of if this node supports the parent relationship.This method is an optional feature and may not be supported for all
Node
implementations.- Specified by:
getDocument
in interfaceNode
- Overrides:
getDocument
in classAbstractNode
- Returns:
- the document of this node or null if this feature is not
supported or the node is not associated with a
Document
-
getXMLEncoding
Description copied from interface:Document
Return the encoding of this document, as part of the XML declaration This isnull
when unspecified or when it is not known (such as when the Document was created in memory) or when the implementation does not support this operation.The way this encoding is retrieved also depends on the way the XML source is parsed. For instance, if the SAXReader is used and if the underlying XMLReader implementation support the
org.xml.sax.ext.Locator2
interface, the result returned by this method is specified by thegetEncoding()
method of that interface.- Specified by:
getXMLEncoding
in interfaceDocument
- Returns:
- The encoding of this document, as stated in the XML declaration,
or
null
if unknown.
-
getStringValue
Description copied from interface:Node
Returns the XPath string-value of this node. The behaviour of this method is defined in the XPath specification .- Specified by:
getStringValue
in interfaceNode
- Overrides:
getStringValue
in classAbstractNode
- Returns:
- the text from all the child Text and Element nodes appended together.
-
asXML
Description copied from interface:Node
asXML
returns the textual XML representation of this node. -
write
Description copied from interface:Node
write
writes this node as the default XML notation for this node. If you wish to control the XML output (such as for pretty printing, changing the indentation policy etc.) then please useXMLWriter
or its derivations.- Specified by:
write
in interfaceNode
- Overrides:
write
in classAbstractNode
- Parameters:
out
- is theWriter
to output the XML to- Throws:
IOException
- DOCUMENT ME!
-
accept
accept
method is theVisitor Pattern
method. -
toString
-
normalize
public void normalize()Description copied from interface:Branch
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.In cases where the document containsCDATASections
, the normalize operation alone may not be sufficient, since XPointers do not differentiate betweenText
nodes andCDATASection
nodes. -
addComment
Description copied from interface:Document
Adds a newComment
node with the given text to this branch.- Specified by:
addComment
in interfaceDocument
- Parameters:
comment
- is the text for theComment
node.- Returns:
- this
Document
instance.
-
addProcessingInstruction
Description copied from interface:Document
Adds a processing instruction for the given target- Specified by:
addProcessingInstruction
in interfaceDocument
- Parameters:
target
- is the target of the processing instructiondata
- is the textual data (key/value pairs) of the processing instruction- Returns:
- this
Document
instance.
-
addProcessingInstruction
Description copied from interface:Document
Adds a processing instruction for the given target- Specified by:
addProcessingInstruction
in interfaceDocument
- Parameters:
target
- is the target of the processing instructiondata
- is a Map of the key / value pairs of the processing instruction- Returns:
- this
Document
instance.
-
addElement
Description copied from interface:Branch
Adds a newElement
node with the given name to this branch and returns a reference to the new node.- Specified by:
addElement
in interfaceBranch
- Overrides:
addElement
in classAbstractBranch
- Parameters:
name
- is the name for theElement
node.- Returns:
- the newly added
Element
node.
-
addElement
Description copied from interface:Branch
Adds a newElement
node with the given qualified name and namespace URI to this branch and returns a reference to the new node.- Specified by:
addElement
in interfaceBranch
- Overrides:
addElement
in classAbstractBranch
- Parameters:
qualifiedName
- is the fully qualified name of the ElementnamespaceURI
- is the URI of the namespace to use- Returns:
- the newly added
Element
node.
-
addElement
Description copied from interface:Branch
Adds a newElement
node with the givenQName
to this branch and returns a reference to the new node.- Specified by:
addElement
in interfaceBranch
- Overrides:
addElement
in classAbstractBranch
- Parameters:
qName
- is the qualified name for theElement
node.- Returns:
- the newly added
Element
node.
-
setRootElement
Description copied from interface:Document
Sets the root element for this document- Specified by:
setRootElement
in interfaceDocument
- Parameters:
rootElement
- the new root element for this document
-
add
Description copied from interface:Branch
Adds the givenElement
to this branch. If the given node already has a parent defined then anIllegalAddException
will be thrown.- Specified by:
add
in interfaceBranch
- Overrides:
add
in classAbstractBranch
- Parameters:
element
- is the element to be added
-
remove
Description copied from interface:Branch
Removes the givenElement
if the node is an immediate child of this branch. If the given node is not an immediate child of this branch then theNode.detach()
method should be used instead.- Specified by:
remove
in interfaceBranch
- Overrides:
remove
in classAbstractBranch
- Parameters:
element
- is the element to be removed- Returns:
- true if the element was removed
-
asXPathResult
Description copied from interface:Node
asXPathResult
returns a version of this node which is capable of being an XPath result. The result of an XPath expression should always support the parent relationship, whether the original XML tree was singly or doubly linked. If the node does not support the parent relationship then a new node will be created which is linked to its parent and returned.- Specified by:
asXPathResult
in interfaceNode
- Overrides:
asXPathResult
in classAbstractNode
- Parameters:
parent
- DOCUMENT ME!- Returns:
- a
Node
which supports the parent relationship
-
childAdded
Description copied from class:AbstractBranch
Called when a new child node has been added to me to allow any parent relationships to be created or events to be fired.- Specified by:
childAdded
in classAbstractBranch
- Parameters:
node
- DOCUMENT ME!
-
childRemoved
Description copied from class:AbstractBranch
Called when a child node has been removed to allow any parent relationships to be deleted or events to be fired.- Specified by:
childRemoved
in classAbstractBranch
- Parameters:
node
- DOCUMENT ME!
-
checkAddElementAllowed
-
rootElementAdded
Called to set the root element variable- Parameters:
rootElement
- DOCUMENT ME!
-
setXMLEncoding
Description copied from interface:Document
Sets the encoding of this document as it will appear in the XML declaration part of the document.- Specified by:
setXMLEncoding
in interfaceDocument
- Parameters:
enc
- the encoding of the document
-