mozilla

Revision 110825 of Introduction to using XPath in JavaScript

  • Revision slug: Introduction_to_using_XPath_in_JavaScript
  • Revision title: Introduction to using XPath in JavaScript
  • Revision id: 110825
  • Created:
  • Creator: Jt
  • Is current revision? No
  • Comment

Revision Content

Introduction

This document describes the interface to access XPath functions using JavaScript.

Mozilla implements much of the DOM 3 XPath. This allows XPath expressions to be run against both HTML and XML documents.

The simplest interface to XPath is the evaluate function of the document object, which returns an object of type XPathResult:

var xpathResult = document.evaluate( xpathExpression, contextNode, namespaceResolver, resultType, result);

The evaluate function takes a total of five arguments:

  • xpathExpression: A string containing the XPath expression to be evaluated.
  • contextNode: A node in the document against which the xpathExpression should be evaluated. The document node is the most commonly used.
  • namespaceResolver: A user defined function that will be passed any namespace prefixes contained within xpathExpression which returns a string representing the namespace URI associated with that prefix. This enables conversion between the prefixes used in the XPath expressions and the possibly different prefixes used in the document. The most commonly used value for this is null, which is used for HTML documents or when no namespace prefixes are used. Note that if the xpathExpression contains a namespace prefix this will result in a DOMException being thrown with the code NAMESPACE_ERR.
  • resultType: A constant that defines the desired result type to be returned as a result of the evaluation. The most commonly passed constant is XPathResult.ANY_TYPE which will return the results of the XPath expression as the most natural type.
  • result: Either an existing XPathResult which is to be reused to return the results, or null to create a new XPathResult.

A Simple Example

To extract all the h2 heading elements in a HTML document using XPath, the xpathExpression is simply '//h2'. The full code for this is then:

var headings = document.evaluate('//h2', document, null, XPathResult.ANY_TYPE, null);

Notice that, since HTML does not have namespaces, we have passed null for the namespaceResolver argument.

Since we wish to search over the entire document for the headings, we have used the document object itself as the contextNode.

The result of this expression is an XPathResult object. If we wish to know the type of result returned, we may evaluate the resultType property of the returned object. In this case that will evaluate to 4, a UNORDERED_NODE_ITERATOR_TYPE. This is the default return type when the result of the XPath expression is a node-set. It provides access to a single node at a time and may not return nodes in a particular order. To access the returned nodes, we use the iterateNext() method of the returned object:

var thisHeading = headings.iterateNext();
var alertText = 'Level 2 headings in this document are:\n'
while (thisHeading) {
  alertText += thisHeading.textContent + '\n';
  thisHeading = headings.iterateNext();
}

Once we iterate to a node, we have access to all the standard DOM interfaces on that node. After iterating through all the h2 elements returned from our expression, any further calls to iterateNext() will return null.

Returning simple types

In many situations, the return value of an XPath expression is not a node set but a simpler type: a floating point number - NUMBER_TYPE, a string - STRING_TYPE, or a boolean value - BOOLEAN_TYPE. For expressions of this type, we still obtain an XPathResult object as a result of our call to document.evaluate() but we must access the numberValue, stringValue or booleanValue properties respectively of the XPathResult object to retrieve our results.

