/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/Node.html is in libjenkins-dom4j-java-doc 1.6.1-jenkins-4-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 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 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 | <!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.7.0_65) on Thu Sep 11 11:01:38 UTC 2014 -->
<title>Node (dom4j API)</title>
<meta name="date" content="2014-09-11">
<link rel="stylesheet" type="text/css" href="../../javadoc.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Node (dom4j API)";
}
//-->
</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/Node.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/dom4j/Namespace.html" title="class in org.dom4j"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/dom4j/NodeFilter.html" title="interface in org.dom4j"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/dom4j/Node.html" target="_top">Frames</a></li>
<li><a href="Node.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>Constr | </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>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.dom4j</div>
<h2 title="Interface Node" class="title">Interface Node</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../org/dom4j/Attribute.html" title="interface in org.dom4j">Attribute</a>, <a href="../../org/dom4j/Branch.html" title="interface in org.dom4j">Branch</a>, <a href="../../org/dom4j/CDATA.html" title="interface in org.dom4j">CDATA</a>, <a href="../../org/dom4j/CharacterData.html" title="interface in org.dom4j">CharacterData</a>, <a href="../../org/dom4j/Comment.html" title="interface in org.dom4j">Comment</a>, <a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a>, <a href="../../org/dom4j/DocumentType.html" title="interface in org.dom4j">DocumentType</a>, <a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a>, <a href="../../org/dom4j/Entity.html" title="interface in org.dom4j">Entity</a>, <a href="../../org/dom4j/ProcessingInstruction.html" title="interface in org.dom4j">ProcessingInstruction</a>, <a href="../../org/dom4j/Text.html" title="interface in org.dom4j">Text</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd>org.dom4j.tree.AbstractAttribute, org.dom4j.tree.AbstractBranch, org.dom4j.tree.AbstractElement, org.dom4j.tree.AbstractNode, org.dom4j.tree.BaseElement, <a href="../../org/dom4j/datatype/DatatypeAttribute.html" title="class in org.dom4j.datatype">DatatypeAttribute</a>, <a href="../../org/dom4j/datatype/DatatypeElement.html" title="class in org.dom4j.datatype">DatatypeElement</a>, org.dom4j.tree.DefaultAttribute, org.dom4j.tree.DefaultElement, org.dom4j.tree.FlyweightAttribute, <a href="../../org/dom4j/util/IndexedElement.html" title="class in org.dom4j.util">IndexedElement</a>, <a href="../../org/dom4j/Namespace.html" title="class in org.dom4j">Namespace</a>, <a href="../../org/dom4j/util/NonLazyElement.html" title="class in org.dom4j.util">NonLazyElement</a>, <a href="../../org/dom4j/util/UserDataAttribute.html" title="class in org.dom4j.util">UserDataAttribute</a>, <a href="../../org/dom4j/util/UserDataElement.html" title="class in org.dom4j.util">UserDataElement</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Node</span>
extends java.lang.Cloneable</pre>
<div class="block"><p>
<code>Node</code> defines the polymorphic behavior for all XML nodes in a
dom4j tree.
</p>
<p>
A node can be output as its XML format, can be detached from its position in
a document and can have XPath expressions evaluated on itself.
</p>
<p>
A node may optionally support the parent relationship and may be read only.
</p></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.31 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:jstrachan@apache.org">James Strachan </a></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../org/dom4j/Node.html#supportsParent()"><code>supportsParent()</code></a>,
<a href="../../org/dom4j/Node.html#isReadOnly()"><code>isReadOnly()</code></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 short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#ANY_NODE">ANY_NODE</a></strong></code>
<div class="block">Matches Element nodes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#ATTRIBUTE_NODE">ATTRIBUTE_NODE</a></strong></code>
<div class="block">Matches elements nodes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#CDATA_SECTION_NODE">CDATA_SECTION_NODE</a></strong></code>
<div class="block">Matches elements nodes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#COMMENT_NODE">COMMENT_NODE</a></strong></code>
<div class="block">Matches Comments nodes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#DOCUMENT_NODE">DOCUMENT_NODE</a></strong></code>
<div class="block">Matches Document nodes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#DOCUMENT_TYPE_NODE">DOCUMENT_TYPE_NODE</a></strong></code>
<div class="block">Matches DocumentType nodes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#ELEMENT_NODE">ELEMENT_NODE</a></strong></code>
<div class="block">Matches Element nodes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#ENTITY_REFERENCE_NODE">ENTITY_REFERENCE_NODE</a></strong></code>
<div class="block">Matches elements nodes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#MAX_NODE_TYPE">MAX_NODE_TYPE</a></strong></code>
<div class="block">The maximum number of node types for sizing purposes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#NAMESPACE_NODE">NAMESPACE_NODE</a></strong></code>
<div class="block">Matchs a Namespace Node - NOTE this differs from DOM</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#PROCESSING_INSTRUCTION_NODE">PROCESSING_INSTRUCTION_NODE</a></strong></code>
<div class="block">Matches ProcessingInstruction</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#TEXT_NODE">TEXT_NODE</a></strong></code>
<div class="block">Matches elements nodes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#UNKNOWN_NODE">UNKNOWN_NODE</a></strong></code>
<div class="block">Does not match any valid node</div>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#accept(org.dom4j.Visitor)">accept</a></strong>(<a href="../../org/dom4j/Visitor.html" title="interface in org.dom4j">Visitor</a> visitor)</code>
<div class="block">
<code>accept</code> is the method used in the Visitor Pattern.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#asXML()">asXML</a></strong>()</code>
<div class="block">
<code>asXML</code> returns the textual XML representation of this node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#asXPathResult(org.dom4j.Element)">asXPathResult</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> parent)</code>
<div class="block">
<code>asXPathResult</code> returns a version of this node which is
capable of being an XPath result.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#clone()">clone</a></strong>()</code>
<div class="block">
<code>clone</code> will return a deep clone or if this node is
read-only then clone will return the same instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/XPath.html" title="interface in org.dom4j">XPath</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#createXPath(java.lang.String)">createXPath</a></strong>(java.lang.String xpathExpression)</code>
<div class="block">
<code>createXPath</code> creates an XPath object for the given
xpathExpression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#detach()">detach</a></strong>()</code>
<div class="block">
Removes this node from its parent if there is one.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getDocument()">getDocument</a></strong>()</code>
<div class="block">
<code>getDocument</code> returns the <code>Document</code> that this
<code>Node</code> is part of if this node supports the parent
relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getName()">getName</a></strong>()</code>
<div class="block">
<code>getName</code> returns the name of this node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getNodeType()">getNodeType</a></strong>()</code>
<div class="block">Returns the code according to the type of node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getNodeTypeName()">getNodeTypeName</a></strong>()</code>
<div class="block">DOCUMENT ME!</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getParent()">getParent</a></strong>()</code>
<div class="block">
<code>getParent</code> returns the parent <code>Element</code> if
this node supports the parent relationship or null if it is the root
element or does not support the parent relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getPath()">getPath</a></strong>()</code>
<div class="block">
Returns the XPath expression which will return a node set containing the
given node such as /a/b/@c.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getPath(org.dom4j.Element)">getPath</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> context)</code>
<div class="block">Returns the relative XPath expression which will return a node set
containing the given node such as a/b/@c.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getStringValue()">getStringValue</a></strong>()</code>
<div class="block">Returns the XPath string-value of this node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getText()">getText</a></strong>()</code>
<div class="block">
Returns the text of this node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getUniquePath()">getUniquePath</a></strong>()</code>
<div class="block">
Returns the XPath expression which will return a nodeset of one node
which is the current node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#getUniquePath(org.dom4j.Element)">getUniquePath</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> context)</code>
<div class="block">
Returns the relative unique XPath expression from the given context which
will return a nodeset of one node which is the current node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#hasContent()">hasContent</a></strong>()</code>
<div class="block">
<code>hasContent</code> returns true if this node is a Branch (either
an Element or a Document) and it contains at least one content node such
as a child Element or Text node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#isReadOnly()">isReadOnly</a></strong>()</code>
<div class="block">
<code>isReadOnly</code> returns true if this node is read only and
cannot be modified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#matches(java.lang.String)">matches</a></strong>(java.lang.String xpathExpression)</code>
<div class="block">
<code>matches</code> returns true if evaluating the given XPath
expression on this node returns a non-empty node set containing this
node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Number</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#numberValueOf(java.lang.String)">numberValueOf</a></strong>(java.lang.String xpathExpression)</code>
<div class="block">
<code>numberValueOf</code> evaluates an XPath expression and returns
the numeric value of the XPath expression if the XPath expression results
in a number, or null if the result is not a number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#selectNodes(java.lang.String)">selectNodes</a></strong>(java.lang.String xpathExpression)</code>
<div class="block">
<code>selectNodes</code> evaluates an XPath expression and returns the
result as a <code>List</code> of <code>Node</code> instances or
<code>String</code> instances depending on the XPath expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#selectNodes(java.lang.String,%20java.lang.String)">selectNodes</a></strong>(java.lang.String xpathExpression,
java.lang.String comparisonXPathExpression)</code>
<div class="block">
<code>selectNodes</code> evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
<code>List</code> of <code>Node</code> instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#selectNodes(java.lang.String,%20java.lang.String,%20boolean)">selectNodes</a></strong>(java.lang.String xpathExpression,
java.lang.String comparisonXPathExpression,
boolean removeDuplicates)</code>
<div class="block">
<code>selectNodes</code> evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
<code>List</code> of <code>Node</code> instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#selectObject(java.lang.String)">selectObject</a></strong>(java.lang.String xpathExpression)</code>
<div class="block">
<code>selectObject</code> evaluates an XPath expression and returns the
result as an <code>Object</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#selectSingleNode(java.lang.String)">selectSingleNode</a></strong>(java.lang.String xpathExpression)</code>
<div class="block">
<code>selectSingleNode</code> evaluates an XPath expression and returns
the result as a single <code>Node</code> instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#setDocument(org.dom4j.Document)">setDocument</a></strong>(<a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> document)</code>
<div class="block">
<code>setDocument</code> sets the document of this node if the parent
relationship is supported or does nothing if the parent relationship is
not supported.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code>
<div class="block">
Sets the text data of this node or this method will throw an
<code>UnsupportedOperationException</code> if it is read-only.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#setParent(org.dom4j.Element)">setParent</a></strong>(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> parent)</code>
<div class="block">
<code>setParent</code> sets the parent relationship of this node if the
parent relationship is supported or does nothing if the parent
relationship is not supported.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#setText(java.lang.String)">setText</a></strong>(java.lang.String text)</code>
<div class="block">
Sets the text data of this node or this method will throw an
<code>UnsupportedOperationException</code> if it is read-only.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#supportsParent()">supportsParent</a></strong>()</code>
<div class="block">
<code>supportsParent</code> returns true if this node supports the
parent relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String xpathExpression)</code>
<div class="block">
<code>valueOf</code> evaluates an XPath expression and returns the
textual representation of the results the XPath string-value of this
node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/dom4j/Node.html#write(java.io.Writer)">write</a></strong>(java.io.Writer writer)</code>
<div class="block">
<code>write</code> writes this node as the default XML notation for
this node.</div>
</td>
</tr>
</table>
</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="ANY_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ANY_NODE</h4>
<pre>static final short ANY_NODE</pre>
<div class="block">Matches Element nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.ANY_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ELEMENT_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELEMENT_NODE</h4>
<pre>static final short ELEMENT_NODE</pre>
<div class="block">Matches Element nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.ELEMENT_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ATTRIBUTE_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTRIBUTE_NODE</h4>
<pre>static final short ATTRIBUTE_NODE</pre>
<div class="block">Matches elements nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.ATTRIBUTE_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TEXT_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT_NODE</h4>
<pre>static final short TEXT_NODE</pre>
<div class="block">Matches elements nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.TEXT_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CDATA_SECTION_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CDATA_SECTION_NODE</h4>
<pre>static final short CDATA_SECTION_NODE</pre>
<div class="block">Matches elements nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.CDATA_SECTION_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ENTITY_REFERENCE_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENTITY_REFERENCE_NODE</h4>
<pre>static final short ENTITY_REFERENCE_NODE</pre>
<div class="block">Matches elements nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.ENTITY_REFERENCE_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PROCESSING_INSTRUCTION_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROCESSING_INSTRUCTION_NODE</h4>
<pre>static final short PROCESSING_INSTRUCTION_NODE</pre>
<div class="block">Matches ProcessingInstruction</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.PROCESSING_INSTRUCTION_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="COMMENT_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMMENT_NODE</h4>
<pre>static final short COMMENT_NODE</pre>
<div class="block">Matches Comments nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.COMMENT_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DOCUMENT_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOCUMENT_NODE</h4>
<pre>static final short DOCUMENT_NODE</pre>
<div class="block">Matches Document nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.DOCUMENT_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DOCUMENT_TYPE_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOCUMENT_TYPE_NODE</h4>
<pre>static final short DOCUMENT_TYPE_NODE</pre>
<div class="block">Matches DocumentType nodes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.DOCUMENT_TYPE_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="NAMESPACE_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NAMESPACE_NODE</h4>
<pre>static final short NAMESPACE_NODE</pre>
<div class="block">Matchs a Namespace Node - NOTE this differs from DOM</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.NAMESPACE_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNKNOWN_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNKNOWN_NODE</h4>
<pre>static final short UNKNOWN_NODE</pre>
<div class="block">Does not match any valid node</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.UNKNOWN_NODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MAX_NODE_TYPE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_NODE_TYPE</h4>
<pre>static final short MAX_NODE_TYPE</pre>
<div class="block">The maximum number of node types for sizing purposes</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#org.dom4j.Node.MAX_NODE_TYPE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="supportsParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsParent</h4>
<pre>boolean supportsParent()</pre>
<div class="block"><p>
<code>supportsParent</code> returns true if this node supports the
parent relationship.
</p>
<p>
Some XML tree implementations are singly linked and only support downward
navigation through children relationships. The default case is that both
parent and children relationships are supported though for memory and
performance reasons the parent relationship may not be supported.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if this node supports the parent relationship or false it is
not supported</dd></dl>
</li>
</ul>
<a name="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre><a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> getParent()</pre>
<div class="block"><p>
<code>getParent</code> returns the parent <code>Element</code> if
this node supports the parent relationship or null if it is the root
element or does not support the parent relationship.
</p>
<p>
This method is an optional feature and may not be supported for all
<code>Node</code> implementations.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the parent of this node or null if it is the root of the tree or
the parent relationship is not supported.</dd></dl>
</li>
</ul>
<a name="setParent(org.dom4j.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParent</h4>
<pre>void setParent(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> parent)</pre>
<div class="block"><p>
<code>setParent</code> sets the parent relationship of this node if the
parent relationship is supported or does nothing if the parent
relationship is not supported.
</p>
<p>
This method should only be called from inside an <code>Element</code>
implementation method and is not intended for general use.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - is the new parent of this node.</dd></dl>
</li>
</ul>
<a name="getDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocument</h4>
<pre><a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> getDocument()</pre>
<div class="block"><p>
<code>getDocument</code> returns the <code>Document</code> that this
<code>Node</code> is part of if this node supports the parent
relationship.
</p>
<p>
This method is an optional feature and may not be supported for all
<code>Node</code> implementations.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the document of this node or null if this feature is not
supported or the node is not associated with a
<code>Document</code></dd></dl>
</li>
</ul>
<a name="setDocument(org.dom4j.Document)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDocument</h4>
<pre>void setDocument(<a href="../../org/dom4j/Document.html" title="interface in org.dom4j">Document</a> document)</pre>
<div class="block"><p>
<code>setDocument</code> sets the document of this node if the parent
relationship is supported or does nothing if the parent relationship is
not supported.
</p>
<p>
This method should only be called from inside a <code>Document</code>
implementation method and is not intended for general use.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>document</code> - is the new document of this node.</dd></dl>
</li>
</ul>
<a name="isReadOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadOnly</h4>
<pre>boolean isReadOnly()</pre>
<div class="block"><p>
<code>isReadOnly</code> returns true if this node is read only and
cannot be modified. Any attempt to modify a read-only <code>Node</code>
will result in an <code>UnsupportedOperationException</code> being
thrown.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if this <code>Node</code> is read only and cannot be
modified otherwise false.</dd></dl>
</li>
</ul>
<a name="hasContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasContent</h4>
<pre>boolean hasContent()</pre>
<div class="block"><p>
<code>hasContent</code> returns true if this node is a Branch (either
an Element or a Document) and it contains at least one content node such
as a child Element or Text node.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if this <code>Node</code> is a Branch with a nodeCount()
of one or more.</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String getName()</pre>
<div class="block"><p>
<code>getName</code> returns the name of this node. This is the XML
local name of the element, attribute, entity or processing instruction.
For CDATA and Text nodes this method will return null.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the XML name of this node</dd></dl>
</li>
</ul>
<a name="setName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>void setName(java.lang.String name)</pre>
<div class="block"><p>
Sets the text data of this node or this method will throw an
<code>UnsupportedOperationException</code> if it is read-only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - is the new name of this node</dd></dl>
</li>
</ul>
<a name="getText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>java.lang.String getText()</pre>
<div class="block"><p>
Returns the text of this node.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the text for this node.</dd></dl>
</li>
</ul>
<a name="setText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setText</h4>
<pre>void setText(java.lang.String text)</pre>
<div class="block"><p>
Sets the text data of this node or this method will throw an
<code>UnsupportedOperationException</code> if it is read-only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - is the new textual value of this node</dd></dl>
</li>
</ul>
<a name="getStringValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringValue</h4>
<pre>java.lang.String getStringValue()</pre>
<div class="block">Returns the XPath string-value of this node. The behaviour of this method
is defined in the <a href="http://www.w3.org/TR/xpath">XPath
specification </a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the text from all the child Text and Element nodes appended
together.</dd></dl>
</li>
</ul>
<a name="getPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre>java.lang.String getPath()</pre>
<div class="block"><p>
Returns the XPath expression which will return a node set containing the
given node such as /a/b/@c. No indexing will be used to restrict the
path if multiple elements with the same name occur on the path.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the XPath expression which will return a nodeset containing at
least this node.</dd></dl>
</li>
</ul>
<a name="getPath(org.dom4j.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre>java.lang.String getPath(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> context)</pre>
<div class="block">Returns the relative XPath expression which will return a node set
containing the given node such as a/b/@c. No indexing will be used to
restrict the path if multiple elements with the same name occur on the
path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - is the parent context from which the relative path should
start. If the context is null or the context is not an
ancestor of this node then the path will be absolute and start
from the document and so begin with the '/' character.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the XPath expression relative to the given context which will
return a nodeset containing at least this node.</dd></dl>
</li>
</ul>
<a name="getUniquePath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUniquePath</h4>
<pre>java.lang.String getUniquePath()</pre>
<div class="block"><p>
Returns the XPath expression which will return a nodeset of one node
which is the current node. This method will use the XPath index operator
to restrict the path if multiple elements with the same name occur on the
path.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the XPath expression which will return a nodeset containing just
this node.</dd></dl>
</li>
</ul>
<a name="getUniquePath(org.dom4j.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUniquePath</h4>
<pre>java.lang.String getUniquePath(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> context)</pre>
<div class="block"><p>
Returns the relative unique XPath expression from the given context which
will return a nodeset of one node which is the current node. This method
will use the XPath index operator to restrict the path if multiple
elements with the same name occur on the path.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - is the parent context from which the path should start. If the
context is null or the context is not an ancestor of this node
then the path will start from the document and so begin with
the '/' character.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the XPath expression relative to the given context which will
return a nodeset containing just this node.</dd></dl>
</li>
</ul>
<a name="asXML()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asXML</h4>
<pre>java.lang.String asXML()</pre>
<div class="block"><p>
<code>asXML</code> returns the textual XML representation of this node.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the XML representation of this node</dd></dl>
</li>
</ul>
<a name="write(java.io.Writer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>void write(java.io.Writer writer)
throws java.io.IOException</pre>
<div class="block"><p>
<code>write</code> writes this node as the default XML notation for
this node. If you wish to control the XML output (such as for pretty
printing, changing the indentation policy etc.) then please use <a href="../../org/dom4j/io/XMLWriter.html" title="class in org.dom4j.io"><code>XMLWriter</code></a> or its derivations.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - is the <code>Writer</code> to output the XML to</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - DOCUMENT ME!</dd></dl>
</li>
</ul>
<a name="getNodeType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeType</h4>
<pre>short getNodeType()</pre>
<div class="block">Returns the code according to the type of node. This makes processing
nodes polymorphically much easier as the switch statement can be used
instead of multiple if (instanceof) statements.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a W3C DOM complient code for the node type such as ELEMENT_NODE
or ATTRIBUTE_NODE</dd></dl>
</li>
</ul>
<a name="getNodeTypeName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeTypeName</h4>
<pre>java.lang.String getNodeTypeName()</pre>
<div class="block">DOCUMENT ME!</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the type of node such as "Document", "Element",
"Attribute" or "Text"</dd></dl>
</li>
</ul>
<a name="detach()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detach</h4>
<pre><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> detach()</pre>
<div class="block"><p>
Removes this node from its parent if there is one. If this node is the
root element of a document then it is removed from the document as well.
</p>
<p>
This method is useful if you want to remove a node from its source
document and add it to another document. For example
</p>
<code> Node node = ...; Element someOtherElement = ...;
someOtherElement.add( node.detach() ); </code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the node that has been removed from its parent node if any and
its document if any.</dd></dl>
</li>
</ul>
<a name="selectNodes(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>java.util.List selectNodes(java.lang.String xpathExpression)</pre>
<div class="block"><p>
<code>selectNodes</code> evaluates an XPath expression and returns the
result as a <code>List</code> of <code>Node</code> instances or
<code>String</code> instances depending on the XPath expression.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of <code>Node</code> or <code>String</code>
instances depending on the XPath expression</dd></dl>
</li>
</ul>
<a name="selectObject(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectObject</h4>
<pre>java.lang.Object selectObject(java.lang.String xpathExpression)</pre>
<div class="block"><p>
<code>selectObject</code> evaluates an XPath expression and returns the
result as an <code>Object</code>. The object returned can either be a <code>List</code> of one or more <a href="../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a>instances or a scalar object like a
<code>String</code>or a <code>Number</code>instance depending on the XPath
expression.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of the XPath expression as a <code>List</code>of <a href="../../org/dom4j/Node.html" title="interface in org.dom4j"><code>Node</code></a> instances, a <code>String</code>or a <code>Number</code>instance
depending on the XPath expression.</dd></dl>
</li>
</ul>
<a name="selectNodes(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>java.util.List selectNodes(java.lang.String xpathExpression,
java.lang.String comparisonXPathExpression)</pre>
<div class="block"><p>
<code>selectNodes</code> evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
<code>List</code> of <code>Node</code> instances.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd><dd><code>comparisonXPathExpression</code> - is the XPath expression used to compare the results by for
sorting</dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of <code>Node</code> instances sorted by the
comparisonXPathExpression</dd></dl>
</li>
</ul>
<a name="selectNodes(java.lang.String, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectNodes</h4>
<pre>java.util.List selectNodes(java.lang.String xpathExpression,
java.lang.String comparisonXPathExpression,
boolean removeDuplicates)</pre>
<div class="block"><p>
<code>selectNodes</code> evaluates an XPath expression then sorts the
results using a secondary XPath expression Returns a sorted
<code>List</code> of <code>Node</code> instances.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd><dd><code>comparisonXPathExpression</code> - is the XPath expression used to compare the results by for
sorting</dd><dd><code>removeDuplicates</code> - if this parameter is true then duplicate values (using the
comparisonXPathExpression) are removed from the result List.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of <code>Node</code> instances sorted by the
comparisonXPathExpression</dd></dl>
</li>
</ul>
<a name="selectSingleNode(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectSingleNode</h4>
<pre><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> selectSingleNode(java.lang.String xpathExpression)</pre>
<div class="block"><p>
<code>selectSingleNode</code> evaluates an XPath expression and returns
the result as a single <code>Node</code> instance.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>Node</code> matching the XPath expression</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>java.lang.String valueOf(java.lang.String xpathExpression)</pre>
<div class="block"><p>
<code>valueOf</code> evaluates an XPath expression and returns the
textual representation of the results the XPath string-value of this
node. The string-value for a given node type is defined in the <a
href="http://www.w3.org/TR/xpath">XPath specification </a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd>
<dt><span class="strong">Returns:</span></dt><dd>the string-value representation of the results of the XPath
expression</dd></dl>
</li>
</ul>
<a name="numberValueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numberValueOf</h4>
<pre>java.lang.Number numberValueOf(java.lang.String xpathExpression)</pre>
<div class="block"><p>
<code>numberValueOf</code> evaluates an XPath expression and returns
the numeric value of the XPath expression if the XPath expression results
in a number, or null if the result is not a number.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd>
<dt><span class="strong">Returns:</span></dt><dd>the numeric result of the XPath expression or null if the result
is not a number.</dd></dl>
</li>
</ul>
<a name="matches(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre>boolean matches(java.lang.String xpathExpression)</pre>
<div class="block"><p>
<code>matches</code> returns true if evaluating the given XPath
expression on this node returns a non-empty node set containing this
node.
</p>
<p>
This method does not behave like the <xsl:if> element - if you want
that behaviour, to evaluate if an XPath expression matches something,
then you can use the following code to be equivalent...
</p>
<code>if ( node.selectSingleNode( "/some/path" ) != nulll )</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is an XPath expression</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this node is returned by the given XPath expression</dd></dl>
</li>
</ul>
<a name="createXPath(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createXPath</h4>
<pre><a href="../../org/dom4j/XPath.html" title="interface in org.dom4j">XPath</a> createXPath(java.lang.String xpathExpression)
throws <a href="../../org/dom4j/InvalidXPathException.html" title="class in org.dom4j">InvalidXPathException</a></pre>
<div class="block"><p>
<code>createXPath</code> creates an XPath object for the given
xpathExpression. The XPath object allows the variable context to be
specified.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xpathExpression</code> - is the XPath expression to be evaluated</dd>
<dt><span class="strong">Returns:</span></dt><dd>an XPath object represeting the given expression</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../org/dom4j/InvalidXPathException.html" title="class in org.dom4j">InvalidXPathException</a></code> - if the XPath expression is invalid</dd></dl>
</li>
</ul>
<a name="asXPathResult(org.dom4j.Element)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asXPathResult</h4>
<pre><a href="../../org/dom4j/Node.html" title="interface in org.dom4j">Node</a> asXPathResult(<a href="../../org/dom4j/Element.html" title="interface in org.dom4j">Element</a> parent)</pre>
<div class="block"><p>
<code>asXPathResult</code> returns a version of this node which is
capable of being an XPath result. The result of an XPath expression
should always support the parent relationship, whether the original XML
tree was singly or doubly linked. If the node does not support the parent
relationship then a new node will be created which is linked to its
parent and returned.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - DOCUMENT ME!</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Node</code> which supports the parent relationship</dd></dl>
</li>
</ul>
<a name="accept(org.dom4j.Visitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre>void accept(<a href="../../org/dom4j/Visitor.html" title="interface in org.dom4j">Visitor</a> visitor)</pre>
<div class="block"><p>
<code>accept</code> is the method used in the Visitor Pattern.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - is the visitor in the Visitor Pattern</dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>java.lang.Object clone()</pre>
<div class="block"><p>
<code>clone</code> will return a deep clone or if this node is
read-only then clone will return the same instance.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a deep clone of myself or myself if I am read only.</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/Node.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/dom4j/Namespace.html" title="class in org.dom4j"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/dom4j/NodeFilter.html" title="interface in org.dom4j"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/dom4j/Node.html" target="_top">Frames</a></li>
<li><a href="Node.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>Constr | </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>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 ? 2005 MetaStuff Ltd. All Rights Reserved. Hosted by <p> <img src='http://sourceforge.net/sflogo.php?group_id=16035' width='88' height='31' border='0' alt='SourceForge Logo' /></small></p>
</body>
</html>
|