/usr/share/doc/libjdom1-java/api/org/jdom/xpath/XPath.html is in libjdom1-java-doc 1.1.3-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.6.0_27) on Tue Jul 30 04:06:35 UTC 2013 -->
<title>XPath (JDOM v1.SNAPSHOT)</title>
<meta name="date" content="2013-07-30">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XPath (JDOM v1.SNAPSHOT)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>1.SNAPSHOT</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV CLASS</li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom/xpath/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><a href="#field_summary">FIELD</a> | </li>
<li><a href="#constructor_summary">CONSTR</a> | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li><a href="#field_detail">FIELD</a> | </li>
<li><a href="#constructor_detail">CONSTR</a> | </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">
<p class="subTitle">org.jdom.xpath</p>
<h2 title="Class XPath" class="title">Class XPath</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdom.xpath.XPath</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public abstract class <strong>XPath</strong>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A utility class for performing XPath calls on JDOM nodes, with a factory
interface for obtaining a first XPath instance. Users operate against this
class while XPath vendors can plug-in implementations underneath. Users
can choose an implementation using either <a href="../../../org/jdom/xpath/XPath.html#setXPathClass(java.lang.Class)"><code>setXPathClass(java.lang.Class)</code></a> or
the system property "org.jdom.xpath.class".</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.17 $, $Date: 2007/11/10 05:29:02 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Laurent Bihanic</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.jdom.xpath.XPath">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#JDOM_OBJECT_MODEL_URI">JDOM_OBJECT_MODEL_URI</a></strong></code>
<div class="block">The string passable to the JAXP 1.3 XPathFactory isObjectModelSupported()
method to query an XPath engine regarding its support for JDOM.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdom/xpath/XPath.html#XPath()">XPath</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#addNamespace(org.jdom.Namespace)">addNamespace</a></strong>(<a href="../../../org/jdom/Namespace.html" title="class in org.jdom">Namespace</a> namespace)</code>
<div class="block">Adds a namespace definition to the list of namespaces known of
this XPath expression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#addNamespace(java.lang.String, java.lang.String)">addNamespace</a></strong>(java.lang.String prefix,
java.lang.String uri)</code>
<div class="block">Adds a namespace definition (prefix and URI) to the list of
namespaces known of this XPath expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#getXPath()">getXPath</a></strong>()</code>
<div class="block">Returns the wrapped XPath expression as a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/jdom/xpath/XPath.html" title="class in org.jdom.xpath">XPath</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#newInstance(java.lang.String)">newInstance</a></strong>(java.lang.String path)</code>
<div class="block">Creates a new XPath wrapper object, compiling the specified
XPath expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract java.lang.Number</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#numberValueOf(java.lang.Object)">numberValueOf</a></strong>(java.lang.Object context)</code>
<div class="block">Returns the number value of the first node selected by applying
the wrapped XPath expression to the given context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#selectNodes(java.lang.Object)">selectNodes</a></strong>(java.lang.Object context)</code>
<div class="block">Evaluates the wrapped XPath expression and returns the list
of selected items.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#selectNodes(java.lang.Object, java.lang.String)">selectNodes</a></strong>(java.lang.Object context,
java.lang.String path)</code>
<div class="block">Evaluates an XPath expression and returns the list of selected
items.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#selectSingleNode(java.lang.Object)">selectSingleNode</a></strong>(java.lang.Object context)</code>
<div class="block">Evaluates the wrapped XPath expression and returns the first
entry in the list of selected nodes (or atomics).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#selectSingleNode(java.lang.Object, java.lang.String)">selectSingleNode</a></strong>(java.lang.Object context,
java.lang.String path)</code>
<div class="block">Evaluates the wrapped XPath expression and returns the first
entry in the list of selected nodes (or atomics).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#setVariable(java.lang.String, java.lang.Object)">setVariable</a></strong>(java.lang.String name,
java.lang.Object value)</code>
<div class="block">Defines an XPath variable and sets its value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#setXPathClass(java.lang.Class)">setXPathClass</a></strong>(java.lang.Class aClass)</code>
<div class="block">Sets the concrete XPath subclass to use when allocating XPath
instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#valueOf(java.lang.Object)">valueOf</a></strong>(java.lang.Object context)</code>
<div class="block">Returns the string value of the first node selected by applying
the wrapped XPath expression to the given context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom/xpath/XPath.html#writeReplace()">writeReplace</a></strong>()</code>
<div class="block"><i>[Serialization support]</i> Returns the alternative object
to write to the stream when serializing this object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JDOM_OBJECT_MODEL_URI">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JDOM_OBJECT_MODEL_URI</h4>
<pre>public static final java.lang.String JDOM_OBJECT_MODEL_URI</pre>
<div class="block">The string passable to the JAXP 1.3 XPathFactory isObjectModelSupported()
method to query an XPath engine regarding its support for JDOM. Defined
to be the well-known URI "http://jdom.org/jaxp/xpath/jdom".</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.jdom.xpath.XPath.JDOM_OBJECT_MODEL_URI">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XPath()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XPath</h4>
<pre>public XPath()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newInstance(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre>public static <a href="../../../org/jdom/xpath/XPath.html" title="class in org.jdom.xpath">XPath</a> newInstance(java.lang.String path)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Creates a new XPath wrapper object, compiling the specified
XPath expression.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the XPath expression to wrap.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if the XPath expression is invalid.</dd></dl>
</li>
</ul>
<a name="setXPathClass(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXPathClass</h4>
<pre>public static void setXPathClass(java.lang.Class aClass)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Sets the concrete XPath subclass to use when allocating XPath
instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aClass</code> - the concrete subclass of XPath.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>aClass</code> is
<code>null</code>.</dd>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if <code>aClass</code> is
not a concrete subclass
of XPath.</dd></dl>
</li>
</ul>
<a name="selectNodes(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>public abstract java.util.List selectNodes(java.lang.Object context)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Evaluates the wrapped XPath expression and returns the list
of selected items.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the node to use as context for evaluating
the XPath expression.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of selected items, which may be of types: <a href="../../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a>,
<a href="../../../org/jdom/Attribute.html" title="class in org.jdom"><code>Attribute</code></a>, <a href="../../../org/jdom/Text.html" title="class in org.jdom"><code>Text</code></a>, <a href="../../../org/jdom/CDATA.html" title="class in org.jdom"><code>CDATA</code></a>,
<a href="../../../org/jdom/Comment.html" title="class in org.jdom"><code>Comment</code></a>, <a href="../../../org/jdom/ProcessingInstruction.html" title="class in org.jdom"><code>ProcessingInstruction</code></a>, Boolean,
Double, or String.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if the evaluation of the XPath
expression on the specified context
failed.</dd></dl>
</li>
</ul>
<a name="selectSingleNode(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectSingleNode</h4>
<pre>public abstract java.lang.Object selectSingleNode(java.lang.Object context)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Evaluates the wrapped XPath expression and returns the first
entry in the list of selected nodes (or atomics).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the node to use as context for evaluating
the XPath expression.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the first selected item, which may be of types: <a href="../../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a>,
<a href="../../../org/jdom/Attribute.html" title="class in org.jdom"><code>Attribute</code></a>, <a href="../../../org/jdom/Text.html" title="class in org.jdom"><code>Text</code></a>, <a href="../../../org/jdom/CDATA.html" title="class in org.jdom"><code>CDATA</code></a>,
<a href="../../../org/jdom/Comment.html" title="class in org.jdom"><code>Comment</code></a>, <a href="../../../org/jdom/ProcessingInstruction.html" title="class in org.jdom"><code>ProcessingInstruction</code></a>, Boolean,
Double, String, or <code>null</code> if no item was selected.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if the evaluation of the XPath
expression on the specified context
failed.</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public abstract java.lang.String valueOf(java.lang.Object context)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Returns the string value of the first node selected by applying
the wrapped XPath expression to the given context.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the element to use as context for evaluating
the XPath expression.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the string value of the first node selected by applying
the wrapped XPath expression to the given context.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if the XPath expression is invalid or
its evaluation on the specified context
failed.</dd></dl>
</li>
</ul>
<a name="numberValueOf(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numberValueOf</h4>
<pre>public abstract java.lang.Number numberValueOf(java.lang.Object context)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Returns the number value of the first node selected by applying
the wrapped XPath expression to the given context.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the element to use as context for evaluating
the XPath expression.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number value of the first node selected by applying
the wrapped XPath expression to the given context,
<code>null</code> if no node was selected or the
special value <code>Double.NaN</code>
(Not-a-Number) if the selected value can not be
converted into a number value.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if the XPath expression is invalid or
its evaluation on the specified context
failed.</dd></dl>
</li>
</ul>
<a name="setVariable(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVariable</h4>
<pre>public abstract void setVariable(java.lang.String name,
java.lang.Object value)</pre>
<div class="block">Defines an XPath variable and sets its value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the variable name.</dd><dd><code>value</code> - the variable value.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>name</code> is not
a valid XPath variable name
or if the value type is not
supported by the underlying
implementation</dd></dl>
</li>
</ul>
<a name="addNamespace(org.jdom.Namespace)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNamespace</h4>
<pre>public abstract void addNamespace(<a href="../../../org/jdom/Namespace.html" title="class in org.jdom">Namespace</a> namespace)</pre>
<div class="block">Adds a namespace definition to the list of namespaces known of
this XPath expression.
<p>
<strong>Note</strong>: In XPath, there is no such thing as a
'default namespace'. The empty prefix <b>always</b> resolves
to the empty namespace URI.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>namespace</code> - the namespace.</dd></dl>
</li>
</ul>
<a name="addNamespace(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNamespace</h4>
<pre>public void addNamespace(java.lang.String prefix,
java.lang.String uri)</pre>
<div class="block">Adds a namespace definition (prefix and URI) to the list of
namespaces known of this XPath expression.
<p>
<strong>Note</strong>: In XPath, there is no such thing as a
'default namespace'. The empty prefix <b>always</b> resolves
to the empty namespace URI.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - the namespace prefix.</dd><dd><code>uri</code> - the namespace URI.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/IllegalNameException.html" title="class in org.jdom">IllegalNameException</a></code> - if the prefix or uri are null or
empty strings or if they contain
illegal characters.</dd></dl>
</li>
</ul>
<a name="getXPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXPath</h4>
<pre>public abstract java.lang.String getXPath()</pre>
<div class="block">Returns the wrapped XPath expression as a string.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the wrapped XPath expression as a string.</dd></dl>
</li>
</ul>
<a name="selectNodes(java.lang.Object, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>public static java.util.List selectNodes(java.lang.Object context,
java.lang.String path)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Evaluates an XPath expression and returns the list of selected
items.
<p>
<strong>Note</strong>: This method should not be used when the
same XPath expression needs to be applied several times (on the
same or different contexts) as it requires the expression to be
compiled before being evaluated. In such cases,
<a href="../../../org/jdom/xpath/XPath.html#newInstance(java.lang.String)"><code>allocating</code></a> an XPath wrapper instance and
<a href="../../../org/jdom/xpath/XPath.html#selectNodes(java.lang.Object)"><code>evaluating</code></a> it several
times is way more efficient.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the node to use as context for evaluating
the XPath expression.</dd><dd><code>path</code> - the XPath expression to evaluate.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of selected items, which may be of types: <a href="../../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a>,
<a href="../../../org/jdom/Attribute.html" title="class in org.jdom"><code>Attribute</code></a>, <a href="../../../org/jdom/Text.html" title="class in org.jdom"><code>Text</code></a>, <a href="../../../org/jdom/CDATA.html" title="class in org.jdom"><code>CDATA</code></a>,
<a href="../../../org/jdom/Comment.html" title="class in org.jdom"><code>Comment</code></a>, <a href="../../../org/jdom/ProcessingInstruction.html" title="class in org.jdom"><code>ProcessingInstruction</code></a>, Boolean,
Double, or String.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if the XPath expression is invalid or
its evaluation on the specified context
failed.</dd></dl>
</li>
</ul>
<a name="selectSingleNode(java.lang.Object, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectSingleNode</h4>
<pre>public static java.lang.Object selectSingleNode(java.lang.Object context,
java.lang.String path)
throws <a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></pre>
<div class="block">Evaluates the wrapped XPath expression and returns the first
entry in the list of selected nodes (or atomics).
<p>
<strong>Note</strong>: This method should not be used when the
same XPath expression needs to be applied several times (on the
same or different contexts) as it requires the expression to be
compiled before being evaluated. In such cases,
<a href="../../../org/jdom/xpath/XPath.html#newInstance(java.lang.String)"><code>allocating</code></a> an XPath wrapper instance and
<a href="../../../org/jdom/xpath/XPath.html#selectSingleNode(java.lang.Object)"><code>evaluating</code></a> it
several times is way more efficient.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the element to use as context for evaluating
the XPath expression.</dd><dd><code>path</code> - the XPath expression to evaluate.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the first selected item, which may be of types: <a href="../../../org/jdom/Element.html" title="class in org.jdom"><code>Element</code></a>,
<a href="../../../org/jdom/Attribute.html" title="class in org.jdom"><code>Attribute</code></a>, <a href="../../../org/jdom/Text.html" title="class in org.jdom"><code>Text</code></a>, <a href="../../../org/jdom/CDATA.html" title="class in org.jdom"><code>CDATA</code></a>,
<a href="../../../org/jdom/Comment.html" title="class in org.jdom"><code>Comment</code></a>, <a href="../../../org/jdom/ProcessingInstruction.html" title="class in org.jdom"><code>ProcessingInstruction</code></a>, Boolean,
Double, String, or <code>null</code> if no item was selected.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/jdom/JDOMException.html" title="class in org.jdom">JDOMException</a></code> - if the XPath expression is invalid or
its evaluation on the specified context
failed.</dd></dl>
</li>
</ul>
<a name="writeReplace()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writeReplace</h4>
<pre>protected final java.lang.Object writeReplace()
throws java.io.ObjectStreamException</pre>
<div class="block"><i>[Serialization support]</i> Returns the alternative object
to write to the stream when serializing this object. This
method returns an instance of a dedicated nested class to
serialize XPath expressions independently of the concrete
implementation being used.
<p>
<strong>Note</strong>: Subclasses are not allowed to override
this method to ensure valid serialization of all
implementations.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an XPathString instance configured with the wrapped
XPath expression.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.ObjectStreamException</code> - never.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>1.SNAPSHOT</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV CLASS</li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom/xpath/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><a href="#field_summary">FIELD</a> | </li>
<li><a href="#constructor_summary">CONSTR</a> | </li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL: </li>
<li><a href="#field_detail">FIELD</a> | </li>
<li><a href="#constructor_detail">CONSTR</a> | </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 ? 2011 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|