A simple example is using the XPath expression count(//p) to obtain the number of <p> elements in a HTML document:

var paragraphCount = document.evaluate('count(//p)', document, null, XPathResult.ANY_TYPE, null).numberValue;
alert('This document contains ' + paragraphCount + ' paragraph elements');

Although Javascript allows us to convert the number to a string for display, the XPath interface will not automatically convert the numerical result if the stringValue property is requested, so the following code will not work:

var paragraphCount = document.evaluate('count(//p)', document, null, XPathResult.ANY_TYPE, null).stringValue;
alert('This document contains ' + paragraphCount + ' paragraph elements"');

Instead it will return an exception with the code NS_DOM_TYPE_ERROR. It is possible to request a specific type of return value by altering the resultType property. In order to force a string return type, we can pass resultType the constant XPathResult.STRING_TYPE, so the following code will work:

var paragraphCount = document.evaluate('count(//p)', document, null, XPathResult.STRING_TYPE, null).stringValue;
alert('This document contains ' + paragraphCount + ' paragraph elements');

Returning node-set types

In the earlier example of reading all the h2 headings in a document, the node-set returned was of type UNORDERED_NODE_ITERATOR_TYPE. The XPath interface allows node-sets to be returned in a variety of different ways, there are 3 principal categories of node set types that can be returned:

  • Iterators: An iterator which allows access to the matched nodes one at at time. The next node can be accessed with the iterateNext() method of the XpathResult object. If the document is modified between iterations it invalidates the iterationand the invalidIteratorState property becomes is set to true.
  • Snapshots: A static list of matched nodes, which are accessed through the snapshotItem( itemNumber ) method of XPathResult, where itemNumber is the index of the node to be retrived. The number of nodes returned can be accessed through the snapshotLength property. Snapshots do not change with document mutations, so unlike the iterator result the snapshot does not become invalid but it may not correspond to the current document, the nodes may have been moved, it might contain nodes that no longer exist, or an incomplete set of node results.
  • First Nodes: Only the first found node matching the XPath expression is returned. This may be accessed through the singleNodeValue property of the XPathResult object. This will be null if the node set is empty. For the unordered subtype the single node returned might not be the first in document order.

For each of these node set types, there are 2 subtypes, one that is guaranteed to retain the nodes in the document order, and one that does not. The full list of node-set types that can be passed as a resultType argument is:

  • XPathResult.UNORDERED_NODE_ITERATOR_TYPE: Iterator, Unordered
  • XPathResult.ORDERED_NODE_ITERATOR_TYPE: Iterator, Ordered
  • XPathResult.UNORDERED_NODE_SNAPSHOT_TYPE: Snapshot, Unordered
  • XPathResult.ORDERED_NODE_SNAPSHOT_TYPE: Snapshot, Ordered
  • XPathResult.ANY_UNORDERED_NODE_TYPE: Single node, Unordered
  • XPathResult.FIRST_ORDERED_NODE_TYPE: Single node, Ordered

For example,

//XXX - want an example with add and remove nodes and probably also with contextNode != document

Using XPath with XML documents

All the examples so far have been designed to work with HTML documents in which there are no namespaces. In order to use XPath on XML documents, one must provide a function for converting namespace prefixes in the XPath expression to those in the document. Such a function can be provided explicitly or can be created from a node in the target document.

Implementing a Namespace Resolver

Namespace Resolvers are functions that take namespace prefixes from the XPath expression and return the corresponding URI. For example, the expression:

//html:td/mathml:math

Might be designed to select all MathML expressions that are the children of HTML table data cell elements. To associate the mathml: prefix with the namespace URL http://www.w3.org/1998/Math/MathML and html: with the URL http://www.w3.org/1999/xhtml we can provide a function:

function NSResolver( prefix ) 
{
  if ( prefix == 'html' ) 
  {
    return 'http://www.w3.org/1999/xhtml';
  }
  else if ( prefix == 'mathml' ) 
  {
    return 'http://www.w3.org/1998/Math/MathML'
  }
  else
  {
  //should never get here.
    return null;
  }
}

Our call to document.evaluate then looks like:

document.evaluate("//html:td/mathml:math", document, NSResolver, XPathResult.ANY_TYPE, null);

XPathResultTypes

resultType Value Description
ANY_TYPE 0 Whatever type naturally results from the given expression.
NUMBER_TYPE 1 A result set containing a single number. Useful, for example, in an XPath expression using the count() function.
STRING_TYPE 2 A result set containing a single string.
BOOLEAN_TYPE 3 A result set containing a single boolean value. Useful, for example, an an XPath expression using the not() function.
UNORDERED_NODE_ITERATOR_TYPE 4 A result set containing all the nodes matching the expression. The nodes in the result set are not necessarily in the same order they appear in the document.
ORDERED_NODE_ITERATOR_TYPE 5 A result set containing all the nodes matching the expression. The nodes in the result set are in the same order they appear in the document.
UNORDERED_NODE_SNAPSHOT_TYPE 6 A result set containing snapshots of all the nodes matching the expression. The nodes in the result set are not necessarily in the same order they appear in the document.
ORDERED_NODE_SNAPSHOT_TYPE 7 A result set containing snapshots of all the nodes matching the expression. The nodes in the result set are in the same order they appear in the document.
ANY_UNORDERED_NODE_TYPE 8 A result set containing any single node that matches the expression. The node is not necessarily the first node in the document that matches the expression.
FIRST_ORDERED_NODE_TYPE 9 A result set containing the first node in the document that matches the expression.

Results of NODE_ITERATOR types contain references to nodes in the document. Modifying a node will invalidate the iterator. After modifying a node, attempting to iterate through the results will result in an error.

Results of NODE_SNAPSHOT types contain snapshots, or copies of nodes in the document. These nodes can be modified, but modifying them does not modify the document.

Revision Source

<h3 name="Introduction">Introduction</h3>
<p>This document describes the interface to access <a href="en/XPath/Functions"> XPath functions</a> using JavaScript.
</p><p>Mozilla implements much of the <a class="external" href="http://www.w3.org/TR/DOM-Level-3-XPath/xpath.html">DOM 3 XPath</a>. This allows XPath expressions to be run against both HTML and XML documents.
</p><p>The simplest interface to XPath is the <a href="en/DOM/document.evaluate">evaluate</a> function of the <a href="en/DOM/document">document</a> object, which returns an object of type <code><a href="en/XPathResult">XPathResult</a></code>:
</p>
<pre>var xpathResult = document.evaluate( xpathExpression, contextNode, namespaceResolver, resultType, result);
</pre>
<p>The evaluate function takes a total of five arguments:
</p>
<ul><li><code>xpathExpression</code>: A string containing the XPath expression to be evaluated.
</li></ul>
<ul><li><code>contextNode</code>: A node in the document against which the <code>xpathExpression</code> should be evaluated. The <a href="en/DOM/document">document</a> node is the most commonly used.
</li></ul>
<ul><li><code>namespaceResolver</code>: A user defined function that will be passed any namespace prefixes contained within <code>xpathExpression</code> which returns a string representing the namespace URI associated with that prefix. This enables conversion between the prefixes used in the XPath expressions and the possibly different prefixes used in the document. The most commonly used value for this is <code>null</code>, which is used for HTML documents or when no namespace prefixes are used. Note that if the <code>xpathExpression</code> contains a namespace prefix this will result in a <code>DOMException</code> being thrown with the code <code>NAMESPACE_ERR</code>.
</li></ul>
<ul><li><code>resultType</code>: A constant that defines the desired result type to be returned as a result of the evaluation. The most commonly passed constant is <code>XPathResult.ANY_TYPE</code> which will return the results of the XPath expression as the most natural type.
</li></ul>
<ul><li> <code>result</code>: Either an existing <code>XPathResult</code> which is to be reused to return the results, or <code>null</code> to create a new <code>XPathResult</code>.
</li></ul>
<h3 name="A_Simple_Example">A Simple Example</h3>
<p>To extract all the h2 heading elements in a HTML document using XPath, the <code>xpathExpression</code> is simply '<code>//h2</code>'. The full code for this is then:
</p>
<pre>var headings = document.evaluate('//h2', document, null, XPathResult.ANY_TYPE, null);</pre>
<p>Notice that, since HTML does not have namespaces, we have passed <code>null</code> for the <code>namespaceResolver</code> argument. 
</p><p>Since we wish to search over the entire document for the headings, we have used the <a href="en/DOM/document">document</a> object itself as the <code>contextNode</code>.
</p><p>The result of this expression is an <code>XPathResult</code> object. If we wish to know the type of result returned, we may evaluate the <code>resultType</code> property of the returned object. In this case that will evaluate to 4, a <code>UNORDERED_NODE_ITERATOR_TYPE</code>. This is the default return type when the result of the XPath expression is a node-set. It provides access to a single node at a time and may not return nodes in a particular order. To access the returned nodes, we use the <code>iterateNext()</code> method of the returned object:
</p>
<pre>var thisHeading = headings.iterateNext();
var alertText = 'Level 2 headings in this document are:\n'
while (thisHeading) {
  alertText += thisHeading.textContent + '\n';
  thisHeading = headings.iterateNext();
}
</pre>
<p>Once we iterate to a node, we have access to all the standard DOM interfaces on that node. After iterating through all the <code>h2</code> elements returned from our expression, any further calls to <code>iterateNext()</code> will return <code>null</code>.
</p>
<h3 name="Returning_simple_types">Returning simple types</h3>
<p>In many situations, the return value of an XPath expression is not a node set but a simpler type: a floating point number - NUMBER_TYPE, a string - STRING_TYPE, or a boolean value - BOOLEAN_TYPE. For expressions of this type, we still obtain an <code>XPathResult</code> object as a result of our call to <code>document.evaluate()</code> but we must access the <code>numberValue</code>, <code>stringValue</code> or <code>booleanValue</code> properties respectively of the <code>XPathResult</code> object to retrieve our results.
</p><p>A simple example is using the XPath expression <code><a href="en/XPath/Functions/count">count(//p)</a></code> to obtain the number of <code><span class="plain">&lt;p&gt;</span></code> elements in a HTML document:
</p>
<pre>var paragraphCount = document.evaluate('count(//p)', document, null, XPathResult.ANY_TYPE, null).numberValue;
alert('This document contains ' + paragraphCount + ' paragraph elements');
</pre>
<p>Although Javascript allows us to convert the number to a string for display, the XPath interface will not automatically convert the numerical result if the <code>stringValue</code> property is requested, so the following code will <b>not</b> work:
</p>
<pre>var paragraphCount = document.evaluate('count(//p)', document, null, XPathResult.ANY_TYPE, null).stringValue;
alert('This document contains ' + paragraphCount + ' paragraph elements"');
</pre>
<p>Instead it will return an exception with the code <code>NS_DOM_TYPE_ERROR</code>. It is possible to request a specific type of return value by altering the <code>resultType</code> property. In order to force a string return type, we can pass <code>resultType</code> the constant <code>XPathResult.STRING_TYPE</code>, so the following code will work:
</p>
<pre>var paragraphCount = document.evaluate('count(//p)', document, null, XPathResult.STRING_TYPE, null).stringValue;
alert('This document contains ' + paragraphCount + ' paragraph elements');
</pre>
<h3 name="Returning_node-set_types">Returning node-set types</h3>
<p>In the earlier example of reading all the <code>h2</code> headings in a document, the node-set returned was of type <code>UNORDERED_NODE_ITERATOR_TYPE</code>. The XPath interface allows node-sets to be returned in a variety of different ways, there are 3 principal categories of node set types that can be returned:
</p>
<ul><li><b>Iterators</b>: An iterator which allows access to the matched nodes one at at time. The next node can be accessed with the <code>iterateNext()</code> method of the <code>XpathResult</code> object. If the document is modified between iterations it invalidates the iterationand the <code>invalidIteratorState</code> property becomes is set to <code>true</code>.
</li></ul>
<ul><li><b>Snapshots</b>: A static list of matched nodes, which are accessed through the <code>snapshotItem( itemNumber )</code> method of <code>XPathResult</code>, where <code>itemNumber</code> is the index of the node to be retrived. The number of nodes returned can be accessed through the <code>snapshotLength</code> property. Snapshots do not change with document mutations, so unlike the iterator result the snapshot does not become invalid but it may not correspond to the current document, the nodes may have been moved, it might contain nodes that no longer exist, or an incomplete set of node results.
</li></ul>
<ul><li><b>First Nodes</b>: Only the first found node matching the XPath expression is returned. This may be accessed through the <code>singleNodeValue</code> property of the <code>XPathResult</code> object. This will be <code>null</code> if the node set is empty. For the unordered subtype the single node returned might not be the first in document order.
</li></ul>
<p>For each of these node set types, there are 2 subtypes, one that is guaranteed to retain the nodes in the document order, and one that does not. The full list of node-set types that can be passed as a <code>resultType</code> argument is:
</p>
<ul><li>XPathResult.UNORDERED_NODE_ITERATOR_TYPE: Iterator, Unordered
</li><li>XPathResult.ORDERED_NODE_ITERATOR_TYPE: Iterator, Ordered
</li></ul>
<ul><li>XPathResult.UNORDERED_NODE_SNAPSHOT_TYPE: Snapshot, Unordered
</li><li>XPathResult.ORDERED_NODE_SNAPSHOT_TYPE: Snapshot, Ordered
</li></ul>
<ul><li>XPathResult.ANY_UNORDERED_NODE_TYPE: Single node, Unordered
</li><li>XPathResult.FIRST_ORDERED_NODE_TYPE: Single node, Ordered
</li></ul>
<p>For example, 
</p><p>//XXX - want an example with add and remove nodes and probably also with contextNode != document
</p>
<h3 name="Using_XPath_with_XML_documents">Using XPath with XML documents</h3>
<p>All the examples so far have been designed to work with HTML documents in which there are no namespaces. In order to use XPath on <a href="en/XML_documents">XML documents</a>, one must provide a function for converting namespace prefixes in the XPath expression to those in the document. Such a function can be provided explicitly or can be created from a node in the target document.
</p>
<h4 name="Implementing_a_Namespace_Resolver">Implementing a Namespace Resolver</h4>
<p>Namespace Resolvers are functions that take namespace prefixes from the XPath expression and return the corresponding URI. For example, the expression:
</p>
<pre>//html:td/mathml:math
</pre>
<p>Might be designed to select all MathML expressions that are the children of HTML table data cell elements. To associate the <code>mathml:</code> prefix with the namespace URL <code>http://www.w3.org/1998/Math/MathML</code> and <code>html:</code> with the URL <code>http://www.w3.org/1999/xhtml</code> we can provide a function:
</p>
<pre>function NSResolver( prefix ) 
{
  if ( prefix == 'html' ) 
  {
    return 'http://www.w3.org/1999/xhtml';
  }
  else if ( prefix == 'mathml' ) 
  {
    return 'http://www.w3.org/1998/Math/MathML'
  }
  else
  {
  //should never get here.
    return null;
  }
}
</pre>
<p>Our call to <code>document.evaluate</code> then looks like:
</p>
<pre>document.evaluate("//html:td/mathml:math", document, NSResolver, XPathResult.ANY_TYPE, null);
</pre>
<h3 name="XPathResultTypes">XPathResultTypes</h3>
<table class="standard-table">

<tbody><tr>
<td class="header">resultType
</td><td class="header">Value
</td><td class="header">Description
</td></tr>

<tr>
<td>ANY_TYPE
</td><td>0
</td><td>Whatever type naturally results from the given expression.
</td></tr>

<tr>
<td>NUMBER_TYPE
</td><td>1
</td><td>A result set containing a single number.  Useful, for example, in an XPath expression using the <code>count()</code> function.
</td></tr>

<tr>
<td>STRING_TYPE
</td><td>2
</td><td>A result set containing a single string.
</td></tr>

<tr>
<td>BOOLEAN_TYPE
</td><td>3
</td><td>A result set containing a single boolean value. Useful, for example, an an XPath expression using the <code>not()</code> function.
</td></tr>

<tr>
<td>UNORDERED_NODE_ITERATOR_TYPE
</td><td>4
</td><td>A result set containing all the nodes matching the expression.  The nodes in the result set are not necessarily in the same order they appear in the document.
</td></tr>

<tr>
<td>ORDERED_NODE_ITERATOR_TYPE
</td><td>5
</td><td>A result set containing all the nodes matching the expression.  The nodes in the result set are in the same order they appear in the document.
</td></tr>

<tr>
<td>UNORDERED_NODE_SNAPSHOT_TYPE
</td><td>6
</td><td>A result set containing snapshots of all the nodes matching the expression. The nodes in the result set are not necessarily in the same order they appear in the document.
</td></tr>

<tr>
<td>ORDERED_NODE_SNAPSHOT_TYPE
</td><td>7
</td><td>A result set containing snapshots of all the nodes matching the expression. The nodes in the result set are in the same order they appear in the document.
</td></tr>

<tr>
<td>ANY_UNORDERED_NODE_TYPE
</td><td>8
</td><td>A result set containing any single node that matches the expression. The node is not necessarily the first node in the document that matches the expression.
</td></tr>

<tr>
<td>FIRST_ORDERED_NODE_TYPE
</td><td>9
</td><td>A result set containing the first node in the document that matches the expression.
</td></tr>
</tbody></table>
<p>Results of <code>NODE_ITERATOR</code> types contain references to nodes in the document. Modifying a node will invalidate the iterator. After modifying a node, attempting to iterate through the results will result in an error.
</p><p>Results of <code>NODE_SNAPSHOT</code> types contain snapshots, or <i>copies</i> of nodes in the document.  These nodes can be modified, but modifying them does not modify the document.
</p>
Revert to this revision