| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.dom4j.tree.AbstractNode
org.dom4j.tree.AbstractBranch
org.dom4j.tree.AbstractDocument
 AbstractDocument is an abstract base class for tree
 implementors to use for implementation inheritence.
 
| Field Summary | |
| protected  String | encodingThe encoding of this document as stated in the XML declaration | 
| 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 | 
| Constructor Summary | |
| AbstractDocument() | |
| Method Summary | |
|  void | accept(Visitor visitor)acceptmethod is theVisitor Patternmethod. | 
|  void | add(Element element)Adds the given Elementto this branch. | 
|  Document | addComment(String comment)Adds a new Commentnode with the given text to this
 branch. | 
|  Element | addElement(QName qName)Adds a new Elementnode with the givenQNameto
 this branch and returns a reference to the new node. | 
|  Element | addElement(String name)Adds a new Elementnode with the given name to this branch
 and returns a reference to the new node. | 
|  Element | addElement(String qualifiedName,
           String namespaceURI)Adds a new Elementnode with the given qualified name and
 namespace URI to this branch and returns a reference to the new node. | 
|  Document | addProcessingInstruction(String target,
                         Map data)Adds a processing instruction for the given target | 
|  Document | addProcessingInstruction(String target,
                         String data)Adds a processing instruction for the given target | 
|  String | asXML()asXMLreturns the textual XML representation of this node. | 
|  Node | asXPathResult(Element parent)asXPathResultreturns 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. | 
|  Document | getDocument()getDocumentreturns theDocumentthat thisNodeis part of if this node supports the parent
 relationship. | 
|  short | getNodeType()Returns the code according to the type of node. | 
|  String | getPath(Element context)Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c. | 
|  String | getStringValue()Returns the XPath string-value of this node. | 
|  String | 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. | 
|  String | getXMLEncoding()Return the encoding of this document, as part of the XML declaration This is nullwhen 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 | normalize()Puts all Textnodes 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) separatesTextnodes, i.e., there are neither adjacentTextnodes nor emptyTextnodes. | 
|  boolean | remove(Element element)Removes the given Elementif the node is an immediate
 child of this branch. | 
| protected abstract  void | rootElementAdded(Element rootElement)Called to set the root element variable | 
|  void | setRootElement(Element rootElement)Sets the root element for this document | 
|  void | setXMLEncoding(String enc)Sets the encoding of this document as it will appear in the XML declaration part of the document. | 
|  String | toString() | 
|  void | write(Writer out)writewrites 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.Document | 
| addDocType, getDocType, getEntityResolver, getRootElement, setDocType, setEntityResolver | 
| 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.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 Detail | 
protected String encoding
| Constructor Detail | 
public AbstractDocument()
| Method Detail | 
public short getNodeType()
Node
getNodeType in interface NodegetNodeType in class AbstractNodepublic String getPath(Element context)
Node
getPath in interface Nodecontext - 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.
public String getUniquePath(Element context)
NodeReturns 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.
getUniquePath in interface Nodecontext - 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.
public Document getDocument()
Node
 getDocument returns the Document that this
 Node 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.
 
getDocument in interface NodegetDocument in class AbstractNodepublic String getXMLEncoding()
Documentnull 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 the getEncoding() method of
 that interface.
 
getXMLEncoding in interface Documentnull if unknown.public String getStringValue()
Node
getStringValue in interface NodegetStringValue in class AbstractNodepublic String asXML()
Node
 asXML returns the textual XML representation of this node.
 
asXML in interface Node
public void write(Writer out)
           throws IOException
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 use XMLWriter or its derivations.
 
write in interface Nodewrite in class AbstractNodeIOExceptionpublic void accept(Visitor visitor)
 accept method is the Visitor Pattern
 method.
 
accept in interface Nodevisitor - Visitor is the visitor.public String toString()
public void normalize()
BranchText nodes in the full depth of the sub-tree
 underneath this Node, including attribute nodes, into a
 "normal" form where only structure (e.g., elements, comments, processing
 instructions, CDATA sections, and entity references) separates
 Text nodes, i.e., there are neither adjacent
 Text nodes nor empty Text 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 contains CDATASections,
 the normalize operation alone may not be sufficient, since XPointers do
 not differentiate between Text nodes and
 CDATASection nodes.
normalize in interface Branchpublic Document addComment(String comment)
DocumentComment node with the given text to this
 branch.
addComment in interface Documentcomment - is the text for the Comment node.
Document instance.
public Document addProcessingInstruction(String target,
                                         String data)
Document
addProcessingInstruction in interface Documenttarget - is the target of the processing instructiondata - is the textual data (key/value pairs) of the processing
            instruction
Document instance.
public Document addProcessingInstruction(String target,
                                         Map data)
Document
addProcessingInstruction in interface Documenttarget - is the target of the processing instructiondata - is a Map of the key / value pairs of the processing
            instruction
Document instance.public Element addElement(String name)
BranchElement node with the given name to this branch
 and returns a reference to the new node.
addElement in interface BranchaddElement in class AbstractBranch
public Element addElement(String qualifiedName,
                          String namespaceURI)
BranchElement node with the given qualified name and
 namespace URI to this branch and returns a reference to the new node.
addElement in interface BranchaddElement in class AbstractBranchpublic Element addElement(QName qName)
BranchElement node with the given QNameto
 this branch and returns a reference to the new node.
addElement in interface BranchaddElement in class AbstractBranchpublic void setRootElement(Element rootElement)
Document
setRootElement in interface DocumentrootElement - the new root element for this documentpublic void add(Element element)
BranchElement to this branch. If the given node
 already has a parent defined then an IllegalAddException
 will be thrown.
add in interface Branchadd in class AbstractBranchpublic boolean remove(Element element)
BranchElement if the node is an immediate
 child of this branch. If the given node is not an immediate child of this
 branch then the Node.detach()method should be used instead.
remove in interface Branchremove in class AbstractBranchpublic Node asXPathResult(Element parent)
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.
 
asXPathResult in interface NodeasXPathResult in class AbstractNodeprotected void childAdded(Node node)
AbstractBranch
childAdded in class AbstractBranchnode - DOCUMENT ME!protected void childRemoved(Node node)
AbstractBranch
childRemoved in class AbstractBranchnode - DOCUMENT ME!protected void checkAddElementAllowed(Element element)
protected abstract void rootElementAdded(Element rootElement)
rootElement - DOCUMENT ME!public void setXMLEncoding(String enc)
Document
setXMLEncoding in interface Documentenc - the encoding of the document| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||