elemental.xpath

Interface XPathResult

All Known Implementing Classes:

JsXPathResult

public interface XPathResult

Refer to nsIDOMXPathResult for more detail.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_TYPE A result set containing whatever type naturally results from evaluation of the expression.
static int	ANY_UNORDERED_NODE_TYPE A result node-set containing any single node that matches the expression.
static int	BOOLEAN_TYPE A result containing a single boolean value.
static int	FIRST_ORDERED_NODE_TYPE A result node-set containing the first node in the document that matches the expression.
static int	NUMBER_TYPE A result containing a single number.
static int	ORDERED_NODE_ITERATOR_TYPE A result node-set containing all the nodes matching the expression.
static int	ORDERED_NODE_SNAPSHOT_TYPE A result node-set containing snapshots of all the nodes matching the expression.
static int	STRING_TYPE A result containing a single string.
static int	UNORDERED_NODE_ITERATOR_TYPE A result node-set containing all the nodes matching the expression.
static int	UNORDERED_NODE_SNAPSHOT_TYPE A result node-set containing snapshots of all the nodes matching the expression.

Method Summary

Modifier and Type	Method and Description
double	getNumberValue() readonly float
int	getResultType() readonly integer (short)
Node	getSingleNodeValue() readonly Node
int	getSnapshotLength() readonly Integer
String	getStringValue() readonly String
boolean	isBooleanValue() readonly boolean
boolean	isInvalidIteratorState() readonly boolean
Node	iterateNext()
Node	snapshotItem(int index)

Field Detail

ANY_TYPE

static final int ANY_TYPE

A result set containing whatever type naturally results from evaluation of the expression. Note that if the result is a node-set then UNORDERED_NODE_ITERATOR_TYPE is always the resulting type.

See Also:

Constant Field Values

ANY_UNORDERED_NODE_TYPE

static final int ANY_UNORDERED_NODE_TYPE

A result node-set containing any single node that matches the expression. The node is not necessarily the first node in the document that matches the expression.

See Also:

Constant Field Values

BOOLEAN_TYPE

static final int BOOLEAN_TYPE

A result containing a single boolean value. This is useful for example, in an XPath expression using the not() function.

See Also:

Constant Field Values

FIRST_ORDERED_NODE_TYPE

static final int FIRST_ORDERED_NODE_TYPE

A result node-set containing the first node in the document that matches the expression.

See Also:

Constant Field Values

NUMBER_TYPE

static final int NUMBER_TYPE

A result containing a single number. This is useful for example, in an XPath expression using the count() function.

See Also:

Constant Field Values

ORDERED_NODE_ITERATOR_TYPE

static final int ORDERED_NODE_ITERATOR_TYPE

A result node-set containing all the nodes matching the expression. The nodes in the result set are in the same order that they appear in the document.

See Also:

Constant Field Values

ORDERED_NODE_SNAPSHOT_TYPE

static final int ORDERED_NODE_SNAPSHOT_TYPE

A result node-set containing snapshots of all the nodes matching the expression. The nodes in the result set are in the same order that they appear in the document.

See Also:

Constant Field Values

STRING_TYPE

static final int STRING_TYPE

A result containing a single string.

See Also:

Constant Field Values

UNORDERED_NODE_ITERATOR_TYPE

static final int UNORDERED_NODE_ITERATOR_TYPE

A result node-set containing all the nodes matching the expression. The nodes may not necessarily be in the same order that they appear in the document.

See Also:

Constant Field Values

UNORDERED_NODE_SNAPSHOT_TYPE

static final int UNORDERED_NODE_SNAPSHOT_TYPE

A result node-set containing snapshots of all the nodes matching the expression. The nodes may not necessarily be in the same order that they appear in the document.

See Also:

Constant Field Values

Method Detail

isBooleanValue

boolean isBooleanValue()

readonly boolean

isInvalidIteratorState

boolean isInvalidIteratorState()

readonly boolean

getNumberValue

double getNumberValue()

readonly float

getResultType

int getResultType()

readonly integer (short)

getSingleNodeValue

Node getSingleNodeValue()

readonly Node

getSnapshotLength

int getSnapshotLength()

readonly Integer

getStringValue

String getStringValue()

readonly String

iterateNext

Node iterateNext()

snapshotItem

Node snapshotItem(int index)