/usr/share/doc/libjaxen-java/apidocs/org/jaxen/XPath.html is in libjaxen-java-doc 1.1.6-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XPath (jaxen 1.1.6 API)</title>
<link rel="stylesheet" type="text/css" href="../../javadoc-style.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XPath (jaxen 1.1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XPath.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/jaxen/XPathFunctionContext.html" title="class in org.jaxen"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jaxen/XPath.html" target="_top">Frames</a></li>
<li><a href="XPath.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jaxen</div>
<h2 title="Interface XPath" class="title">Interface XPath</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../org/jaxen/BaseXPath.html" title="class in org.jaxen">BaseXPath</a>, <a href="../../org/jaxen/dom4j/Dom4jXPath.html" title="class in org.jaxen.dom4j">Dom4jXPath</a>, <a href="../../org/jaxen/dom/DOMXPath.html" title="class in org.jaxen.dom">DOMXPath</a>, <a href="../../org/jaxen/javabean/JavaBeanXPath.html" title="class in org.jaxen.javabean">JavaBeanXPath</a>, <a href="../../org/jaxen/jdom/JDOMXPath.html" title="class in org.jaxen.jdom">JDOMXPath</a>, <a href="../../org/jaxen/xom/XOMXPath.html" title="class in org.jaxen.xom">XOMXPath</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">XPath</span></pre>
<div class="block">Represents an XPath 1.0 expression which
can be evaluated against a variety of different XML object models.
<p>
Most of the evaluation methods take a context object. This is typically a
node or node-set object (which is typically a <code>List</code>
of node objects) or a Jaxen <code>Context</code> object.
A null context is allowed, meaning that
there are no XML nodes on which to evaluate.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:bob@eng.werken.com">bob mcwhirter</a>, <a href="mailto:jstrachan@apache.org">James Strachan</a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/dom4j/Dom4jXPath.html" title="class in org.jaxen.dom4j"><code>XPath for dom4j</code></a>,
<a href="../../org/jaxen/jdom/JDOMXPath.html" title="class in org.jaxen.jdom"><code>XPath for JDOM</code></a>,
<a href="../../org/jaxen/dom/DOMXPath.html" title="class in org.jaxen.dom"><code>XPath for W3C DOM</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#addNamespace-java.lang.String-java.lang.String-">addNamespace</a></span>(java.lang.String prefix,
java.lang.String uri)</code>
<div class="block">Add a namespace prefix-to-URI mapping for this XPath
expression.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#booleanValueOf-java.lang.Object-">booleanValueOf</a></span>(java.lang.Object context)</code>
<div class="block">Retrieve the boolean value of the first node in document order
returned by this XPath expression when evaluated in
the given context.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#evaluate-java.lang.Object-">evaluate</a></span>(java.lang.Object context)</code>
<div class="block">Evaluate this XPath against the given context.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../org/jaxen/FunctionContext.html" title="interface in org.jaxen">FunctionContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#getFunctionContext--">getFunctionContext</a></span>()</code>
<div class="block">Retrieve the <code>FunctionContext</code> used by this XPath
expression.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../org/jaxen/NamespaceContext.html" title="interface in org.jaxen">NamespaceContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#getNamespaceContext--">getNamespaceContext</a></span>()</code>
<div class="block">Retrieve the <code>NamespaceContext</code> used by this XPath
expression.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../org/jaxen/Navigator.html" title="interface in org.jaxen">Navigator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#getNavigator--">getNavigator</a></span>()</code>
<div class="block">Retrieve the XML object-model-specific <a href="../../org/jaxen/Navigator.html" title="interface in org.jaxen"><code>Navigator</code></a>
used to evaluate this XPath expression.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen">VariableContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#getVariableContext--">getVariableContext</a></span>()</code>
<div class="block">Retrieve the <code>VariableContext</code> used by this XPath
expression.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Number</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#numberValueOf-java.lang.Object-">numberValueOf</a></span>(java.lang.Object context)</code>
<div class="block">Retrieve the number-value of the first node in document order
returned by this XPath expression when evaluated in
the given context.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#selectNodes-java.lang.Object-">selectNodes</a></span>(java.lang.Object context)</code>
<div class="block">Select all nodes that are selectable by this XPath
expression.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#selectSingleNode-java.lang.Object-">selectSingleNode</a></span>(java.lang.Object context)</code>
<div class="block">
Return the first node in document order that is selected by this
XPath expression.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#setFunctionContext-org.jaxen.FunctionContext-">setFunctionContext</a></span>(<a href="../../org/jaxen/FunctionContext.html" title="interface in org.jaxen">FunctionContext</a> functionContext)</code>
<div class="block">Set a <code>FunctionContext</code> for this XPath
expression.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#setNamespaceContext-org.jaxen.NamespaceContext-">setNamespaceContext</a></span>(<a href="../../org/jaxen/NamespaceContext.html" title="interface in org.jaxen">NamespaceContext</a> namespaceContext)</code>
<div class="block">Set a <code>NamespaceContext</code> for this
XPath expression.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#setVariableContext-org.jaxen.VariableContext-">setVariableContext</a></span>(<a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen">VariableContext</a> variableContext)</code>
<div class="block">Set a <code>VariableContext</code> for this XPath
expression.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#stringValueOf-java.lang.Object-">stringValueOf</a></span>(java.lang.Object context)</code>
<div class="block">Retrieve a string-value interpretation of this XPath
expression when evaluated against the given context.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/jaxen/XPath.html#valueOf-java.lang.Object-">valueOf</a></span>(java.lang.Object context)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">use <a href="../../org/jaxen/XPath.html#stringValueOf-java.lang.Object-"><code>stringValueOf(Object)</code></a> instead</span></div>
</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="evaluate-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>java.lang.Object evaluate(java.lang.Object context)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">Evaluate this XPath against the given context.
<p>
The context of evaluation my be a <em>document</em>,
an <em>element</em>, or a set of <em>elements</em>.
</p>
<p>
If the expression evaluates to an XPath string, number, or boolean
type, then the equivalent Java object type is returned.
Otherwise, if the result is a node-set, then the returned value is a
<code>List</code>.
</p>
<p>
When using this method, one must be careful to
test the class of the returned objects, and of
each of the composite members if a <code>List</code>
is returned. If the returned members are XML nodes,
they will be the actual <code>Document</code>,
<code>Element</code> or <code>Attribute</code> objects
as defined by the concrete XML object-model implementation,
directly from the context document. This method <strong>does not
return <em>copies</em> of anything</strong>. It merely returns
references to nodes within the source document.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the node, node-set or Context object for evaluation.
This value can be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result of evaluating the XPath expression
against the supplied context</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if an error occurs while attempting
to evaluate the expression</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>java.lang.String valueOf(java.lang.Object context)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../org/jaxen/XPath.html#stringValueOf-java.lang.Object-"><code>stringValueOf(Object)</code></a> instead</span></div>
<div class="block">Retrieve a string-value interpretation of this XPath
expression when evaluated against the given context.
<p>
The string-value of the expression is determined per
the <code>string(..)</code> core function as defined
in the XPath specification. This means that an expression
that selects more than one nodes will return the string value
of the first node in the node set..
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the node, node-set or Context object for evaluation.
This value can be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string-value of this expression</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if an error occurs while attempting
to evaluate the expression</dd>
</dl>
</li>
</ul>
<a name="stringValueOf-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringValueOf</h4>
<pre>java.lang.String stringValueOf(java.lang.Object context)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">Retrieve a string-value interpretation of this XPath
expression when evaluated against the given context.
<p>
The string-value of the expression is determined per
the <code>string(..)</code> core function as defined
in the XPath specification. This means that an expression
that selects more than one nodes will return the string value
of the first node in the node set..
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the node, node-set or Context object for evaluation.
This value can be null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string-value interpretation of this expression</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if an error occurs while attempting
to evaluate the expression</dd>
</dl>
</li>
</ul>
<a name="booleanValueOf-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>booleanValueOf</h4>
<pre>boolean booleanValueOf(java.lang.Object context)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">Retrieve the boolean value of the first node in document order
returned by this XPath expression when evaluated in
the given context.
<p>
The boolean-value of the expression is determined per
the <code>boolean()</code> function defined
in the XPath specification. This means that an expression
that selects zero nodes will return <code>false</code>,
while an expression that selects one or more nodes will
return <code>true</code>. An expression that returns a string
returns false for empty strings and true for all other strings.
An expression that returns a number
returns false for zero and true for non-zero numbers.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the node, node-set or Context object for evaluation. This value can be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the boolean-value of this expression</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if an error occurs while attempting
to evaluate the expression</dd>
</dl>
</li>
</ul>
<a name="numberValueOf-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numberValueOf</h4>
<pre>java.lang.Number numberValueOf(java.lang.Object context)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">Retrieve the number-value of the first node in document order
returned by this XPath expression when evaluated in
the given context.
<p>
The number-value of the expression is determined per
the <code>number(..)</code> core function as defined
in the XPath specification. This means that if this
expression selects multiple nodes, the number-value
of the first node is returned.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the node, node-set or Context object for evaluation. This value can be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number-value interpretation of this expression</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if an error occurs while attempting
to evaluate the expression</dd>
</dl>
</li>
</ul>
<a name="selectNodes-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>java.util.List selectNodes(java.lang.Object context)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">Select all nodes that are selectable by this XPath
expression. If multiple nodes match, multiple nodes
will be returned.
<p>
<strong>NOTE:</strong> In most cases, nodes will be returned
in document-order, as defined by the XML Canonicalization
specification. The exception occurs when using XPath
expressions involving the <code>union</code> operator
(denoted with the pipe '|' character).
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the node, node-set or Context object for evaluation.
This value can be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the node-set of all items selected
by this XPath expression.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if an error occurs while attempting
to evaluate the expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/XPath.html#selectSingleNode-java.lang.Object-"><code>selectSingleNode(java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="selectSingleNode-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectSingleNode</h4>
<pre>java.lang.Object selectSingleNode(java.lang.Object context)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block"><p>
Return the first node in document order that is selected by this
XPath expression.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the node, node-set or Context object for evaluation.
This value can be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the first node in document order selected by this XPath expression</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if an error occurs while attempting
to evaluate the expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/XPath.html#selectNodes-java.lang.Object-"><code>selectNodes(java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="addNamespace-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNamespace</h4>
<pre>void addNamespace(java.lang.String prefix,
java.lang.String uri)
throws <a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">Add a namespace prefix-to-URI mapping for this XPath
expression.
<p>
Namespace prefix-to-URI mappings in an XPath are independent
of those used within any document. Only the mapping explicitly
added to this XPath will be available for resolving the
XPath expression.
</p>
<p>
This is a convenience method for adding mappings to the
default <a href="../../org/jaxen/NamespaceContext.html" title="interface in org.jaxen"><code>NamespaceContext</code></a> in place for this XPath.
If you have installed a specific custom <code>NamespaceContext</code>,
then this method will throw a <code>JaxenException</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefix</code> - the namespace prefix</dd>
<dd><code>uri</code> - the namespace URI</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code> - if a <code>NamespaceContext</code>
used by this XPath has been explicitly installed</dd>
</dl>
</li>
</ul>
<a name="setNamespaceContext-org.jaxen.NamespaceContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNamespaceContext</h4>
<pre>void setNamespaceContext(<a href="../../org/jaxen/NamespaceContext.html" title="interface in org.jaxen">NamespaceContext</a> namespaceContext)</pre>
<div class="block">Set a <code>NamespaceContext</code> for this
XPath expression.
<p>
A <code>NamespaceContext</code> is responsible for translating
namespace prefixes within the expression into namespace URIs.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>namespaceContext</code> - the <code>NamespaceContext</code> to
install for this expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/NamespaceContext.html" title="interface in org.jaxen"><code>NamespaceContext</code></a>,
<a href="../../org/jaxen/NamespaceContext.html#translateNamespacePrefixToUri-java.lang.String-"><code>NamespaceContext.translateNamespacePrefixToUri(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="setFunctionContext-org.jaxen.FunctionContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFunctionContext</h4>
<pre>void setFunctionContext(<a href="../../org/jaxen/FunctionContext.html" title="interface in org.jaxen">FunctionContext</a> functionContext)</pre>
<div class="block">Set a <code>FunctionContext</code> for this XPath
expression.
<p>
A <code>FunctionContext</code> is responsible for resolving
all function calls used within the expression.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>functionContext</code> - the <code>FunctionContext</code> to
install for this expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/FunctionContext.html" title="interface in org.jaxen"><code>FunctionContext</code></a>,
<a href="../../org/jaxen/FunctionContext.html#getFunction-java.lang.String-java.lang.String-java.lang.String-"><code>FunctionContext.getFunction(java.lang.String, java.lang.String, java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="setVariableContext-org.jaxen.VariableContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVariableContext</h4>
<pre>void setVariableContext(<a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen">VariableContext</a> variableContext)</pre>
<div class="block">Set a <code>VariableContext</code> for this XPath
expression.
<p>
A <code>VariableContext</code> is responsible for resolving
all variables referenced within the expression.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableContext</code> - the <code>VariableContext</code> to
install for this expression.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen"><code>VariableContext</code></a>,
<a href="../../org/jaxen/VariableContext.html#getVariableValue-java.lang.String-java.lang.String-java.lang.String-"><code>VariableContext.getVariableValue(java.lang.String, java.lang.String, java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getNamespaceContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespaceContext</h4>
<pre><a href="../../org/jaxen/NamespaceContext.html" title="interface in org.jaxen">NamespaceContext</a> getNamespaceContext()</pre>
<div class="block">Retrieve the <code>NamespaceContext</code> used by this XPath
expression.
<p>
A <code>FunctionContext</code> is responsible for resolving
all function calls used within the expression.
</p>
<p>
If this XPath expression has not previously had a <code>NamespaceContext</code>
installed, a new default <code>NamespaceContext</code> will be created,
installed and returned.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>NamespaceContext</code> used by this expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/NamespaceContext.html" title="interface in org.jaxen"><code>NamespaceContext</code></a></dd>
</dl>
</li>
</ul>
<a name="getFunctionContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctionContext</h4>
<pre><a href="../../org/jaxen/FunctionContext.html" title="interface in org.jaxen">FunctionContext</a> getFunctionContext()</pre>
<div class="block">Retrieve the <code>FunctionContext</code> used by this XPath
expression.
<p>
A <code>FunctionContext</code> is responsible for resolving
all function calls used within the expression.
</p>
<p>
If this XPath expression has not previously had a <code>FunctionContext</code>
installed, a new default <code>FunctionContext</code> will be created,
installed and returned.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>FunctionContext</code> used by this expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/FunctionContext.html" title="interface in org.jaxen"><code>FunctionContext</code></a></dd>
</dl>
</li>
</ul>
<a name="getVariableContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariableContext</h4>
<pre><a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen">VariableContext</a> getVariableContext()</pre>
<div class="block">Retrieve the <code>VariableContext</code> used by this XPath
expression.
<p>
A <code>VariableContext</code> is responsible for resolving
all variables referenced within the expression.
</p>
<p>
If this XPath expression has not previously had a <code>VariableContext</code>
installed, a new default <code>VariableContext</code> will be created,
installed and returned.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>VariableContext</code> used by this expression</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen"><code>VariableContext</code></a></dd>
</dl>
</li>
</ul>
<a name="getNavigator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNavigator</h4>
<pre><a href="../../org/jaxen/Navigator.html" title="interface in org.jaxen">Navigator</a> getNavigator()</pre>
<div class="block">Retrieve the XML object-model-specific <a href="../../org/jaxen/Navigator.html" title="interface in org.jaxen"><code>Navigator</code></a>
used to evaluate this XPath expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the implementation-specific <code>Navigator</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XPath.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/jaxen/VariableContext.html" title="interface in org.jaxen"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../org/jaxen/XPathFunctionContext.html" title="class in org.jaxen"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/jaxen/XPath.html" target="_top">Frames</a></li>
<li><a href="XPath.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2001–2018 <a href="http://codehaus.org">Codehaus</a>. All rights reserved.</small></p>
</body>
</html>
|