dom.xpath.XPathResult

	Property	Defined By
		DOM 3 XPath booleanValue : Boolean [read-only] The value of this boolean result.	XPathResult
		DOM 3 XPath invalideIteratorState : Boolean [read-only] Signifies that the iterator has become invalid.	XPathResult
		DOM 3 XPath numberValue : Number [read-only] The value of this number result.	XPathResult
		DOM 3 XPath resultType : Number [read-only] A code representing the type of this result, as defined by the type constants.	XPathResult
		DOM 3 XPath singleNodeValue : Node [read-only] The value of this single node result, which may be null.	XPathResult
		DOM 3 XPath snapshotLength : Number [read-only] The number of nodes in the result snapshot.	XPathResult
		DOM 3 XPath stringValue : DOMString [read-only] The value of this string result.	XPathResult

	Method	Defined By
		DOM 3 XPath iterateNext():Node Iterates and returns the next node from the node set or nullif there are no more nodes.	XPathResult
		DOM 3 XPath snapshotItem(index:Number):Node Returns the indexth item in the snapshot collection.	XPathResult

	Constant	Defined By
		DOM 3 XPath ANY_TYPE : Number = 0 [static] This code does not represent a specific type.	XPathResult
		DOM 3 XPath ANY_UNORDERED_NODE_TYPE : Number = 8 [static] The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be null if the node set is empty.	XPathResult
		DOM 3 XPath BOOLEAN_TYPE : Number = 3 [static] The result is a boolean as defined by [XPath 1.0].	XPathResult
		DOM 3 XPath FIRST_ORDERED_NODE_TYPE : Number = 9 [static] The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be null if the node set is empty.	XPathResult
		DOM 3 XPath NUMBER_TYPE : Number = 1 [static] The result is a number as defined by [XPath 1.0].	XPathResult
		DOM 3 XPath ORDERED_NODE_ITERATOR_TYPE : Number = 5 [static] The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which will produce document-ordered nodes.	XPathResult
		DOM 3 XPath ORDERED_NODE_SNAPSHOT_TYPE : Number = 7 [static] The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that will be in original document order.	XPathResult
		DOM 3 XPath STRING_TYPE : Number = 2 [static] The result is a string as defined by [XPath 1.0].	XPathResult
		DOM 3 XPath UNORDERED_NODE_ITERATOR_TYPE : Number = 4 [static] The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which may not produce nodes in a particular order.	XPathResult
		DOM 3 XPath UNORDERED_NODE_SNAPSHOT_TYPE : Number = 6 [static] The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that may not be in a particular order.	XPathResult

Property Detail

DOM 3 XPath booleanValue

property

booleanValue:Boolean [read-only]

Introduced in:

DOM 3 XPath

The value of this boolean result.

Implementation
public function get booleanValue():Boolean

Throws

XPathException — TYPE_ERR: Raised if resultType is not BOOLEAN_TYPE.

See also

W3C - XPathResult.booleanValue

DOM 3 XPath invalideIteratorState

property

invalideIteratorState:Boolean [read-only]

Introduced in:

DOM 3 XPath

Signifies that the iterator has become invalid. True if resultType is UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE and the document has been modified since this result was returned.

Implementation
public function get invalideIteratorState():Boolean

See also

W3C - XPathResult.invalideIteratorState

DOM 3 XPath numberValue

property

numberValue:Number [read-only]

Introduced in:

DOM 3 XPath

The value of this number result. If the native double type of the DOM binding does not directly support the exact IEEE 754 result of the XPath expression, then it is up to the definition of the binding to specify how the XPath number is converted to the native binding number.

Implementation
public function get numberValue():Number

Throws

XPathException — TYPE_ERR: Raised if resultType is not NUMBER_TYPE.

See also

W3C - XPathResult.numberValue

DOM 3 XPath resultType

property

resultType:Number [read-only]

Introduced in:

DOM 3 XPath

A code representing the type of this result, as defined by the type constants.

Implementation
public function get resultType():Number

See also

W3C - XPathResult.resultType

DOM 3 XPath singleNodeValue

property

singleNodeValue:Node [read-only]

Introduced in:

DOM 3 XPath

The value of this single node result, which may be null.

Implementation
public function get singleNodeValue():Node

Throws

XPathException — TYPE_ERR: Raised if resultType is not ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE.

See also

W3C - XPathResult.singleNodeValue

DOM 3 XPath snapshotLength

property

snapshotLength:Number [read-only]

Introduced in:

DOM 3 XPath

The number of nodes in the result snapshot. Valid values for snapshotItem indices are 0 to snapshotLength-1 inclusive.

Implementation
public function get snapshotLength():Number

Throws

XPathException — TYPE_ERR: Raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE.

See also

W3C - XPathResult.snapshotLength

DOM 3 XPath stringValue

property

stringValue:DOMString [read-only]

Introduced in:

