Dom4jProxy (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.hibernate.proxy.dom4j.Dom4jProxy

All Implemented Interfaces:

Serializable, Cloneable, Branch, Element, Node, HibernateProxy
```
public class Dom4jProxy
extends Object
implements HibernateProxy, Element, Serializable
```
Proxy for "dom4j" entity representations.

Author:

Steve Ebersole

See Also:
Serialized Form

Field Summary
- 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

Dom4jProxy(Dom4jLazyInitializer li)

Constructors
Constructor and Description
`Dom4jProxy(Dom4jLazyInitializer li)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(Visitor visitor)` `accept` is the method used in the Visitor Pattern.
`void`	`add(Attribute attribute)` Adds the given `Attribute` to this element.
`void`	`add(CDATA cdata)` Adds the given `CDATA` to this element.
`void`	`add(Comment comment)` Adds the given `Comment` to this branch.
`void`	`add(Element element)` Adds the given `Element` to this branch.
`void`	`add(Entity entity)` Adds the given `Entity` to this element.
`void`	`add(Namespace namespace)` Adds the given `Namespace` to this element.
`void`	`add(Node node)` Adds the given `Node` or throws `IllegalAddException` if the given node is not of a valid type.
`void`	`add(ProcessingInstruction processingInstruction)` Adds the given `ProcessingInstruction` to this branch.
`void`	`add(Text text)` Adds the given `Text` to this element.
`Element`	`addAttribute(QName attrName, String text)` Adds the attribute value of the given fully qualified name.
`Element`	`addAttribute(String attrName, String text)` Adds the attribute value of the given local name.
`Element`	`addCDATA(String text)` Adds a new `CDATA` node with the given text to this element.
`Element`	`addComment(String text)` Adds a new `Comment` node with the given text to this element.
`Element`	`addElement(QName qName)` Adds a new `Element` node with the given `QName`to this branch and returns a reference to the new node.
`Element`	`addElement(String name)` Adds a new `Element` node with the given name to this branch and returns a reference to the new node.
`Element`	`addElement(String name, String text)` Adds a new `Element` node with the given qualified name and namespace URI to this branch and returns a reference to the new node.
`Element`	`addEntity(String name, String text)` Adds a new `Entity` node with the given name and text to this element and returns a reference to the new node.
`List`	`additionalNamespaces()` Returns any additional namespaces declarations for this element other than namespace returned via the `Element.getNamespace()`method.
`Element`	`addNamespace(String prefix, String uri)` Adds a namespace to this element for use by its child content
`Element`	`addProcessingInstruction(String target, Map data)` Adds a processing instruction for the given target
`Element`	`addProcessingInstruction(String target, String text)` Adds a processing instruction for the given target
`Element`	`addText(String text)` Adds a new `Text` node with the given text to this element.
`void`	`appendAttributes(Element element)` Appends the attributes of the given element to me.
`void`	`appendContent(Branch branch)` Appends the content of the given branch to this branch instance.
`String`	`asXML()` `asXML` returns the textual XML representation of this node.
`Node`	`asXPathResult(Element element)` `asXPathResult` returns a version of this node which is capable of being an XPath result.
`Attribute`	`attribute(int i)` Returns the attribute at the specified indexGets the
`Attribute`	`attribute(QName qName)` DOCUMENT ME!
`Attribute`	`attribute(String name)` Returns the attribute with the given name
`int`	`attributeCount()` DOCUMENT ME!
`Iterator`	`attributeIterator()` DOCUMENT ME!
`List`	`attributes()` Returns the `Attribute`instances this element contains as a backed `List`so that the attributes may be modified directly using the `List`interface.
`String`	`attributeValue(QName qName)` This returns the attribute value for the attribute with the given fully qualified name or null if there is no such attribute or the empty string if the attribute value is empty.
`String`	`attributeValue(QName qName, String defaultValue)` This returns the attribute value for the attribute with the given fully qualified name or the default value if there is no such attribute value.
`String`	`attributeValue(String name)` This returns the attribute value for the attribute with the given name and any namespace or null if there is no such attribute or the empty string if the attribute value is empty.
`String`	`attributeValue(String name, String defaultValue)` This returns the attribute value for the attribute with the given name and any namespace or the default value if there is no such attribute value.
`void`	`clearContent()` Clears the content for this branch, removing any `Node` instances this branch may contain.
`Object`	`clone()` `clone` will return a deep clone or if this node is read-only then clone will return the same instance.
`List`	`content()` Returns the content nodes of this branch as a backed `List`so that the content of this branch may be modified directly using the `List`interface.
`Element`	`createCopy()` Creates a deep copy of this element The new element is detached from its parent, and getParent() on the clone will return null.
`Element`	`createCopy(QName qName)` Creates a deep copy of this element with the given fully qualified name.
`Element`	`createCopy(String name)` Creates a deep copy of this element with the given local name The new element is detached from its parent, and getParent() on the clone will return null.
`XPath`	`createXPath(String xpath)` `createXPath` creates an XPath object for the given xpathExpression.
`List`	`declaredNamespaces()` Returns all the namespaces declared by this element.
`Node`	`detach()` Removes this node from its parent if there is one.
`Element`	`element(QName qName)` Returns the first element for the given fully qualified name.
`Element`	`element(String name)` Returns the first element for the given local name and any namespace.
`Element`	`elementByID(String id)` Returns the element of the given ID attribute value.
`Iterator`	`elementIterator()` Returns an iterator over all this elements child elements.
`Iterator`	`elementIterator(QName qName)` Returns an iterator over the elements contained in this element which match the given fully qualified name.
`Iterator`	`elementIterator(String name)` Returns an iterator over the elements contained in this element which match the given local name and any namespace.
`List`	`elements()` Returns the elements contained in this element.
`List`	`elements(QName qName)` Returns the elements contained in this element with the given fully qualified name.
`List`	`elements(String name)` Returns the elements contained in this element with the given local name and any namespace.
`String`	`elementText(QName qName)`
`String`	`elementText(String name)`
`String`	`elementTextTrim(QName qName)`
`String`	`elementTextTrim(String name)`
`Object`	`getData()` Accesses the data of this element which may implement data typing bindings such as XML Schema or Java Bean bindings or will return the same value as `Element.getText()`
`Document`	`getDocument()` `getDocument` returns the `Document` that this `Node` is part of if this node supports the parent relationship.
`LazyInitializer`	`getHibernateLazyInitializer()` Get the underlying lazy initialization handler.
`String`	`getName()` `getName` returns the name of this node.
`Namespace`	`getNamespace()` Returns the `Namespace` of this element if one exists otherwise `Namespace.NO_NAMESPACE` is returned.
`Namespace`	`getNamespaceForPrefix(String s)` Returns the `Namespace` which is mapped to the given prefix or null if it could not be found.
`Namespace`	`getNamespaceForURI(String s)` Returns the `Namespace` which is mapped to the given URI or null if it could not be found.
`String`	`getNamespacePrefix()` Returns the namespace prefix of this element if one exists otherwise an empty `String` is returned.
`List`	`getNamespacesForURI(String s)` Returns the all namespaces which are mapped to the given URI or an empty list if no such namespaces could be found.
`String`	`getNamespaceURI()` Returns the URI mapped to the namespace of this element if one exists otherwise an empty `String` is returned.
`short`	`getNodeType()` Returns the code according to the type of node.
`String`	`getNodeTypeName()` DOCUMENT ME!
`Element`	`getParent()` `getParent` returns the parent `Element` if this node supports the parent relationship or null if it is the root element or does not support the parent relationship.
`String`	`getPath()` Returns the XPath expression which will return a node set containing the given node such as /a/b/@c.
`String`	`getPath(Element element)` Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.
`QName`	`getQName()` Returns the `QName` of this element which represents the local name, the qualified name and the `Namespace`.
`QName`	`getQName(String s)` Returns the `QName` for the given qualified name, using the namespace URI in scope for the given prefix of the qualified name or the default namespace if the qualified name has no prefix.
`String`	`getQualifiedName()` Returns the fully qualified name of this element.
`String`	`getStringValue()` Returns the XPath string-value of this node.
`String`	`getText()` Returns the text value of this element without recursing through child elements.
`String`	`getTextTrim()` DOCUMENT ME!
`String`	`getUniquePath()` Returns the XPath expression which will return a nodeset of one node which is the current node.
`String`	`getUniquePath(Element element)` Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node.
`Node`	`getXPathResult(int i)` Returns a node at the given index suitable for an XPath result set.
`boolean`	`hasContent()` `hasContent` returns true if this node is a Branch (either an Element or a Document) and it contains at least one content node such as a child Element or Text node.
`boolean`	`hasMixedContent()` Returns true if this `Element` has mixed content.
`int`	`indexOf(Node node)` Returns the index of the given node if it is a child node of this branch or -1 if the given node is not a child node.
`boolean`	`isReadOnly()` `isReadOnly` returns true if this node is read only and cannot be modified.
`boolean`	`isRootElement()` DOCUMENT ME!
`boolean`	`isTextOnly()` Returns true if this `Element` has text only content.
`boolean`	`matches(String xpath)` `matches` returns true if evaluating the given XPath expression on this node returns a non-empty node set containing this node.
`Node`	`node(int i)` Returns the `Node` at the specified index position.
`int`	`nodeCount()` Returns the number of `Node` instances that this branch contains.
`Iterator`	`nodeIterator()` Returns an iterator through the content nodes of this branch
`void`	`normalize()` Puts all `Text` 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.
`Number`	`numberValueOf(String xpath)` `numberValueOf` evaluates an XPath expression and returns the numeric value of the XPath expression if the XPath expression results in a number, or null if the result is not a number.
`ProcessingInstruction`	`processingInstruction(String name)` DOCUMENT ME!
`List`	`processingInstructions()` Returns a list of all the processing instructions in this branch.
`List`	`processingInstructions(String name)` Returns a list of the processing instructions for the given target.
`boolean`	`remove(Attribute attribute)` Removes the given `Attribute` from this element.
`boolean`	`remove(CDATA cdata)` Removes the given `CDATA` if the node is an immediate child of this element.
`boolean`	`remove(Comment comment)` Removes the given `Comment` if the node is an immediate child of this branch.
`boolean`	`remove(Element element)` Removes the given `Element` if the node is an immediate child of this branch.
`boolean`	`remove(Entity entity)` Removes the given `Entity` if the node is an immediate child of this element.
`boolean`	`remove(Namespace namespace)` Removes the given `Namespace` if the node is an immediate child of this element.
`boolean`	`remove(Node node)` Removes the given `Node` if the node is an immediate child of this branch.
`boolean`	`remove(ProcessingInstruction processingInstruction)` Removes the given `ProcessingInstruction` if the node is an immediate child of this branch.
`boolean`	`remove(Text text)` Removes the given `Text` if the node is an immediate child of this element.
`boolean`	`removeProcessingInstruction(String name)` Removes the processing instruction for the given target if it exists
`List`	`selectNodes(String xpath)` `selectNodes` evaluates an XPath expression and returns the result as a `List` of `Node` instances or `String` instances depending on the XPath expression.
`List`	`selectNodes(String xpath, String comparison)` `selectNodes` evaluates an XPath expression then sorts the results using a secondary XPath expression Returns a sorted `List` of `Node` instances.
`List`	`selectNodes(String xpath, String comparison, boolean removeDups)` `selectNodes` evaluates an XPath expression then sorts the results using a secondary XPath expression Returns a sorted `List` of `Node` instances.
`Object`	`selectObject(String xpath)` `selectObject` evaluates an XPath expression and returns the result as an `Object`.
`Node`	`selectSingleNode(String xpath)` `selectSingleNode` evaluates an XPath expression and returns the result as a single `Node` instance.
`void`	`setAttributes(List list)` Sets the attributes that this element contains
`void`	`setAttributeValue(QName qName, String value)` Deprecated.
`void`	`setAttributeValue(String name, String value)` Deprecated.
`void`	`setContent(List list)` Sets the contents of this branch as a `List` of `Node` instances.
`void`	`setData(Object data)` Sets the data value of this element if this element supports data binding or calls `Node.setText(java.lang.String)`if it doesn't
`void`	`setDocument(Document document)` `setDocument` sets the document of this node if the parent relationship is supported or does nothing if the parent relationship is not supported.
`void`	`setName(String name)` Sets the text data of this node or this method will throw an `UnsupportedOperationException` if it is read-only.
`void`	`setParent(Element element)` `setParent` sets the parent relationship of this node if the parent relationship is supported or does nothing if the parent relationship is not supported.
`void`	`setProcessingInstructions(List list)` Sets all the processing instructions for this branch
`void`	`setQName(QName qName)` Sets the `QName` of this element which represents the local name, the qualified name and the `Namespace`.
`void`	`setText(String text)` Sets the text data of this node or this method will throw an `UnsupportedOperationException` if it is read-only.
`boolean`	`supportsParent()` `supportsParent` returns true if this node supports the parent relationship.
`String`	`valueOf(String xpath)` `valueOf` evaluates an XPath expression and returns the textual representation of the results the XPath string-value of this node.
`void`	`write(Writer writer)` `write` writes this node as the default XML notation for this node.
`Object`	`writeReplace()` Perform serialization-time write-replacement of this proxy.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Dom4jProxy
```
public Dom4jProxy(Dom4jLazyInitializer li)
```
- Method Detail
  - writeReplace
```
public Object writeReplace()
```
    Description copied from interface: HibernateProxy
    
    Perform serialization-time write-replacement of this proxy.
    
    Specified by:
    
    writeReplace in interface HibernateProxy
    
    Returns:
    The serializable proxy replacement.
  - getHibernateLazyInitializer
```
public LazyInitializer getHibernateLazyInitializer()
```
    Description copied from interface: HibernateProxy
    
    Get the underlying lazy initialization handler.
    
    Specified by:
    
    getHibernateLazyInitializer in interface HibernateProxy
    
    Returns:
    The lazy initializer.
  - getQName
```
public QName getQName()
```
    Description copied from interface: Element
    
    Returns the QName of this element which represents the local name, the qualified name and the Namespace.
    
    Specified by:
    
    getQName in interface Element
    
    Returns:
    the QName associated with this element
  - getQName
```
public QName getQName(String s)
```
    Description copied from interface: Element
    
    Returns the QName for the given qualified name, using the namespace URI in scope for the given prefix of the qualified name or the default namespace if the qualified name has no prefix.
    
    Specified by:
    
    getQName in interface Element
    
    Parameters:
    s - DOCUMENT ME!
    
    Returns:
    the QName for the given qualified name
  - setQName
```
public void setQName(QName qName)
```
    Description copied from interface: Element
    
    Sets the QName of this element which represents the local name, the qualified name and the Namespace.
    
    Specified by:
    
    setQName in interface Element
    
    Parameters:
    qName - is the QName to be associated with this element
  - getNamespace
```
public Namespace getNamespace()
```
    Description copied from interface: Element
    
    Returns the Namespace of this element if one exists otherwise Namespace.NO_NAMESPACE is returned.
    
    Specified by:
    
    getNamespace in interface Element
    
    Returns:
    the Namespace associated with this element
  - getNamespaceForPrefix
```
public Namespace getNamespaceForPrefix(String s)
```
    Description copied from interface: Element
    
    Returns the Namespace which is mapped to the given prefix or null if it could not be found.
    
    Specified by:
    
    getNamespaceForPrefix in interface Element
    
    Parameters:
    s - DOCUMENT ME!
    
    Returns:
    the Namespace associated with the given prefix
  - getNamespaceForURI
```
public Namespace getNamespaceForURI(String s)
```
    Description copied from interface: Element
    
    Returns the Namespace which is mapped to the given URI or null if it could not be found. If there is more than one Namespace mapped to the URI, which of them will be returned is undetermined.
    
    Specified by:
    
    getNamespaceForURI in interface Element
    
    Parameters:
    s - DOCUMENT ME!
    
    Returns:
    the Namespace associated with the given URI
  - getNamespacesForURI
```
public List getNamespacesForURI(String s)
```
    Description copied from interface: Element
    
    Returns the all namespaces which are mapped to the given URI or an empty list if no such namespaces could be found.
    
    Specified by:
    
    getNamespacesForURI in interface Element
    
    Parameters:
    s - DOCUMENT ME!
    
    Returns:
    the namespaces associated with the given URI
  - getNamespacePrefix
```
public String getNamespacePrefix()
```
    Description copied from interface: Element
    
    Returns the namespace prefix of this element if one exists otherwise an empty String is returned.
    
    Specified by:
    
    getNamespacePrefix in interface Element
    
    Returns:
    the prefix of the Namespace of this element or an empty String
  - 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
    
    Returns:
    the URI for the Namespace of this element or an empty String
  - getQualifiedName
```
public String getQualifiedName()
```
    Description copied from interface: Element
    Returns the fully qualified name of this element. This will be the same as the value returned from Node.getName()if this element has no namespace attached to this element or an expression of the form
```
 getNamespacePrefix() + ":" + getName()
 
```
    will be returned.
    Specified by:
    
    getQualifiedName in interface Element
    
    Returns:
    the fully qualified name of the element.
  - additionalNamespaces
```
public List additionalNamespaces()
```
    Description copied from interface: Element
    
    Returns any additional namespaces declarations for this element other than namespace returned via the Element.getNamespace()method. If no additional namespace declarations are present for this element then an empty list will be returned. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
    
    Specified by:
    
    additionalNamespaces in interface Element
    
    Returns:
    a list of any additional namespace declarations.
  - declaredNamespaces
```
public List declaredNamespaces()
```
    Description copied from interface: Element
    
    Returns all the namespaces declared by this element. If no namespaces are declared for this element then an empty list will be returned. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
    
    Specified by:
    
    declaredNamespaces in interface Element
    
    Returns:
    a list of namespaces declared for this element.
  - addAttribute
```
public Element addAttribute(String attrName,
                   String text)
```
    Description copied from interface: Element
    
    Adds the attribute value of the given local name. If an attribute already exists for the given name it will be replaced. Attributes with null values are silently ignored. If the value of the attribute is null then this method call will remove any attributes with the given name.
    
    Specified by:
    
    addAttribute in interface Element
    
    Parameters:
    attrName - is the name of the attribute whose value is to be added or updated
    text - is the attribute's value
    
    Returns:
    this Element instance.
  - addAttribute
```
public Element addAttribute(QName attrName,
                   String text)
```
    Description copied from interface: Element
    
    Adds the attribute value of the given fully qualified name. If an attribute already exists for the given name it will be replaced. Attributes with null values are silently ignored. If the value of the attribute is null then this method call will remove any attributes with the given name.
    
    Specified by:
    
    addAttribute in interface Element
    
    Parameters:
    attrName - is the fully qualified name of the attribute whose value is to be added or updated
    text - is the attribute's value
    
    Returns:
    this Element instance.
  - addComment
```
public Element addComment(String text)
```
    Description copied from interface: Element
    
    Adds a new Comment node with the given text to this element.
    
    Specified by:
    
    addComment in interface Element
    
    Parameters:
    text - is the text for the Comment node.
    
    Returns:
    this Element instance.
  - addCDATA
```
public Element addCDATA(String text)
```
    Description copied from interface: Element
    
    Adds a new CDATA node with the given text to this element.
    
    Specified by:
    
    addCDATA in interface Element
    
    Parameters:
    text - is the text for the CDATA node.
    
    Returns:
    this Element instance.
  - addEntity
```
public Element addEntity(String name,
                String text)
```
    Description copied from interface: Element
    
    Adds a new Entity node with the given name and text to this element and returns a reference to the new node.
    
    Specified by:
    
    addEntity in interface Element
    
    Parameters:
    name - is the name for the Entity node.
    text - is the text for the Entity node.
    
    Returns:
    this Element instance.
  - addNamespace
```
public Element addNamespace(String prefix,
                   String uri)
```
    Description copied from interface: Element
    
    Adds a namespace to this element for use by its child content
    
    Specified by:
    
    addNamespace in interface Element
    
    Parameters:
    prefix - is the prefix to use, which should not be null or blank
    uri - is the namespace URI
    
    Returns:
    this Element instance.
  - addProcessingInstruction
```
public Element addProcessingInstruction(String target,
                               String text)
```
    Description copied from interface: Element
    
    Adds a processing instruction for the given target
    
    Specified by:
    
    addProcessingInstruction in interface Element
    
    Parameters:
    target - is the target of the processing instruction
    text - is the textual data (key/value pairs) of the processing instruction
    
    Returns:
    this Element instance.
  - addProcessingInstruction
```
public Element addProcessingInstruction(String target,
                               Map data)
```
    Description copied from interface: Element
    
    Adds a processing instruction for the given target
    
    Specified by:
    
    addProcessingInstruction in interface Element
    
    Parameters:
    target - is the target of the processing instruction
    data - is a Map of the key / value pairs of the processing instruction
    
    Returns:
    this Element instance.
  - addText
```
public Element addText(String text)
```
    Description copied from interface: Element
    
    Adds a new Text node with the given text to this element.
    
    Specified by:
    
    addText in interface Element
    
    Parameters:
    text - is the text for the Text node.
    
    Returns:
    this Element instance.
  - add
```
public void add(Attribute attribute)
```
    Description copied from interface: Element
    
    Adds the given Attribute to this element. If the given node already has a parent defined then an IllegalAddException will be thrown. Attributes with null values are silently ignored.
    If the value of the attribute is null then this method call will remove any attributes with the QName of this attribute.
    
    Specified by:
    
    add in interface Element
    
    Parameters:
    attribute - is the attribute to be added
  - add
```
public void add(CDATA cdata)
```
    Description copied from interface: Element
    
    Adds the given CDATA to this element. If the given node already has a parent defined then an IllegalAddException will be thrown.
    
    Specified by:
    
    add in interface Element
    
    Parameters:
    cdata - is the CDATA to be added
  - add
```
public void add(Entity entity)
```
    Description copied from interface: Element
    
    Adds the given Entity to this element. If the given node already has a parent defined then an IllegalAddException will be thrown.
    
    Specified by:
    
    add in interface Element
    
    Parameters:
    entity - is the entity to be added
  - add
```
public void add(Text text)
```
    Description copied from interface: Element
    
    Adds the given Text to this element. If the given node already has a parent defined then an IllegalAddException will be thrown.
    
    Specified by:
    
    add in interface Element
    
    Parameters:
    text - is the text to be added
  - add
```
public void add(Namespace namespace)
```
    Description copied from interface: Element
    
    Adds the given Namespace to this element. If the given node already has a parent defined then an IllegalAddException will be thrown.
    
    Specified by:
    
    add in interface Element
    
    Parameters:
    namespace - is the namespace to be added
  - remove
```
public boolean remove(Attribute attribute)
```
    Description copied from interface: Element
    
    Removes the given Attribute from this element.
    
    Specified by:
    
    remove in interface Element
    
    Parameters:
    attribute - is the attribute to be removed
    
    Returns:
    true if the attribute was removed
  - remove
```
public boolean remove(CDATA cdata)
```
    Description copied from interface: Element
    
    Removes the given CDATA if the node is an immediate child of this element. If the given node is not an immediate child of this element then the Node.detach()method should be used instead.
    
    Specified by:
    
    remove in interface Element
    
    Parameters:
    cdata - is the CDATA to be removed
    
    Returns:
    true if the cdata was removed
  - remove
```
public boolean remove(Entity entity)
```
    Description copied from interface: Element
    
    Removes the given Entity if the node is an immediate child of this element. If the given node is not an immediate child of this element then the Node.detach()method should be used instead.
    
    Specified by:
    
    remove in interface Element
    
    Parameters:
    entity - is the entity to be removed
    
    Returns:
    true if the entity was removed
  - remove
```
public boolean remove(Namespace namespace)
```
    Description copied from interface: Element
    
    Removes the given Namespace if the node is an immediate child of this element. If the given node is not an immediate child of this element then the Node.detach()method should be used instead.
    
    Specified by:
    
    remove in interface Element
    
    Parameters:
    namespace - is the namespace to be removed
    
    Returns:
    true if the namespace was removed
  - remove
```
public boolean remove(Text text)
```
    Description copied from interface: Element
    
    Removes the given Text if the node is an immediate child of this element. If the given node is not an immediate child of this element then the Node.detach()method should be used instead.
    
    Specified by:
    
    remove in interface Element
    
    Parameters:
    text - is the text to be removed
    
    Returns:
    true if the text was removed
  - supportsParent
```
public boolean supportsParent()
```
    Description copied from interface: Node
    
    supportsParent returns true if this node supports the parent relationship.
    
    Some XML tree implementations are singly linked and only support downward navigation through children relationships. The default case is that both parent and children relationships are supported though for memory and performance reasons the parent relationship may not be supported.
    
    Specified by:
    
    supportsParent in interface Node
    
    Returns:
    true if this node supports the parent relationship or false it is not supported
  - getParent
```
public Element getParent()
```
    Description copied from interface: Node
    
    getParent returns the parent Element if this node supports the parent relationship or null if it is the root element or does not support the parent relationship.
    
    This method is an optional feature and may not be supported for all Node implementations.
    
    Specified by:
    
    getParent in interface Node
    
    Returns:
    the parent of this node or null if it is the root of the tree or the parent relationship is not supported.
  - setParent
```
public void setParent(Element element)
```
    Description copied from interface: Node
    
    setParent sets the parent relationship of this node if the parent relationship is supported or does nothing if the parent relationship is not supported.
    
    This method should only be called from inside an Element implementation method and is not intended for general use.
    
    Specified by:
    
    setParent in interface Node
    
    Parameters:
    element - is the new parent of this node.
  - getDocument
```
public Document getDocument()
```
    Description copied from interface: 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.
    
    Specified by:
    
    getDocument in interface Node
    
    Returns:
    the document of this node or null if this feature is not supported or the node is not associated with a Document
  - setDocument
```
public void setDocument(Document document)
```
    Description copied from interface: Node
    
    setDocument sets the document of this node if the parent relationship is supported or does nothing if the parent relationship is not supported.
    
    This method should only be called from inside a Document implementation method and is not intended for general use.
    
    Specified by:
    
    setDocument in interface Node
    
    Parameters:
    document - is the new document of this node.
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: Node
    
    isReadOnly returns true if this node is read only and cannot be modified. Any attempt to modify a read-only Node will result in an UnsupportedOperationException being thrown.
    
    Specified by:
    
    isReadOnly in interface Node
    
    Returns:
    true if this Node is read only and cannot be modified otherwise false.
  - hasContent
```
public boolean hasContent()
```
    Description copied from interface: Node
    
    hasContent returns true if this node is a Branch (either an Element or a Document) and it contains at least one content node such as a child Element or Text node.
    
    Specified by:
    
    hasContent in interface Node
    
    Returns:
    true if this Node is a Branch with a nodeCount() of one or more.
  - getName
```
public String getName()
```
    Description copied from interface: Node
    
    getName returns the name of this node. This is the XML local name of the element, attribute, entity or processing instruction. For CDATA and Text nodes this method will return null.
    
    Specified by:
    
    getName in interface Node
    
    Returns:
    the XML name of this node
  - setName
```
public void setName(String name)
```
    Description copied from interface: Node
    
    Sets the text data of this node or this method will throw an UnsupportedOperationException if it is read-only.
    
    Specified by:
    
    setName in interface Node
    
    Parameters:
    name - is the new name of this node
  - getText
```
public String getText()
```
    Description copied from interface: Element
    
    Returns the text value of this element without recursing through child elements. This method iterates through all Text,CDATA and Entitynodes that this element contains and appends the text values together.
    
    Specified by:
    
    getText in interface Element
    
    Specified by:
    
    getText in interface Node
    
    Returns:
    the textual content of this Element. Child elements are not navigated. This method does not return null;
  - setText
```
public void setText(String text)
```
    Description copied from interface: Node
    
    Sets the text data of this node or this method will throw an UnsupportedOperationException if it is read-only.
    
    Specified by:
    
    setText in interface Node
    
    Parameters:
    text - is the new textual value of this node
  - getTextTrim
```
public String getTextTrim()
```
    Description copied from interface: Element
    
    DOCUMENT ME!
    
    Specified by:
    
    getTextTrim in interface Element
    
    Returns:
    the trimmed text value where whitespace is trimmed and normalised into single spaces. This method does not return null.
  - getStringValue
```
public String getStringValue()
```
    Description copied from interface: Element
    
    Returns the XPath string-value of this node. The behaviour of this method is defined in the XPath specification . This method returns the string-value of all the contained Text,CDATA,Entityand Element nodes all appended together.
    
    Specified by:
    
    getStringValue in interface Element
    
    Specified by:
    
    getStringValue in interface Node
    
    Returns:
    the text from all the child Text and Element nodes appended together.
  - getPath
```
public String getPath()
```
    Description copied from interface: Node
    
    Returns the 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 interface Node
    
    Returns:
    the XPath expression which will return a nodeset containing at least this node.
  - getPath
```
public String getPath(Element element)
```
    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 interface Node
    
    Parameters:
    element - 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
```
public String getUniquePath()
```
    Description copied from interface: Node
    
    Returns the XPath expression 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 interface Node
    
    Returns:
    the XPath expression which will return a nodeset containing just this node.
  - getUniquePath
```
public String getUniquePath(Element element)
```
    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 interface Node
    
    Parameters:
    element - 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.
  - asXML
```
public String asXML()
```
    Description copied from interface: Node
    
    asXML returns the textual XML representation of this node.
    
    Specified by:
    
    asXML in interface Node
    
    Returns:
    the XML representation of this node
  - write
```
public void write(Writer writer)
           throws IOException
```
    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 use XMLWriter or its derivations.
    
    Specified by:
    
    write in interface Node
    
    Parameters:
    writer - is the Writer to output the XML to
    
    Throws:
    
    IOException - DOCUMENT ME!
  - 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 interface Node
    
    Returns:
    a W3C DOM complient code for the node type such as ELEMENT_NODE or ATTRIBUTE_NODE
  - getNodeTypeName
```
public String getNodeTypeName()
```
    Description copied from interface: Node
    
    DOCUMENT ME!
    
    Specified by:
    
    getNodeTypeName in interface Node
    
    Returns:
    the name of the type of node such as "Document", "Element", "Attribute" or "Text"
  - detach
```
public Node detach()
```
    Description copied from interface: Node
    
    Removes this node from its parent if there is one. If this node is the root element of a document then it is removed from the document as well.
    
    This method is useful if you want to remove a node from its source document and add it to another document. For example
    Node node = ...; Element someOtherElement = ...; someOtherElement.add( node.detach() );
    
    Specified by:
    
    detach in interface Node
    
    Returns:
    the node that has been removed from its parent node if any and its document if any.
  - selectNodes
```
public List selectNodes(String xpath)
```
    Description copied from interface: Node
    
    selectNodes evaluates an XPath expression and returns the result as a List of Node instances or String instances depending on the XPath expression.
    
    Specified by:
    
    selectNodes in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    
    Returns:
    the list of Node or String instances depending on the XPath expression
  - selectObject
```
public Object selectObject(String xpath)
```
    Description copied from interface: Node
    
    selectObject evaluates an XPath expression and returns the result as an Object. The object returned can either be a List of one or more Nodeinstances or a scalar object like a Stringor a Numberinstance depending on the XPath expression.
    
    Specified by:
    
    selectObject in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    
    Returns:
    the value of the XPath expression as a Listof Node instances, a Stringor a Numberinstance depending on the XPath expression.
  - selectNodes
```
public List selectNodes(String xpath,
               String comparison)
```
    Description copied from interface: Node
    
    selectNodes evaluates an XPath expression then sorts the results using a secondary XPath expression Returns a sorted List of Node instances.
    
    Specified by:
    
    selectNodes in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    comparison - is the XPath expression used to compare the results by for sorting
    
    Returns:
    the list of Node instances sorted by the comparisonXPathExpression
  - selectNodes
```
public List selectNodes(String xpath,
               String comparison,
               boolean removeDups)
```
    Description copied from interface: Node
    
    selectNodes evaluates an XPath expression then sorts the results using a secondary XPath expression Returns a sorted List of Node instances.
    
    Specified by:
    
    selectNodes in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    comparison - is the XPath expression used to compare the results by for sorting
    removeDups - if this parameter is true then duplicate values (using the comparisonXPathExpression) are removed from the result List.
    
    Returns:
    the list of Node instances sorted by the comparisonXPathExpression
  - selectSingleNode
```
public Node selectSingleNode(String xpath)
```
    Description copied from interface: Node
    
    selectSingleNode evaluates an XPath expression and returns the result as a single Node instance.
    
    Specified by:
    
    selectSingleNode in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    
    Returns:
    the Node matching the XPath expression
  - valueOf
```
public String valueOf(String xpath)
```
    Description copied from interface: Node
    
    valueOf evaluates an XPath expression and returns the textual representation of the results the XPath string-value of this node. The string-value for a given node type is defined in the XPath specification .
    
    Specified by:
    
    valueOf in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    
    Returns:
    the string-value representation of the results of the XPath expression
  - numberValueOf
```
public Number numberValueOf(String xpath)
```
    Description copied from interface: Node
    
    numberValueOf evaluates an XPath expression and returns the numeric value of the XPath expression if the XPath expression results in a number, or null if the result is not a number.
    
    Specified by:
    
    numberValueOf in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    
    Returns:
    the numeric result of the XPath expression or null if the result is not a number.
  - matches
```
public boolean matches(String xpath)
```
    Description copied from interface: Node
    
    matches returns true if evaluating the given XPath expression on this node returns a non-empty node set containing this node.
    
    This method does not behave like the <xsl:if> element - if you want that behaviour, to evaluate if an XPath expression matches something, then you can use the following code to be equivalent...
    if ( node.selectSingleNode( "/some/path" ) != nulll )
    
    Specified by:
    
    matches in interface Node
    
    Parameters:
    xpath - is an XPath expression
    
    Returns:
    true if this node is returned by the given XPath expression
  - createXPath
```
public XPath createXPath(String xpath)
                  throws InvalidXPathException
```
    Description copied from interface: Node
    
    createXPath creates an XPath object for the given xpathExpression. The XPath object allows the variable context to be specified.
    
    Specified by:
    
    createXPath in interface Node
    
    Parameters:
    xpath - is the XPath expression to be evaluated
    
    Returns:
    an XPath object represeting the given expression
    
    Throws:
    
    InvalidXPathException - if the XPath expression is invalid
  - asXPathResult
```
public Node asXPathResult(Element element)
```
    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 interface Node
    
    Parameters:
    element - DOCUMENT ME!
    
    Returns:
    a Node which supports the parent relationship
  - accept
```
public void accept(Visitor visitor)
```
    Description copied from interface: Node
    
    accept is the method used in the Visitor Pattern.
    
    Specified by:
    
    accept in interface Node
    
    Parameters:
    visitor - is the visitor in the Visitor Pattern
  - clone
```
public Object clone()
```
    Description copied from interface: Node
    
    clone will return a deep clone or if this node is read-only then clone will return the same instance.
    
    Specified by:
    
    clone in interface Node
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a deep clone of myself or myself if I am read only.
  - getData
```
public Object getData()
```
    Description copied from interface: Element
    
    Accesses the data of this element which may implement data typing bindings such as XML Schema or Java Bean bindings or will return the same value as Element.getText()
    
    Specified by:
    
    getData in interface Element
    
    Returns:
    DOCUMENT ME!
  - setData
```
public void setData(Object data)
```
    Description copied from interface: Element
    
    Sets the data value of this element if this element supports data binding or calls Node.setText(java.lang.String)if it doesn't
    
    Specified by:
    
    setData in interface Element
    
    Parameters:
    data - DOCUMENT ME!
  - attributes
```
public List attributes()
```
    Description copied from interface: Element
    
    Returns the Attributeinstances this element contains as a backed Listso that the attributes may be modified directly using the Listinterface. The List is backed by the Element so that changes to the list are reflected in the element and vice versa.
    
    Specified by:
    
    attributes in interface Element
    
    Returns:
    the attributes that this element contains as a List
  - setAttributes
```
public void setAttributes(List list)
```
    Description copied from interface: Element
    
    Sets the attributes that this element contains
    
    Specified by:
    
    setAttributes in interface Element
    
    Parameters:
    list - DOCUMENT ME!
  - attributeCount
```
public int attributeCount()
```
    Description copied from interface: Element
    
    DOCUMENT ME!
    
    Specified by:
    
    attributeCount in interface Element
    
    Returns:
    the number of attributes this element contains
  - attributeIterator
```
public Iterator attributeIterator()
```
    Description copied from interface: Element
    
    DOCUMENT ME!
    
    Specified by:
    
    attributeIterator in interface Element
    
    Returns:
    an iterator over the attributes of this element
  - attribute
```
public Attribute attribute(int i)
```
    Description copied from interface: Element
    
    Returns the attribute at the specified indexGets the
    
    Specified by:
    
    attribute in interface Element
    
    Parameters:
    i - DOCUMENT ME!
    
    Returns:
    the attribute at the specified index where index >= 0 and index < number of attributes or throws an IndexOutOfBoundsException if the index is not within the allowable range
  - attribute
```
public Attribute attribute(String name)
```
    Description copied from interface: Element
    
    Returns the attribute with the given name
    
    Specified by:
    
    attribute in interface Element
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    the attribute for the given local name in any namespace. If there are more than one attributes with the given local name in different namespaces then the first one is returned.
  - attribute
```
public Attribute attribute(QName qName)
```
    Description copied from interface: Element
    
    DOCUMENT ME!
    
    Specified by:
    
    attribute in interface Element
    
    Parameters:
    qName - is the fully qualified name
    
    Returns:
    the attribute for the given fully qualified name or null if it could not be found.
  - attributeValue
```
public String attributeValue(String name)
```
    Description copied from interface: Element
    
    This returns the attribute value for the attribute with the given name and any namespace or null if there is no such attribute or the empty string if the attribute value is empty.
    
    Specified by:
    
    attributeValue in interface Element
    
    Parameters:
    name - is the name of the attribute value to be returnd
    
    Returns:
    the value of the attribute, null if the attribute does not exist or the empty string
  - attributeValue
```
public String attributeValue(String name,
                    String defaultValue)
```
    Description copied from interface: Element
    
    This returns the attribute value for the attribute with the given name and any namespace or the default value if there is no such attribute value.
    
    Specified by:
    
    attributeValue in interface Element
    
    Parameters:
    name - is the name of the attribute value to be returnd
    defaultValue - is the default value to be returned if the attribute has no value defined.
    
    Returns:
    the value of the attribute or the defaultValue if the attribute has no value defined.
  - attributeValue
```
public String attributeValue(QName qName)
```
    Description copied from interface: Element
    
    This returns the attribute value for the attribute with the given fully qualified name or null if there is no such attribute or the empty string if the attribute value is empty.
    
    Specified by:
    
    attributeValue in interface Element
    
    Parameters:
    qName - is the fully qualified name
    
    Returns:
    the value of the attribute, null if the attribute does not exist or the empty string
  - attributeValue
```
public String attributeValue(QName qName,
                    String defaultValue)
```
    Description copied from interface: Element
    
    This returns the attribute value for the attribute with the given fully qualified name or the default value if there is no such attribute value.
    
    Specified by:
    
    attributeValue in interface Element
    
    Parameters:
    qName - is the fully qualified name
    defaultValue - is the default value to be returned if the attribute has no value defined.
    
    Returns:
    the value of the attribute or the defaultValue if the attribute has no value defined.
  - setAttributeValue
```
public void setAttributeValue(String name,
                     String value)
```
    Deprecated.
    
    Description copied from interface: Element
    
    Sets the attribute value of the given local name.
    
    Specified by:
    
    setAttributeValue in interface Element
    
    Parameters:
    name - is the name of the attribute whose value is to be added or updated
    value - is the attribute's value
  - setAttributeValue
```
public void setAttributeValue(QName qName,
                     String value)
```
    Deprecated.
    
    Description copied from interface: Element
    
    Sets the attribute value of the given fully qualified name.
    
    Specified by:
    
    setAttributeValue in interface Element
    
    Parameters:
    qName - is the fully qualified name of the attribute whose value is to be added or updated
    value - is the attribute's value
  - element
```
public Element element(String name)
```
    Description copied from interface: Element
    
    Returns the first element for the given local name and any namespace.
    
    Specified by:
    
    element in interface Element
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    the first element with the given local name
  - element
```
public Element element(QName qName)
```
    Description copied from interface: Element
    
    Returns the first element for the given fully qualified name.
    
    Specified by:
    
    element in interface Element
    
    Parameters:
    qName - is the fully qualified name to search for
    
    Returns:
    the first element with the given fully qualified name
  - elements
```
public List elements()
```
    Description copied from interface: Element
    
    Returns the elements contained in this element. If this element does not contain any elements then this method returns an empty list. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
    
    Specified by:
    
    elements in interface Element
    
    Returns:
    a list of all the elements in this element.
  - elements
```
public List elements(String name)
```
    Description copied from interface: Element
    
    Returns the elements contained in this element with the given local name and any namespace. If no elements are found then this method returns an empty list. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
    
    Specified by:
    
    elements in interface Element
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    a list of all the elements in this element for the given local name
  - elements
```
public List elements(QName qName)
```
    Description copied from interface: Element
    
    Returns the elements contained in this element with the given fully qualified name. If no elements are found then this method returns an empty list. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
    
    Specified by:
    
    elements in interface Element
    
    Parameters:
    qName - is the fully qualified name to search for
    
    Returns:
    a list of all the elements in this element for the given fully qualified name.
  - elementIterator
```
public Iterator elementIterator()
```
    Description copied from interface: Element
    
    Returns an iterator over all this elements child elements.
    
    Specified by:
    
    elementIterator in interface Element
    
    Returns:
    an iterator over the contained elements
  - elementIterator
```
public Iterator elementIterator(String name)
```
    Description copied from interface: Element
    
    Returns an iterator over the elements contained in this element which match the given local name and any namespace.
    
    Specified by:
    
    elementIterator in interface Element
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    an iterator over the contained elements matching the given local name
  - elementIterator
```
public Iterator elementIterator(QName qName)
```
    Description copied from interface: Element
    
    Returns an iterator over the elements contained in this element which match the given fully qualified name.
    
    Specified by:
    
    elementIterator in interface Element
    
    Parameters:
    qName - is the fully qualified name to search for
    
    Returns:
    an iterator over the contained elements matching the given fully qualified name
  - isRootElement
```
public boolean isRootElement()
```
    Description copied from interface: Element
    
    DOCUMENT ME!
    
    Specified by:
    
    isRootElement in interface Element
    
    Returns:
    true if this element is the root element of a document and this element supports the parent relationship else false.
  - hasMixedContent
```
public boolean hasMixedContent()
```
    Description copied from interface: Element
    
    Returns true if this Element has mixed content. Mixed content means that an element contains both textual data and child elements.
    
    Specified by:
    
    hasMixedContent in interface Element
    
    Returns:
    true if this element contains mixed content.
  - isTextOnly
```
public boolean isTextOnly()
```
    Description copied from interface: Element
    
    Returns true if this Element has text only content.
    
    Specified by:
    
    isTextOnly in interface Element
    
    Returns:
    true if this element is empty or only contains text content.
  - appendAttributes
```
public void appendAttributes(Element element)
```
    Description copied from interface: Element
    
    Appends the attributes of the given element to me. This method behaves like the Collection.addAll(java.util.Collection) method.
    
    Specified by:
    
    appendAttributes in interface Element
    
    Parameters:
    element - is the element whose attributes will be added to me.
  - createCopy
```
public Element createCopy()
```
    Description copied from interface: Element
    
    Creates a deep copy of this element The new element is detached from its parent, and getParent() on the clone will return null.
    
    Specified by:
    
    createCopy in interface Element
    
    Returns:
    a new deep copy Element
  - createCopy
```
public Element createCopy(String name)
```
    Description copied from interface: Element
    
    Creates a deep copy of this element with the given local name The new element is detached from its parent, and getParent() on the clone will return null.
    
    Specified by:
    
    createCopy in interface Element
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    a new deep copy Element
  - createCopy
```
public Element createCopy(QName qName)
```
    Description copied from interface: Element
    
    Creates a deep copy of this element with the given fully qualified name. The new element is detached from its parent, and getParent() on the clone will return null.
    
    Specified by:
    
    createCopy in interface Element
    
    Parameters:
    qName - DOCUMENT ME!
    
    Returns:
    a new deep copy Element
  - elementText
```
public String elementText(String name)
```
    Specified by:
    
    elementText in interface Element
  - elementText
```
public String elementText(QName qName)
```
    Specified by:
    
    elementText in interface Element
  - elementTextTrim
```
public String elementTextTrim(String name)
```
    Specified by:
    
    elementTextTrim in interface Element
  - elementTextTrim
```
public String elementTextTrim(QName qName)
```
    Specified by:
    
    elementTextTrim in interface Element
  - getXPathResult
```
public Node getXPathResult(int i)
```
    Description copied from interface: Element
    
    Returns a node at the given index suitable for an XPath result set. This means the resulting Node will either be null or it will support the parent relationship.
    
    Specified by:
    
    getXPathResult in interface Element
    
    Parameters:
    i - DOCUMENT ME!
    
    Returns:
    the Node for the given index which will support the parent relationship or null if there is not a node at the given index.
  - node
```
public Node node(int i)
```
    Description copied from interface: Branch
    
    Returns the Node at the specified index position.
    
    Specified by:
    
    node in interface Branch
    
    Parameters:
    i - the index of the node to return.
    
    Returns:
    the Node at the specified position.
  - indexOf
```
public int indexOf(Node node)
```
    Description copied from interface: Branch
    
    Returns the index of the given node if it is a child node of this branch or -1 if the given node is not a child node.
    
    Specified by:
    
    indexOf in interface Branch
    
    Parameters:
    node - the content child node to find.
    
    Returns:
    the index of the given node starting at 0 or -1 if the node is not a child node of this branch
  - nodeCount
```
public int nodeCount()
```
    Description copied from interface: Branch
    
    Returns the number of Node instances that this branch contains.
    
    Specified by:
    
    nodeCount in interface Branch
    
    Returns:
    the number of nodes this branch contains
  - elementByID
```
public Element elementByID(String id)
```
    Description copied from interface: Branch
    
    Returns the element of the given ID attribute value. If this tree is capable of understanding which attribute value should be used for the ID then it should be used, otherwise this method should return null.
    
    Specified by:
    
    elementByID in interface Branch
    
    Parameters:
    id - DOCUMENT ME!
    
    Returns:
    DOCUMENT ME!
  - content
```
public List content()
```
    Description copied from interface: Branch
    
    Returns the content nodes of this branch as a backed Listso that the content of this branch may be modified directly using the Listinterface. The List is backed by the Branch so that changes to the list are reflected in the branch and vice versa.
    
    Specified by:
    
    content in interface Branch
    
    Returns:
    the nodes that this branch contains as a List
  - nodeIterator
```
public Iterator nodeIterator()
```
    Description copied from interface: Branch
    
    Returns an iterator through the content nodes of this branch
    
    Specified by:
    
    nodeIterator in interface Branch
    
    Returns:
    an iterator through the content nodes of this branch
  - setContent
```
public void setContent(List list)
```
    Description copied from interface: Branch
    
    Sets the contents of this branch as a List of Node instances.
    
    Specified by:
    
    setContent in interface Branch
    
    Parameters:
    list - is the list of nodes to use as the content for this branch.
  - appendContent
```
public void appendContent(Branch branch)
```
    Description copied from interface: Branch
    
    Appends the content of the given branch to this branch instance. This method behaves like the Collection.addAll(java.util.Collection) method.
    
    Specified by:
    
    appendContent in interface Branch
    
    Parameters:
    branch - is the branch whose content will be added to me.
  - clearContent
```
public void clearContent()
```
    Description copied from interface: Branch
    
    Clears the content for this branch, removing any Node instances this branch may contain.
    
    Specified by:
    
    clearContent in interface Branch
  - processingInstructions
```
public List processingInstructions()
```
    Description copied from interface: Branch
    
    Returns a list of all the processing instructions in this branch. The list is backed by this branch so that changes to the list will be reflected in the branch but the reverse is not the case.
    
    Specified by:
    
    processingInstructions in interface Branch
    
    Returns:
    a backed list of the processing instructions
  - processingInstructions
```
public List processingInstructions(String name)
```
    Description copied from interface: Branch
    
    Returns a list of the processing instructions for the given target. The list is backed by this branch so that changes to the list will be reflected in the branch but the reverse is not the case.
    
    Specified by:
    
    processingInstructions in interface Branch
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    a backed list of the processing instructions
  - processingInstruction
```
public ProcessingInstruction processingInstruction(String name)
```
    Description copied from interface: Branch
    
    DOCUMENT ME!
    
    Specified by:
    
    processingInstruction in interface Branch
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    the processing instruction for the given target
  - setProcessingInstructions
```
public void setProcessingInstructions(List list)
```
    Description copied from interface: Branch
    
    Sets all the processing instructions for this branch
    
    Specified by:
    
    setProcessingInstructions in interface Branch
    
    Parameters:
    list - DOCUMENT ME!
  - addElement
```
public Element addElement(String name)
```
    Description copied from interface: Branch
    
    Adds a new Element node with the given name to this branch and returns a reference to the new node.
    
    Specified by:
    
    addElement in interface Branch
    
    Parameters:
    name - is the name for the Element node.
    
    Returns:
    the newly added Element node.
  - addElement
```
public Element addElement(QName qName)
```
    Description copied from interface: Branch
    
    Adds a new Element node with the given QNameto this branch and returns a reference to the new node.
    
    Specified by:
    
    addElement in interface Branch
    
    Parameters:
    qName - is the qualified name for the Element node.
    
    Returns:
    the newly added Element node.
  - addElement
```
public Element addElement(String name,
                 String text)
```
    Description copied from interface: Branch
    
    Adds a new Element node with the given qualified name and namespace URI to this branch and returns a reference to the new node.
    
    Specified by:
    
    addElement in interface Branch
    
    Parameters:
    name - is the fully qualified name of the Element
    text - is the URI of the namespace to use
    
    Returns:
    the newly added Element node.
  - removeProcessingInstruction
```
public boolean removeProcessingInstruction(String name)
```
    Description copied from interface: Branch
    
    Removes the processing instruction for the given target if it exists
    
    Specified by:
    
    removeProcessingInstruction in interface Branch
    
    Parameters:
    name - DOCUMENT ME!
    
    Returns:
    true if a processing instruction was removed else false
  - add
```
public void add(Node node)
```
    Description copied from interface: Branch
    
    Adds the given Node or throws IllegalAddException if the given node is not of a valid type. This is a polymorphic method which will call the typesafe method for the node type such as add(Element) or add(Comment).
    
    Specified by:
    
    add in interface Branch
    
    Parameters:
    node - is the given node to add
  - add
```
public void add(Comment comment)
```
    Description copied from interface: Branch
    
    Adds the given Comment to this branch. If the given node already has a parent defined then an IllegalAddException will be thrown.
    
    Specified by:
    
    add in interface Branch
    
    Parameters:
    comment - is the comment to be added
  - add
```
public void add(Element element)
```
    Description copied from interface: Branch
    
    Adds the given Element to this branch. If the given node already has a parent defined then an IllegalAddException will be thrown.
    
    Specified by:
    
    add in interface Branch
    
    Parameters:
    element - is the element to be added
  - add
```
public void add(ProcessingInstruction processingInstruction)
```
    Description copied from interface: Branch
    
    Adds the given ProcessingInstruction to this branch. If the given node already has a parent defined then an IllegalAddException will be thrown.
    
    Specified by:
    
    add in interface Branch
    
    Parameters:
    processingInstruction - is the processing instruction to be added
  - remove
```
public boolean remove(Node node)
```
    Description copied from interface: Branch
    
    Removes the given Node 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. This is a polymorphic method which will call the typesafe method for the node type such as remove(Element) or remove(Comment).
    
    Specified by:
    
    remove in interface Branch
    
    Parameters:
    node - is the given node to be removed
    
    Returns:
    true if the node was removed
  - remove
```
public boolean remove(Comment comment)
```
    Description copied from interface: Branch
    
    Removes the given Comment 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.
    
    Specified by:
    
    remove in interface Branch
    
    Parameters:
    comment - is the comment to be removed
    
    Returns:
    true if the comment was removed
  - remove
```
public boolean remove(Element element)
```
    Description copied from interface: Branch
    
    Removes the given Element 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.
    
    Specified by:
    
    remove in interface Branch
    
    Parameters:
    element - is the element to be removed
    
    Returns:
    true if the element was removed
  - remove
```
public boolean remove(ProcessingInstruction processingInstruction)
```
    Description copied from interface: Branch
    
    Removes the given ProcessingInstruction 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.
    
    Specified by:
    
    remove in interface Branch
    
    Parameters:
    processingInstruction - is the processing instruction to be removed
    
    Returns:
    true if the processing instruction was removed
  - normalize
```
public void normalize()
```
    Description copied from interface: Branch
    
    Puts all Text 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.
    
    Specified by:
    
    normalize in interface Branch

Class Dom4jProxy

Field Summary

Fields inherited from interface org.dom4j.Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Dom4jProxy

Method Detail

writeReplace

getHibernateLazyInitializer

getQName

getQName

setQName

getNamespace

getNamespaceForPrefix

getNamespaceForURI

getNamespacesForURI

getNamespacePrefix

getNamespaceURI

getQualifiedName

additionalNamespaces

declaredNamespaces

addAttribute

addAttribute

addComment

addCDATA

addEntity

addNamespace

addProcessingInstruction

addProcessingInstruction

addText

add

add

add

add

add

remove

remove

remove

remove

remove

supportsParent

getParent

setParent

getDocument

setDocument

isReadOnly

hasContent

getName

setName

getText

setText

getTextTrim

getStringValue

getPath

getPath

getUniquePath

getUniquePath

asXML

write

getNodeType

getNodeTypeName

detach

selectNodes

selectObject

selectNodes

selectNodes

selectSingleNode

valueOf

numberValueOf

matches

createXPath

asXPathResult

accept

clone

getData

setData

attributes

setAttributes