|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.dom4j.tree.AbstractNode
AbstractNode
is an abstract base class for tree implementors
to use for implementation inheritence.
Field Summary | |
protected static String[] |
NODE_TYPE_NAMES
|
Fields inherited from interface org.dom4j.Node |
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE |
Constructor Summary | |
AbstractNode()
|
Method Summary | |
Node |
asXPathResult(Element parent)
asXPathResult returns a version of this node which is
capable of being an XPath result. |
Object |
clone()
clone will return a deep clone or if this node is
read-only then clone will return the same instance.
|
Pattern |
createPattern(String patternText)
|
XPath |
createXPath(String xpathExpression)
createXPath creates an XPath object for the given
xpathExpression. |
NodeFilter |
createXPathFilter(String patternText)
|
protected Node |
createXPathResult(Element parent)
|
Node |
detach()
Removes this node from its parent if there is one. |
Document |
getDocument()
getDocument returns the Document that this
Node is part of if this node supports the parent
relationship.
|
protected DocumentFactory |
getDocumentFactory()
|
String |
getName()
getName returns the name of this node. |
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 |
getStringValue()
Returns the XPath string-value of this node. |
String |
getText()
Returns the text of this node. |
String |
getUniquePath()
Returns the XPath expression which will return a nodeset of one node which is the current node. |
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 |
isReadOnly()
isReadOnly returns true if this node is read only and
cannot be modified. |
boolean |
matches(String patternText)
matches returns true if evaluating the given XPath
expression on this node returns a non-empty node set containing this
node.
|
Number |
numberValueOf(String xpathExpression)
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.
|
List |
selectNodes(String xpathExpression)
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 xpathExpression,
String comparisonXPathExpression)
selectNodes evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
List of Node instances.
|
List |
selectNodes(String xpathExpression,
String comparisonXPathExpression,
boolean removeDuplicates)
selectNodes evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
List of Node instances.
|
Object |
selectObject(String xpathExpression)
selectObject evaluates an XPath expression and returns the
result as an Object . |
Node |
selectSingleNode(String xpathExpression)
selectSingleNode evaluates an XPath expression and returns
the result as a single Node instance.
|
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 parent)
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 |
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 xpathExpression)
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. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.dom4j.Node |
accept, asXML, getPath, getUniquePath |
Field Detail |
protected static final String[] NODE_TYPE_NAMES
Constructor Detail |
public AbstractNode()
Method Detail |
public short getNodeType()
Node
getNodeType
in interface Node
public String getNodeTypeName()
Node
getNodeTypeName
in interface Node
public Document getDocument()
Node
getDocument
returns the Document
that this
Node
is part of if this node supports the parent
relationship.
This method is an optional feature and may not be supported for all
Node
implementations.
getDocument
in interface Node
Document
public void setDocument(Document document)
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.
setDocument
in interface Node
document
- is the new document of this node.public Element getParent()
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.
getParent
in interface Node
public void setParent(Element parent)
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.
setParent
in interface Node
parent
- is the new parent of this node.public boolean supportsParent()
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.
supportsParent
in interface Node
public boolean isReadOnly()
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.
isReadOnly
in interface Node
Node
is read only and cannot be
modified otherwise false.public boolean hasContent()
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.
hasContent
in interface Node
Node
is a Branch with a nodeCount()
of one or more.public String getPath()
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.
getPath
in interface Node
public String getUniquePath()
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.
getUniquePath
in interface Node
public Object clone()
Node
clone
will return a deep clone or if this node is
read-only then clone will return the same instance.
clone
in interface Node
public Node detach()
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() );
detach
in interface Node
public String getName()
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.
getName
in interface Node
public void setName(String name)
Node
Sets the text data of this node or this method will throw an
UnsupportedOperationException
if it is read-only.
setName
in interface Node
name
- is the new name of this nodepublic String getText()
Node
Returns the text of this node.
getText
in interface Node
public String getStringValue()
Node
getStringValue
in interface Node
public void setText(String text)
Node
Sets the text data of this node or this method will throw an
UnsupportedOperationException
if it is read-only.
setText
in interface Node
text
- is the new textual value of this nodepublic void write(Writer writer) throws IOException
Node
write
writes this node as the default XML notation for
this node. If you wish to control the XML output (such as for pretty
printing, changing the indentation policy etc.) then please use XMLWriter
or its derivations.
write
in interface Node
writer
- is the Writer
to output the XML to
IOException
- DOCUMENT ME!public Object selectObject(String xpathExpression)
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 Node
instances or a scalar object like a
String
or a Number
instance depending on the XPath
expression.
selectObject
in interface Node
xpathExpression
- is the XPath expression to be evaluated
List
of Node
instances, a String
or a Number
instance
depending on the XPath expression.public List selectNodes(String xpathExpression)
Node
selectNodes
evaluates an XPath expression and returns the
result as a List
of Node
instances or
String
instances depending on the XPath expression.
selectNodes
in interface Node
xpathExpression
- is the XPath expression to be evaluated
Node
or String
instances depending on the XPath expressionpublic List selectNodes(String xpathExpression, String comparisonXPathExpression)
Node
selectNodes
evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
List
of Node
instances.
selectNodes
in interface Node
xpathExpression
- is the XPath expression to be evaluatedcomparisonXPathExpression
- is the XPath expression used to compare the results by for
sorting
Node
instances sorted by the
comparisonXPathExpressionpublic List selectNodes(String xpathExpression, String comparisonXPathExpression, boolean removeDuplicates)
Node
selectNodes
evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
List
of Node
instances.
selectNodes
in interface Node
xpathExpression
- is the XPath expression to be evaluatedcomparisonXPathExpression
- is the XPath expression used to compare the results by for
sortingremoveDuplicates
- if this parameter is true then duplicate values (using the
comparisonXPathExpression) are removed from the result List.
Node
instances sorted by the
comparisonXPathExpressionpublic Node selectSingleNode(String xpathExpression)
Node
selectSingleNode
evaluates an XPath expression and returns
the result as a single Node
instance.
selectSingleNode
in interface Node
xpathExpression
- is the XPath expression to be evaluated
Node
matching the XPath expressionpublic String valueOf(String xpathExpression)
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 .
valueOf
in interface Node
xpathExpression
- is the XPath expression to be evaluated
public Number numberValueOf(String xpathExpression)
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.
numberValueOf
in interface Node
xpathExpression
- is the XPath expression to be evaluated
public boolean matches(String patternText)
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 )
matches
in interface Node
patternText
- is an XPath expression
public XPath createXPath(String xpathExpression)
Node
createXPath
creates an XPath object for the given
xpathExpression. The XPath object allows the variable context to be
specified.
createXPath
in interface Node
xpathExpression
- is the XPath expression to be evaluated
public NodeFilter createXPathFilter(String patternText)
public Pattern createPattern(String patternText)
public Node asXPathResult(Element parent)
Node
asXPathResult
returns a version of this node which is
capable of being an XPath result. The result of an XPath expression
should always support the parent relationship, whether the original XML
tree was singly or doubly linked. If the node does not support the parent
relationship then a new node will be created which is linked to its
parent and returned.
asXPathResult
in interface Node
parent
- DOCUMENT ME!
Node
which supports the parent relationshipprotected DocumentFactory getDocumentFactory()
protected Node createXPathResult(Element parent)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |