scriptella.driver.xpath

Class NodeVariable

java.lang.Object

scriptella.driver.xpath.NodeVariable

public class NodeVariable
extends java.lang.Object

A special node variable for sub-queries and scripts that wraps the node selected by an XPath query, exposing useful methods.

Author:

Martin Alderson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
NodeVariable(scriptella.driver.xpath.XPathExpressionCompiler compiler, org.w3c.dom.Node node)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String expression) Gets the text value(s) of the node(s) selected by the specified XPath expression.
java.lang.String	getString(java.lang.String expression) Gets the string value of the first selected node by the specified XPath expression.
java.lang.String	getString(java.lang.String expression, java.lang.String ifNull) Gets the string value of the first selected node by the specified XPath expression.
java.lang.String[]	getStringArray(java.lang.String expression) Gets the text values of the nodes selected by the specified XPath expression.
void	remove() Removes this node from the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

NodeVariable

public NodeVariable(scriptella.driver.xpath.XPathExpressionCompiler compiler,
                    org.w3c.dom.Node node)

Method Detail

getStringArray

public java.lang.String[] getStringArray(java.lang.String expression)

Gets the text values of the nodes selected by the specified XPath expression.

Parameters:

expression - xpath expression to evaluate.

Returns:

a String array of text values of the selected nodes.

getString

public java.lang.String getString(java.lang.String expression)

Gets the string value of the first selected node by the specified XPath expression.

Parameters:

expression - xpath expression to evaluate.

Returns:

the text value of the first selected node, or null.

getString

public java.lang.String getString(java.lang.String expression,
                                  java.lang.String ifNull)

Gets the string value of the first selected node by the specified XPath expression.

Parameters:

expression - xpath expression to evaluate.

ifNull - String to return if the specified expression evaluates to null.

Returns:

the text value of the first selected node, or the specified string if null.

get

public java.lang.Object get(java.lang.String expression)

Gets the text value(s) of the node(s) selected by the specified XPath expression.

Parameters:

expression - xpath expression to evaluate.

Returns:

a String array of the selected nodes, or just a single String if one node found.

remove

public void remove()

Removes this node from the document. This is especially useful to improve performance and reduce memory usage when processing large documents.