Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.hibernate.proxy.dom4j
Class Dom4jProxy  view Dom4jProxy download Dom4jProxy.java

java.lang.Object
  extended byorg.hibernate.proxy.dom4j.Dom4jProxy
All Implemented Interfaces:
org.dom4j.Branch, java.lang.Cloneable, org.dom4j.Element, org.hibernate.proxy.HibernateProxy, org.dom4j.Node, java.io.Serializable

public class Dom4jProxy
extends java.lang.Object
implements org.hibernate.proxy.HibernateProxy, org.dom4j.Element, java.io.Serializable

Proxy for "dom4j" entity representations.


Field Summary
private  Dom4jLazyInitializer li
           
 
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
Dom4jProxy(Dom4jLazyInitializer li)
           
 
Method Summary
 void accept(org.dom4j.Visitor visitor)
           accept is the method used in the Visitor Pattern.
 void add(org.dom4j.Attribute attribute)
          Adds the given Attribute to this element.
 void add(org.dom4j.CDATA cdata)
          Adds the given CDATA to this element.
 void add(org.dom4j.Comment comment)
          Adds the given Comment to this branch.
 void add(org.dom4j.Element element)
          Adds the given Element to this branch.
 void add(org.dom4j.Entity entity)
          Adds the given Entity to this element.
 void add(org.dom4j.Namespace namespace)
          Adds the given Namespace to this element.
 void add(org.dom4j.Node node)
          Adds the given Node or throws IllegalAddException if the given node is not of a valid type.
 void add(org.dom4j.ProcessingInstruction processingInstruction)
          Adds the given ProcessingInstruction to this branch.
 void add(org.dom4j.Text text)
          Adds the given Text to this element.
 org.dom4j.Element addAttribute(org.dom4j.QName attrName, java.lang.String text)
           Adds the attribute value of the given fully qualified name.
 org.dom4j.Element addAttribute(java.lang.String attrName, java.lang.String text)
           Adds the attribute value of the given local name.
 org.dom4j.Element addCDATA(java.lang.String text)
          Adds a new CDATA node with the given text to this element.
 org.dom4j.Element addComment(java.lang.String text)
          Adds a new Comment node with the given text to this element.
 org.dom4j.Element addElement(org.dom4j.QName qName)
          Adds a new Element node with the given org.dom4j.QNameto this branch and returns a reference to the new node.
 org.dom4j.Element addElement(java.lang.String name)
          Adds a new Element node with the given name to this branch and returns a reference to the new node.
 org.dom4j.Element addElement(java.lang.String name, java.lang.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.
 org.dom4j.Element addEntity(java.lang.String name, java.lang.String text)
          Adds a new Entity node with the given name and text to this element and returns a reference to the new node.
 java.util.List additionalNamespaces()
           Returns any additional namespaces declarations for this element other than namespace returned via the getNamespace() 55 method.
 org.dom4j.Element addNamespace(java.lang.String prefix, java.lang.String uri)
          Adds a namespace to this element for use by its child content
 org.dom4j.Element addProcessingInstruction(java.lang.String target, java.util.Map data)
          Adds a processing instruction for the given target
 org.dom4j.Element addProcessingInstruction(java.lang.String target, java.lang.String text)
          Adds a processing instruction for the given target
 org.dom4j.Element addText(java.lang.String text)
          Adds a new Text node with the given text to this element.
 void appendAttributes(org.dom4j.Element element)
          Appends the attributes of the given element to me.
 void appendContent(org.dom4j.Branch branch)
          Appends the content of the given branch to this branch instance.
 java.lang.String asXML()
           asXML returns the textual XML representation of this node.
 org.dom4j.Node asXPathResult(org.dom4j.Element element)
           asXPathResult returns a version of this node which is capable of being an XPath result.
 org.dom4j.Attribute attribute(int i)
          Returns the attribute at the specified indexGets the
 org.dom4j.Attribute attribute(org.dom4j.QName qName)
          DOCUMENT ME!
 org.dom4j.Attribute attribute(java.lang.String name)
          Returns the attribute with the given name
 int attributeCount()
          DOCUMENT ME!
 java.util.Iterator attributeIterator()
          DOCUMENT ME!
 java.util.List attributes()
           Returns the org.dom4j.Attributeinstances this element contains as a backed java.util.Listso that the attributes may be modified directly using the java.util.Listinterface.
 java.lang.String attributeValue(org.dom4j.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.
 java.lang.String attributeValue(org.dom4j.QName qName, java.lang.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.
 java.lang.String attributeValue(java.lang.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.
 java.lang.String attributeValue(java.lang.String name, java.lang.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.
 java.lang.Object clone()
           clone will return a deep clone or if this node is read-only then clone will return the same instance.
 java.util.List content()
           Returns the content nodes of this branch as a backed java.util.Listso that the content of this branch may be modified directly using the java.util.Listinterface.
 org.dom4j.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.
 org.dom4j.Element createCopy(org.dom4j.QName qName)
           Creates a deep copy of this element with the given fully qualified name.
 org.dom4j.Element createCopy(java.lang.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.
 org.dom4j.XPath createXPath(java.lang.String xpath)
           createXPath creates an XPath object for the given xpathExpression.
 java.util.List declaredNamespaces()
           Returns all the namespaces declared by this element.
 org.dom4j.Node detach()
           Removes this node from its parent if there is one.
 org.dom4j.Element element(org.dom4j.QName qName)
          Returns the first element for the given fully qualified name.
 org.dom4j.Element element(java.lang.String name)
          Returns the first element for the given local name and any namespace.
 org.dom4j.Element elementByID(java.lang.String id)
          Returns the element of the given ID attribute value.
 java.util.Iterator elementIterator()
          Returns an iterator over all this elements child elements.
 java.util.Iterator elementIterator(org.dom4j.QName qName)
          Returns an iterator over the elements contained in this element which match the given fully qualified name.
 java.util.Iterator elementIterator(java.lang.String name)
          Returns an iterator over the elements contained in this element which match the given local name and any namespace.
 java.util.List elements()
           Returns the elements contained in this element.
 java.util.List elements(org.dom4j.QName qName)
           Returns the elements contained in this element with the given fully qualified name.
 java.util.List elements(java.lang.String name)
           Returns the elements contained in this element with the given local name and any namespace.
 java.lang.String elementText(org.dom4j.QName qName)
           
 java.lang.String elementText(java.lang.String name)
           
 java.lang.String elementTextTrim(org.dom4j.QName qName)
           
 java.lang.String elementTextTrim(java.lang.String name)
           
 java.lang.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 getText() 55
 org.dom4j.Document getDocument()
           getDocument returns the Document that this Node is part of if this node supports the parent relationship.
 org.hibernate.proxy.LazyInitializer getHibernateLazyInitializer()
          Get the underlying lazy initialization handler.
 java.lang.String getName()
           getName returns the name of this node.
 org.dom4j.Namespace getNamespace()
           Returns the Namespace of this element if one exists otherwise Namespace.NO_NAMESPACE is returned.
 org.dom4j.Namespace getNamespaceForPrefix(java.lang.String s)
           Returns the Namespace which is mapped to the given prefix or null if it could not be found.
 org.dom4j.Namespace getNamespaceForURI(java.lang.String s)
           Returns the Namespace which is mapped to the given URI or null if it could not be found.
 java.lang.String getNamespacePrefix()
           Returns the namespace prefix of this element if one exists otherwise an empty String is returned.
 java.util.List getNamespacesForURI(java.lang.String s)
           Returns the all namespaces which are mapped to the given URI or an empty list if no such namespaces could be found.
 java.lang.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.
 java.lang.String getNodeTypeName()
          DOCUMENT ME!
 org.dom4j.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.
 java.lang.String getPath()
           Returns the XPath expression which will return a node set containing the given node such as /a/b/@c.
 java.lang.String getPath(org.dom4j.Element element)
          Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.
 org.dom4j.QName getQName()
           Returns the QName of this element which represents the local name, the qualified name and the Namespace.
 org.dom4j.QName getQName(java.lang.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.
 java.lang.String getQualifiedName()
           Returns the fully qualified name of this element.
 java.lang.String getStringValue()
          Returns the XPath string-value of this node.
 java.lang.String getText()
          Returns the text value of this element without recursing through child elements.
 java.lang.String getTextTrim()
          DOCUMENT ME!
 java.lang.String getUniquePath()
           Returns the XPath expression which will return a nodeset of one node which is the current node.
 java.lang.String getUniquePath(org.dom4j.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.
 org.dom4j.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(org.dom4j.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(java.lang.String xpath)
           matches returns true if evaluating the given XPath expression on this node returns a non-empty node set containing this node.
 org.dom4j.Node node(int i)
          Returns the Node at the specified index position.
 int nodeCount()
          Returns the number of Node instances that this branch contains.
 java.util.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.
 java.lang.Number numberValueOf(java.lang.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.
 org.dom4j.ProcessingInstruction processingInstruction(java.lang.String name)
          DOCUMENT ME!
 java.util.List processingInstructions()
           Returns a list of all the processing instructions in this branch.
 java.util.List processingInstructions(java.lang.String name)
           Returns a list of the processing instructions for the given target.
 boolean remove(org.dom4j.Attribute attribute)
          Removes the given Attribute from this element.
 boolean remove(org.dom4j.CDATA cdata)
          Removes the given CDATA if the node is an immediate child of this element.
 boolean remove(org.dom4j.Comment comment)
          Removes the given Comment if the node is an immediate child of this branch.
 boolean remove(org.dom4j.Element element)
          Removes the given Element if the node is an immediate child of this branch.
 boolean remove(org.dom4j.Entity entity)
          Removes the given Entity if the node is an immediate child of this element.
 boolean remove(org.dom4j.Namespace namespace)
          Removes the given Namespace if the node is an immediate child of this element.
 boolean remove(org.dom4j.Node node)
          Removes the given Node if the node is an immediate child of this branch.
 boolean remove(org.dom4j.ProcessingInstruction processingInstruction)
          Removes the given ProcessingInstruction if the node is an immediate child of this branch.
 boolean remove(org.dom4j.Text text)
          Removes the given Text if the node is an immediate child of this element.
 boolean removeProcessingInstruction(java.lang.String name)
          Removes the processing instruction for the given target if it exists
 java.util.List selectNodes(java.lang.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.
 java.util.List selectNodes(java.lang.String xpath, java.lang.String comparison)
           selectNodes evaluates an XPath expression then sorts the results using a secondary XPath expression Returns a sorted List of Node instances.
 java.util.List selectNodes(java.lang.String xpath, java.lang.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.
 java.lang.Object selectObject(java.lang.String xpath)
           selectObject evaluates an XPath expression and returns the result as an java.lang.Object.
 org.dom4j.Node selectSingleNode(java.lang.String xpath)
           selectSingleNode evaluates an XPath expression and returns the result as a single Node instance.
 void setAttributes(java.util.List list)
          Sets the attributes that this element contains
 void setAttributeValue(org.dom4j.QName qName, java.lang.String value)
           Sets the attribute value of the given fully qualified name.
 void setAttributeValue(java.lang.String name, java.lang.String value)
           Sets the attribute value of the given local name.
 void setContent(java.util.List list)
          Sets the contents of this branch as a List of Node instances.
 void setData(java.lang.Object data)
          Sets the data value of this element if this element supports data binding or calls setText(java.lang.String) 55 if it doesn't
 void setDocument(org.dom4j.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(java.lang.String name)
           Sets the text data of this node or this method will throw an UnsupportedOperationException if it is read-only.
 void setParent(org.dom4j.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(java.util.List list)
          Sets all the processing instructions for this branch
 void setQName(org.dom4j.QName qName)
           Sets the QName of this element which represents the local name, the qualified name and the Namespace.
 void setText(java.lang.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.
private  org.dom4j.Element target()
           
 java.lang.String valueOf(java.lang.String xpath)
           valueOf evaluates an XPath expression and returns the textual representation of the results the XPath string-value of this node.
 void write(java.io.Writer writer)
           write writes this node as the default XML notation for this node.
 java.lang.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
 

Field Detail

li

private Dom4jLazyInitializer li
Constructor Detail

Dom4jProxy

public Dom4jProxy(Dom4jLazyInitializer li)
Method Detail

writeReplace

public java.lang.Object writeReplace()
Description copied from interface: org.hibernate.proxy.HibernateProxy
Perform serialization-time write-replacement of this proxy.

Specified by:
writeReplace in interface org.hibernate.proxy.HibernateProxy

getHibernateLazyInitializer

public org.hibernate.proxy.LazyInitializer getHibernateLazyInitializer()
Description copied from interface: org.hibernate.proxy.HibernateProxy
Get the underlying lazy initialization handler.

Specified by:
getHibernateLazyInitializer in interface org.hibernate.proxy.HibernateProxy

getQName

public org.dom4j.QName getQName()
Description copied from interface: org.dom4j.Element

Returns the QName of this element which represents the local name, the qualified name and the Namespace.

Specified by:
getQName in interface org.dom4j.Element

getQName

public org.dom4j.QName getQName(java.lang.String s)
Description copied from interface: org.dom4j.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 org.dom4j.Element

setQName

public void setQName(org.dom4j.QName qName)
Description copied from interface: org.dom4j.Element

Sets the QName of this element which represents the local name, the qualified name and the Namespace.

Specified by:
setQName in interface org.dom4j.Element

getNamespace

public org.dom4j.Namespace getNamespace()
Description copied from interface: org.dom4j.Element

Returns the Namespace of this element if one exists otherwise Namespace.NO_NAMESPACE is returned.

Specified by:
getNamespace in interface org.dom4j.Element

getNamespaceForPrefix

public org.dom4j.Namespace getNamespaceForPrefix(java.lang.String s)
Description copied from interface: org.dom4j.Element

Returns the Namespace which is mapped to the given prefix or null if it could not be found.

Specified by:
getNamespaceForPrefix in interface org.dom4j.Element

getNamespaceForURI

public org.dom4j.Namespace getNamespaceForURI(java.lang.String s)
Description copied from interface: org.dom4j.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 org.dom4j.Element

getNamespacesForURI

public java.util.List getNamespacesForURI(java.lang.String s)
Description copied from interface: org.dom4j.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 org.dom4j.Element

getNamespacePrefix

public java.lang.String getNamespacePrefix()
Description copied from interface: org.dom4j.Element

Returns the namespace prefix of this element if one exists otherwise an empty String is returned.

Specified by:
getNamespacePrefix in interface org.dom4j.Element

getNamespaceURI

public java.lang.String getNamespaceURI()
Description copied from interface: org.dom4j.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 org.dom4j.Element

getQualifiedName

public java.lang.String getQualifiedName()
Description copied from interface: org.dom4j.Element

Returns the fully qualified name of this element. This will be the same as the value returned from Node.getName()>Node.getName() 55 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 org.dom4j.Element

additionalNamespaces

public java.util.List additionalNamespaces()
Description copied from interface: org.dom4j.Element

Returns any additional namespaces declarations for this element other than namespace returned via the Element.getNamespace()>Element.getNamespace() 55 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 org.dom4j.Element

declaredNamespaces

public java.util.List declaredNamespaces()
Description copied from interface: org.dom4j.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 org.dom4j.Element

addAttribute

public org.dom4j.Element addAttribute(java.lang.String attrName,
                                      java.lang.String text)
Description copied from interface: org.dom4j.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 org.dom4j.Element

addAttribute

public org.dom4j.Element addAttribute(org.dom4j.QName attrName,
                                      java.lang.String text)
Description copied from interface: org.dom4j.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 org.dom4j.Element

addComment

public org.dom4j.Element addComment(java.lang.String text)
Description copied from interface: org.dom4j.Element
Adds a new Comment node with the given text to this element.

Specified by:
addComment in interface org.dom4j.Element

addCDATA

public org.dom4j.Element addCDATA(java.lang.String text)
Description copied from interface: org.dom4j.Element
Adds a new CDATA node with the given text to this element.

Specified by:
addCDATA in interface org.dom4j.Element

addEntity

public org.dom4j.Element addEntity(java.lang.String name,
                                   java.lang.String text)
Description copied from interface: org.dom4j.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 org.dom4j.Element

addNamespace

public org.dom4j.Element addNamespace(java.lang.String prefix,
                                      java.lang.String uri)
Description copied from interface: org.dom4j.Element
Adds a namespace to this element for use by its child content

Specified by:
addNamespace in interface org.dom4j.Element

addProcessingInstruction

public org.dom4j.Element addProcessingInstruction(java.lang.String target,
                                                  java.lang.String text)
Description copied from interface: org.dom4j.Element
Adds a processing instruction for the given target

Specified by:
addProcessingInstruction in interface org.dom4j.Element

addProcessingInstruction

public org.dom4j.Element addProcessingInstruction(java.lang.String target,
                                                  java.util.Map data)
Description copied from interface: org.dom4j.Element
Adds a processing instruction for the given target

Specified by:
addProcessingInstruction in interface org.dom4j.Element

addText

public org.dom4j.Element addText(java.lang.String text)
Description copied from interface: org.dom4j.Element
Adds a new Text node with the given text to this element.

Specified by:
addText in interface org.dom4j.Element

add

public void add(org.dom4j.Attribute attribute)
Description copied from interface: org.dom4j.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 org.dom4j.Element

add

public void add(org.dom4j.CDATA cdata)
Description copied from interface: org.dom4j.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 org.dom4j.Element

add

public void add(org.dom4j.Entity entity)
Description copied from interface: org.dom4j.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 org.dom4j.Element

add

public void add(org.dom4j.Text text)
Description copied from interface: org.dom4j.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 org.dom4j.Element

add

public void add(org.dom4j.Namespace namespace)
Description copied from interface: org.dom4j.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 org.dom4j.Element

remove

public boolean remove(org.dom4j.Attribute attribute)
Description copied from interface: org.dom4j.Element
Removes the given Attribute from this element.

Specified by:
remove in interface org.dom4j.Element

remove

public boolean remove(org.dom4j.CDATA cdata)
Description copied from interface: org.dom4j.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()>Node.detach() 55 method should be used instead.

Specified by:
remove in interface org.dom4j.Element

remove

public boolean remove(org.dom4j.Entity entity)
Description copied from interface: org.dom4j.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()>Node.detach() 55 method should be used instead.

Specified by:
remove in interface org.dom4j.Element

remove

public boolean remove(org.dom4j.Namespace namespace)
Description copied from interface: org.dom4j.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()>Node.detach() 55 method should be used instead.

Specified by:
remove in interface org.dom4j.Element

remove

public boolean remove(org.dom4j.Text text)
Description copied from interface: org.dom4j.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()>Node.detach() 55 method should be used instead.

Specified by:
remove in interface org.dom4j.Element

supportsParent

public boolean supportsParent()
Description copied from interface: org.dom4j.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 org.dom4j.Node

getParent

public org.dom4j.Element getParent()
Description copied from interface: org.dom4j.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 org.dom4j.Node

setParent

public void setParent(org.dom4j.Element element)
Description copied from interface: org.dom4j.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 org.dom4j.Node

getDocument

public org.dom4j.Document getDocument()
Description copied from interface: org.dom4j.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 org.dom4j.Node

setDocument

public void setDocument(org.dom4j.Document document)
Description copied from interface: org.dom4j.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 org.dom4j.Node

isReadOnly

public boolean isReadOnly()
Description copied from interface: org.dom4j.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 org.dom4j.Node

hasContent

public boolean hasContent()
Description copied from interface: org.dom4j.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 org.dom4j.Node

getName

public java.lang.String getName()
Description copied from interface: org.dom4j.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 org.dom4j.Node

setName

public void setName(java.lang.String name)
Description copied from interface: org.dom4j.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 org.dom4j.Node

getText

public java.lang.String getText()
Description copied from interface: org.dom4j.Element
Returns the text value of this element without recursing through child elements. This method iterates through all org.dom4j.Text,org.dom4j.CDATA and org.dom4j.Entitynodes that this element contains and appends the text values together.

Specified by:
getText in interface org.dom4j.Element

setText

public void setText(java.lang.String text)
Description copied from interface: org.dom4j.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 org.dom4j.Node

getTextTrim

public java.lang.String getTextTrim()
Description copied from interface: org.dom4j.Element
DOCUMENT ME!

Specified by:
getTextTrim in interface org.dom4j.Element

getStringValue

public java.lang.String getStringValue()
Description copied from interface: org.dom4j.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 org.dom4j.Text,org.dom4j.CDATA,org.dom4j.Entityand org.dom4j.Element nodes all appended together.

Specified by:
getStringValue in interface org.dom4j.Element

getPath

public java.lang.String getPath()
Description copied from interface: org.dom4j.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 org.dom4j.Node

getPath

public java.lang.String getPath(org.dom4j.Element element)
Description copied from interface: org.dom4j.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 org.dom4j.Node

getUniquePath

public java.lang.String getUniquePath()
Description copied from interface: org.dom4j.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 org.dom4j.Node

getUniquePath

public java.lang.String getUniquePath(org.dom4j.Element element)
Description copied from interface: org.dom4j.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 org.dom4j.Node

asXML

public java.lang.String asXML()
Description copied from interface: org.dom4j.Node

asXML returns the textual XML representation of this node.

Specified by:
asXML in interface org.dom4j.Node

write

public void write(java.io.Writer writer)
           throws java.io.IOException
Description copied from interface: org.dom4j.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 org.dom4j.io.XMLWriter or its derivations.

Specified by:
write in interface org.dom4j.Node

getNodeType

public short getNodeType()
Description copied from interface: org.dom4j.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 org.dom4j.Node

getNodeTypeName

public java.lang.String getNodeTypeName()
Description copied from interface: org.dom4j.Node
DOCUMENT ME!

Specified by:
getNodeTypeName in interface org.dom4j.Node

detach

public org.dom4j.Node detach()
Description copied from interface: org.dom4j.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 org.dom4j.Node

selectNodes

public java.util.List selectNodes(java.lang.String xpath)
Description copied from interface: org.dom4j.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 org.dom4j.Node

selectObject

public java.lang.Object selectObject(java.lang.String xpath)
Description copied from interface: org.dom4j.Node

selectObject evaluates an XPath expression and returns the result as an java.lang.Object. The object returned can either be a java.util.List of one or more org.dom4j.Nodeinstances or a scalar object like a java.lang.Stringor a java.lang.Numberinstance depending on the XPath expression.

Specified by:
selectObject in interface org.dom4j.Node

selectNodes

public java.util.List selectNodes(java.lang.String xpath,
                                  java.lang.String comparison)
Description copied from interface: org.dom4j.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 org.dom4j.Node

selectNodes

public java.util.List selectNodes(java.lang.String xpath,
                                  java.lang.String comparison,
                                  boolean removeDups)
Description copied from interface: org.dom4j.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 org.dom4j.Node

selectSingleNode

public org.dom4j.Node selectSingleNode(java.lang.String xpath)
Description copied from interface: org.dom4j.Node

selectSingleNode evaluates an XPath expression and returns the result as a single Node instance.

Specified by:
selectSingleNode in interface org.dom4j.Node

valueOf

public java.lang.String valueOf(java.lang.String xpath)
Description copied from interface: org.dom4j.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 org.dom4j.Node

numberValueOf

public java.lang.Number numberValueOf(java.lang.String xpath)
Description copied from interface: org.dom4j.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 org.dom4j.Node

matches

public boolean matches(java.la