DOM 3 XPath

The value of this string result.

Implementation
public function get stringValue():DOMString

Throws

XPathException — TYPE_ERR: Raised if resultType is not STRING_TYPE.

See also

W3C - XPathResult.stringValue

Method Detail

DOM 3 XPath iterateNext

()

method

public function iterateNext():Node

Introduced in:

DOM 3 XPath

Iterates and returns the next node from the node set or nullif there are no more nodes.

Returns

Node — Returns the next node.

Throws

	`XPathException` — TYPE_ERR: Raised if resultType is not UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE.

	`EventException` — INVALID_STATE_ERR: The document has been mutated since the result was returned.

See also

W3C - XPathResult.iterateNext()

DOM 3 XPath snapshotItem

()

method

public function snapshotItem(index:Number):Node

Introduced in:

DOM 3 XPath

Returns the indexth item in the snapshot collection. If index is greater than or equal to the number of nodes in the list, this method returns null. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated.

Parameters

index:Number — Index into the snapshot collection.

Returns

Node — The node at the indexth position in the NodeList, or null if that is not a valid index.

Throws

XPathException — TYPE_ERR: Raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE.

See also

W3C - XPathResult.snapshotItem()

Constant Detail

DOM 3 XPath ANY_TYPE

Constant

public static const ANY_TYPE:Number = 0

Introduced in:

DOM 3 XPath

This code does not represent a specific type. An evaluation of an XPath expression will never produce this type. If this type is requested, then the evaluation returns whatever type naturally results from evaluation of the expression. If the natural result is a node set when ANY_TYPE was requested, then UNORDERED_NODE_ITERATOR_TYPE is always the resulting type. Any other representation of a node set must be explicitly requested.

See also

W3C - XPathResult.ANY_TYPE

DOM 3 XPath ANY_UNORDERED_NODE_TYPE

Constant

public static const ANY_UNORDERED_NODE_TYPE:Number = 8

Introduced in:

DOM 3 XPath

The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be null if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once any node in the resulting set has been found. If there is more than one node in the actual result, the single node returned might not be the first in document order.

DOM 3 XPath BOOLEAN_TYPE

Constant

public static const BOOLEAN_TYPE:Number = 3

Introduced in:

DOM 3 XPath

The result is a boolean as defined by [XPath 1.0]. Document modification does not invalidate the boolean, but may mean that reevaluation would not yield the same boolean.

See also

W3C - XPathResult.BOOLEAN_TYPE

DOM 3 XPath FIRST_ORDERED_NODE_TYPE

Constant

public static const FIRST_ORDERED_NODE_TYPE:Number = 9

Introduced in:

DOM 3 XPath

The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be null if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once the first node in document order of the resulting set has been found. If there are more than one node in the actual result, the single node returned will be the first in document order.

DOM 3 XPath NUMBER_TYPE

Constant

public static const NUMBER_TYPE:Number = 1

Introduced in:

DOM 3 XPath

The result is a number as defined by [XPath 1.0]. Document modification does not invalidate the number, but may mean that reevaluation would not yield the same number.

See also

W3C - XPathResult.NUMBER_TYPE

DOM 3 XPath ORDERED_NODE_ITERATOR_TYPE

Constant

public static const ORDERED_NODE_ITERATOR_TYPE:Number = 5

Introduced in:

DOM 3 XPath

The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which will produce document-ordered nodes. Document modification invalidates the iteration.

DOM 3 XPath ORDERED_NODE_SNAPSHOT_TYPE

Constant

public static const ORDERED_NODE_SNAPSHOT_TYPE:Number = 7

Introduced in:

DOM 3 XPath

The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that will be in original document order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document.

DOM 3 XPath STRING_TYPE

Constant

public static const STRING_TYPE:Number = 2

Introduced in:

DOM 3 XPath

The result is a string as defined by [XPath 1.0]. Document modification does not invalidate the string, but may mean that the string no longer corresponds to the current document.

See also

W3C - XPathResult.STRING_TYPE

DOM 3 XPath UNORDERED_NODE_ITERATOR_TYPE

Constant

public static const UNORDERED_NODE_ITERATOR_TYPE:Number = 4

Introduced in:

DOM 3 XPath

The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which may not produce nodes in a particular order. Document modification invalidates the iteration. This is the default type returned if the result is a node set and ANY_TYPE is requested.

DOM 3 XPath UNORDERED_NODE_SNAPSHOT_TYPE

Constant

public static const UNORDERED_NODE_SNAPSHOT_TYPE:Number = 6

Introduced in:

DOM 3 XPath

The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that may not be in a particular order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document.

Mon Aug 17 2009, 10:08 AM -04:00

DOM Reference Manual		All Packages \| All Classes \| Index \| Frames No Frames
XPathResult	Properties \| Methods \| Constants

Package	dom.xpath
Class	public class XPathResult
Inheritance	XPathResult Object