/usr/share/doc/libeigenbase-resgen-java/api/org/eigenbase/xom/DOMElementParser.html is in libeigenbase-resgen-java-doc 1.3.0.13768-4.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>DOMElementParser</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.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="DOMElementParser";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":9,"i21":10,"i22":10,"i23":10,"i24":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="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/eigenbase/xom/DefWalker.html" title="class in org.eigenbase.xom"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eigenbase/xom/DOMElementParser.html" target="_top">Frames</a></li>
<li><a href="DOMElementParser.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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">
<div class="subTitle">org.eigenbase.xom</div>
<h2 title="Class DOMElementParser" class="title">Class DOMElementParser</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eigenbase.xom.DOMElementParser</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DOMElementParser</span>
extends java.lang.Object</pre>
<div class="block">DOMElementParser is a utility wrapper around DOMWrapper.
Implements a parseable stream of child DOMWrappers and also provides
validation on an XML document beyond the DTD.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#DOMElementParser-org.eigenbase.xom.DOMWrapper-java.lang.String-java.lang.Class-">DOMElementParser</a></span>(<a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a> wrapper,
java.lang.String prefix,
java.lang.Class enclosure)</code>
<div class="block">Constructs a new ElementParser based on an Element of the XML parse
tree wrapped in a DOMWrapper, and a prefix (to be applied to all element
tags except the root), and the name of the enclosing class.</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="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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#classArray-java.lang.Class-int-int-">classArray</a></span>(java.lang.Class elemClass,
int min,
int max)</code>
<div class="block">This function retrieves a collection of elements which are subclasses of
the given class, returning them as an array.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#getArray-java.lang.Class-int-int-">getArray</a></span>(java.lang.Class elemClass,
int min,
int max)</code>
<div class="block">This function retrieves a collection of elements which are subclasses of
the given class, returning them as an array.</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/eigenbase/xom/DOMElementParser.html#getAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean-">getAttribute</a></span>(java.lang.String attrName,
java.lang.String attrType,
java.lang.String defaultValue,
java.lang.String[] values,
boolean required)</code>
<div class="block">Retrieve an Attribute from the parser.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#getElement-java.lang.Class-boolean-">getElement</a></span>(java.lang.Class elementClass,
boolean required)</code>
<div class="block">This function retrieves an Element from this parser, advancing the
parser if the element is found.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.Class</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#getPluginClass-java.lang.Class-">getPluginClass</a></span>(java.lang.Class managerClass)</code>
<div class="block">Get a Class object representing a plugin class, given a manager
class that implements the static method getXMLDefClass().</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.Class</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#getPluginClass-java.lang.String-java.lang.String-">getPluginClass</a></span>(java.lang.String packageName,
java.lang.String className)</code>
<div class="block">Get a Class object representing a plugin class, identified either
directly by a Java package and Java class name, or indirectly
by a Java package and Java class which defines a method called
getXMLDefClass() to return the appropriate class.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#getString-java.lang.String-boolean-">getString</a></span>(java.lang.String elementName,
boolean required)</code>
<div class="block">This function retrieves a String element from this parser,
advancing the parser if the element is found.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#getStringArray-java.lang.String-int-int-">getStringArray</a></span>(java.lang.String elemName,
int min,
int max)</code>
<div class="block">This function returns a collection of String elements of the given
name, returning them as an array.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#getText--">getText</a></span>()</code>
<div class="block">This function is used to return a CDATA section as text.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#lastOptionIndex--">lastOptionIndex</a></span>()</code>
<div class="block">Returns the option index of the element returned through the last
requiredOption call.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#optionalArray-java.lang.String-int-int-">optionalArray</a></span>(java.lang.String elemName,
int min,
int max)</code>
<div class="block">This function retrieves a collection of elements with the given name,
returning them as an array.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#optionalAttribute-java.lang.String-">optionalAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">This function retrieves an optional Attribute by name from the
current Element.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#optionalBooleanAttribute-java.lang.String-">optionalBooleanAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">This function retrieves an optional Attribute by name from the
current Element, converting it to an Boolean.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.Double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#optionalDoubleAttribute-java.lang.String-">optionalDoubleAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">This function retrieves an optional Attribute by name from the
current Element, converting it to a Double.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#optionalElement-java.lang.String-">optionalElement</a></span>(java.lang.String elementName)</code>
<div class="block">This function retrieves an optional Element from this parser,
advancing the parser if the element is found.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#optionalIntegerAttribute-java.lang.String-">optionalIntegerAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">This function retrieves an optional Attribute by name from the
current Element, converting it to an Integer.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#optionalString-java.lang.String-">optionalString</a></span>(java.lang.String elementName)</code>
<div class="block">This function retrieves an optional String element from this parser,
advancing the parser if the element is found.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredAttribute-java.lang.String-">requiredAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">This function retrieves a required Attribute by name from the
current Element.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredBooleanAttribute-java.lang.String-">requiredBooleanAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">This function retrieves an required Attribute by name from the
current Element, converting it to a Boolean.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredClass-java.lang.Class-">requiredClass</a></span>(java.lang.Class classTemplate)</code>
<div class="block">This function retrieves a required Element of a specific class
from this parser, advancing the parser after the read.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredDefAttribute-org.eigenbase.xom.DOMWrapper-java.lang.String-java.lang.String-">requiredDefAttribute</a></span>(<a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a> wrapper,
java.lang.String attrName,
java.lang.String defaultVal)</code>
<div class="block">This static version of requiredAttribute uses any element definition
as a basis for the attribute.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredElement-java.lang.String-">requiredElement</a></span>(java.lang.String elementName)</code>
<div class="block">This function retrieves a required Element from this parser,
advancing the parser after the read.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredIntegerAttribute-java.lang.String-">requiredIntegerAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">This function retrieves an required Attribute by name from the
current Element, converting it to an Integer.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredOption-java.lang.String:A-">requiredOption</a></span>(java.lang.String[] elementNames)</code>
<div class="block">This function retrieves a required element which may have one of a
number of names.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMElementParser.html#requiredString-java.lang.String-">requiredString</a></span>(java.lang.String elementName)</code>
<div class="block">This function retrieves a required String element from this parser,
advancing the parser after the read.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DOMElementParser-org.eigenbase.xom.DOMWrapper-java.lang.String-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DOMElementParser</h4>
<pre>public DOMElementParser(<a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a> wrapper,
java.lang.String prefix,
java.lang.Class enclosure)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">Constructs a new ElementParser based on an Element of the XML parse
tree wrapped in a DOMWrapper, and a prefix (to be applied to all element
tags except the root), and the name of the enclosing class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wrapper</code> - a DOMWrapper representing the section of the XML parse tree
to traverse.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></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="requiredString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredString</h4>
<pre>public java.lang.String requiredString(java.lang.String elementName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a required String element from this parser,
advancing the parser after the read.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementName</code> - the name of the element to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String value stored inside the element to retrieve.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if there is no element with the given name.</dd>
</dl>
</li>
</ul>
<a name="optionalString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionalString</h4>
<pre>public java.lang.String optionalString(java.lang.String elementName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an optional String element from this parser,
advancing the parser if the element is found.
If no element of the correct name is found, this function returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementName</code> - the name of the element to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String value stored inside the element to retrieve.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></dd>
</dl>
</li>
</ul>
<a name="requiredElement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredElement</h4>
<pre>public <a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a> requiredElement(java.lang.String elementName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a required Element from this parser,
advancing the parser after the read.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementName</code> - the name of the element to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the DOMWrapper to retrieve.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if there is no element with the given name.</dd>
</dl>
</li>
</ul>
<a name="getText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>public java.lang.String getText()</pre>
<div class="block">This function is used to return a CDATA section as text. It does
no parsing.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the contents of the CDATA element as text.</dd>
</dl>
</li>
</ul>
<a name="optionalElement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionalElement</h4>
<pre>public <a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a> optionalElement(java.lang.String elementName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an optional Element from this parser,
advancing the parser if the element is found.
If no element of the correct name is found, this function returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementName</code> - the name of the element to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the DOMWrapper to retreive, or null if none found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></dd>
</dl>
</li>
</ul>
<a name="requiredOption-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredOption</h4>
<pre>public <a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a> requiredOption(java.lang.String[] elementNames)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a required element which may have one of a
number of names. The parser is advanced after the read.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementNames</code> - an array of allowed names. Names are compared in
a case-insensitive fashion.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the first element with one of the given names.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if there are no more elements to read or if
the next element's name is not in the elementNames list.</dd>
</dl>
</li>
</ul>
<a name="requiredClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredClass</h4>
<pre>public <a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a> requiredClass(java.lang.Class classTemplate)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a required Element of a specific class
from this parser, advancing the parser after the read.
The class must be derived from ElementDef.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></dd>
</dl>
</li>
</ul>
<a name="lastOptionIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lastOptionIndex</h4>
<pre>public int lastOptionIndex()</pre>
<div class="block">Returns the option index of the element returned through the last
requiredOption call.</div>
</li>
</ul>
<a name="requiredAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredAttribute</h4>
<pre>public java.lang.String requiredAttribute(java.lang.String attrName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a required Attribute by name from the
current Element.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String value of the attribute.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if no attribute of this name is set.</dd>
</dl>
</li>
</ul>
<a name="requiredDefAttribute-org.eigenbase.xom.DOMWrapper-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredDefAttribute</h4>
<pre>public static java.lang.String requiredDefAttribute(<a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a> wrapper,
java.lang.String attrName,
java.lang.String defaultVal)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This static version of requiredAttribute uses any element definition
as a basis for the attribute. It is used by Plugin definitions to
return attributes before the parser is created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wrapper</code> - the Element in which to find the attribute.</dd>
<dd><code>attrName</code> - the name of the attribute to retrieve.</dd>
<dd><code>defaultVal</code> - the default value of the attribute to retrieve.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if no attribute of this name is set.</dd>
</dl>
</li>
</ul>
<a name="optionalAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionalAttribute</h4>
<pre>public java.lang.String optionalAttribute(java.lang.String attrName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an optional Attribute by name from the
current Element.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String value of the attribute, or null if the
attribute is not set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></dd>
</dl>
</li>
</ul>
<a name="optionalIntegerAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionalIntegerAttribute</h4>
<pre>public java.lang.Integer optionalIntegerAttribute(java.lang.String attrName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an optional Attribute by name from the
current Element, converting it to an Integer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Integer value of the attribute, or null if the
attribute is not set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if the value is set to an illegal
integer value.</dd>
</dl>
</li>
</ul>
<a name="optionalDoubleAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionalDoubleAttribute</h4>
<pre>public java.lang.Double optionalDoubleAttribute(java.lang.String attrName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an optional Attribute by name from the
current Element, converting it to a Double.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Double value of the attribute, or null if the
attribute is not set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if the value is set to an illegal
double value.</dd>
</dl>
</li>
</ul>
<a name="requiredIntegerAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredIntegerAttribute</h4>
<pre>public java.lang.Integer requiredIntegerAttribute(java.lang.String attrName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an required Attribute by name from the
current Element, converting it to an Integer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Integer value of the attribute.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if the value is not set, or is set to
an illegal integer value.</dd>
</dl>
</li>
</ul>
<a name="optionalBooleanAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionalBooleanAttribute</h4>
<pre>public java.lang.Boolean optionalBooleanAttribute(java.lang.String attrName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an optional Attribute by name from the
current Element, converting it to an Boolean. The string value
"true" (in any case) is considered TRUE. Any other value is
considered false.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Boolean value of the attribute, or null if the
attribute is not set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if the value is set to an illegal
integer value.</dd>
</dl>
</li>
</ul>
<a name="requiredBooleanAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiredBooleanAttribute</h4>
<pre>public java.lang.Boolean requiredBooleanAttribute(java.lang.String attrName)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an required Attribute by name from the
current Element, converting it to a Boolean. The string value
"true" (in any case) is considered TRUE. Any other value is
considered false.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Boolean value of the attribute.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></dd>
</dl>
</li>
</ul>
<a name="optionalArray-java.lang.String-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionalArray</h4>
<pre>public <a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a>[] optionalArray(java.lang.String elemName,
int min,
int max)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a collection of elements with the given name,
returning them as an array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elemName</code> - the element name.</dd>
<dd><code>min</code> - the minimum number of elements required in the array. Set
this parameter to 0 to indicate no minimum.</dd>
<dd><code>max</code> - the maximum number of elements allowed in the array. Set
this parameter to 0 to indicate no maximum.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Element array containing the discovered elements.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if there are fewer than min or more than max
elements with the name <i>elemName</i>.</dd>
</dl>
</li>
</ul>
<a name="classArray-java.lang.Class-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>classArray</h4>
<pre>public <a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a>[] classArray(java.lang.Class elemClass,
int min,
int max)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a collection of elements which are subclasses of
the given class, returning them as an array. The array will contain
ElementDef objects automatically constructed to be of the correct class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elemClass</code> - the element class.</dd>
<dd><code>min</code> - the minimum number of elements required in the array. Set
this parameter to 0 to indicate no minimum.</dd>
<dd><code>max</code> - the maximum number of elements allowed in the array. Set
this parameter to 0 to indicate no maximum.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ElementDef array containing the discovered elements.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if there are fewer than min or more than max
elements with the name <i>elemName</i>.</dd>
</dl>
</li>
</ul>
<a name="getElement-java.lang.Class-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElement</h4>
<pre>public <a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a> getElement(java.lang.Class elementClass,
boolean required)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves an Element from this parser, advancing the
parser if the element is found. The Element's corresponding
ElementDef class is looked up and its constructor is called
automatically. If the requested Element is not found the function
returns null <i>unless</i> required is set to true. In this case,
a XOMException is thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementClass</code> - the Class of the element to retrieve.</dd>
<dd><code>required</code> - true to throw an exception if the element is not
found, false to simply return null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the element, as an ElementDef, or null if it is not found
and required is false.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if required is true and the element could not
be found.</dd>
</dl>
</li>
</ul>
<a name="getArray-java.lang.Class-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArray</h4>
<pre>public <a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a>[] getArray(java.lang.Class elemClass,
int min,
int max)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a collection of elements which are subclasses of
the given class, returning them as an array. The array will contain
ElementDef objects automatically constructed to be of the correct class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elemClass</code> - the element class.</dd>
<dd><code>min</code> - the minimum number of elements required in the array. Set
this parameter to 0 to indicate no minimum.</dd>
<dd><code>max</code> - the maximum number of elements allowed in the array. Set
this parameter to 0 to indicate no maximum.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ElementDef array containing the discovered elements.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if there are fewer than min or more than max
elements with the name <i>elemName</i>.</dd>
</dl>
</li>
</ul>
<a name="getString-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public java.lang.String getString(java.lang.String elementName,
boolean required)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function retrieves a String element from this parser,
advancing the parser if the element is found.
If no element of the correct name is found, this function returns null,
unless required is true, in which case a XOMException is thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementName</code> - the name of the element to retrieve.</dd>
<dd><code>required</code> - true to throw an exception if the element is not
found, false to simply return null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String value stored inside the element to retrieve, or
null if no element with the given elementName could be found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></dd>
</dl>
</li>
</ul>
<a name="getStringArray-java.lang.String-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringArray</h4>
<pre>public java.lang.String[] getStringArray(java.lang.String elemName,
int min,
int max)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">This function returns a collection of String elements of the given
name, returning them as an array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elemName</code> - the element name.</dd>
<dd><code>min</code> - the minimum number of elements required in the array. Set
this parameter to 0 to indicate no minimum.</dd>
<dd><code>max</code> - the maximum number of elements allowed in the array. Set
this parameter to 0 to indicate no maximum.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String array containing the discovered elements.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if there are fewer than min or more than max
elements with the name <i>elemName</i>.</dd>
</dl>
</li>
</ul>
<a name="getPluginClass-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginClass</h4>
<pre>public static java.lang.Class getPluginClass(java.lang.String packageName,
java.lang.String className)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">Get a Class object representing a plugin class, identified either
directly by a Java package and Java class name, or indirectly
by a Java package and Java class which defines a method called
getXMLDefClass() to return the appropriate class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packageName</code> - the name of the Java package containing the
plugin class.</dd>
<dd><code>className</code> - the name of the plugin definition class.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code> - if the plugin class cannot be located
or if the designated class is not suitable as a plugin class.</dd>
</dl>
</li>
</ul>
<a name="getPluginClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginClass</h4>
<pre>public static java.lang.Class getPluginClass(java.lang.Class managerClass)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">Get a Class object representing a plugin class, given a manager
class that implements the static method getXMLDefClass().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>managerClass</code> - any Class that implements getXMLDefClass.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the plugin Class.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAttribute</h4>
<pre>public java.lang.Object getAttribute(java.lang.String attrName,
java.lang.String attrType,
java.lang.String defaultValue,
java.lang.String[] values,
boolean required)
throws <a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></pre>
<div class="block">Retrieve an Attribute from the parser. The Attribute may be of any
Java class, provided that the class supports a constructor from the
String class. The Attribute's value will be returned as an Object,
which must then be cast to the appropraite type. If the attribute
is not defined and has no default, either null is returned (if
required is false), or a XOMException is thrown (if required is
true).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attrName</code> - the name of the attribute to retreive.</dd>
<dd><code>attrType</code> - a String naming a Java Class to serve as the type.
If attrType contains a "." character, the class is looked up directly
from the type name. Otherwise, the class is looked up in the
java.lang package. Finally, the class must have a constructor which
takes a String as an argument.</dd>
<dd><code>defaultValue</code> - the default value for this attribute. If values
is set, the defaultValue must also be one of the set of values.
defaultValue may be null.</dd>
<dd><code>values</code> - an array of possible values for the attribute. If
this parameter is not null, then the attribute's value must be one
of the listed set of values or an exception will be thrown.</dd>
<dd><code>required</code> - if set, then this function will throw an exception
if the attribute has no value and defaultValue is null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Attribute's value as an Object. The actual class of
this object is determined by attrType.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></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="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/eigenbase/xom/DefWalker.html" title="class in org.eigenbase.xom"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eigenbase/xom/DOMElementParser.html" target="_top">Frames</a></li>
<li><a href="DOMElementParser.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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 ======= -->
</body>
</html>
|