/usr/share/doc/libeigenbase-resgen-java/api/org/eigenbase/xom/DOMWrapper.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 | <!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>DOMWrapper</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="DOMWrapper";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DOMElementParser.html" title="class in org.eigenbase.xom"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eigenbase/xom/DOMWrapper.html" target="_top">Frames</a></li>
<li><a href="DOMWrapper.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.eigenbase.xom</div>
<h2 title="Interface DOMWrapper" class="title">Interface DOMWrapper</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/eigenbase/xom/wrappers/W3CDOMWrapper.html" title="class in org.eigenbase.xom.wrappers">W3CDOMWrapper</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DOMWrapper</span></pre>
<div class="block">DOMWrapper implements a Wrapper around the Element class from any DOM-style
XML parser. The wrapper is used to isolate ElementParser, ElementDef, and
all ElementDef subclasses from the specifics of the underlying XML
parser.</div>
</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="memberSummary" 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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#CDATA">CDATA</a></span></code>
<div class="block">CDATA is a type of DOM Element representing a piece of text embedded in
a CDATA section, for example,
<code><![CDATA[Some text]]></code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#COMMENT">COMMENT</a></span></code>
<div class="block">COMMENT is a type of DOM Element representing an XML comment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#ELEMENT">ELEMENT</a></span></code>
<div class="block">ELEMENT is a type of DOM Element representing a named tag, possibly
containing attributes, child elements, and text.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#FREETEXT">FREETEXT</a></span></code>
<div class="block">FREETEXT is a type of DOM Element representing a piece of text (but not
a CDATA section).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#UNKNOWN">UNKNOWN</a></span></code>
<div class="block">UNKNOWN is used for DOM Element types unsupported by the
wrapper.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#getAttribute-java.lang.String-">getAttribute</a></span>(java.lang.String attrName)</code>
<div class="block">Returns the value of the attribute with the given attrName.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#getAttributeNames--">getAttributeNames</a></span>()</code>
<div class="block">Returns a list of attribute names.</div>
</td>
</tr>
<tr id="i2" 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/DOMWrapper.html#getChildren--">getChildren</a></span>()</code>
<div class="block">Returns all children of this element, including TEXT elements, as
an array of DOMWrappers.</div>
</td>
</tr>
<tr id="i3" 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/DOMWrapper.html#getElementChildren--">getElementChildren</a></span>()</code>
<div class="block">Returns all element children of this element as an array of
DOMWrappers.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../org/eigenbase/xom/Location.html" title="interface in org.eigenbase.xom">Location</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#getLocation--">getLocation</a></span>()</code>
<div class="block">Returns the location of this element.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#getTagName--">getTagName</a></span>()</code>
<div class="block">Returns the tag name of this element, or null for TEXT elements.</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/DOMWrapper.html#getText--">getText</a></span>()</code>
<div class="block">Returns a flattened representation of the text inside thie element.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/eigenbase/xom/DOMWrapper.html#getType--">getType</a></span>()</code>
<div class="block">Returns the type of this element/node.</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/DOMWrapper.html#toXML--">toXML</a></span>()</code>
<div class="block">Returns this node serialized as XML.</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="UNKNOWN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNKNOWN</h4>
<pre>static final int UNKNOWN</pre>
<div class="block">UNKNOWN is used for DOM Element types unsupported by the
wrapper.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.eigenbase.xom.DOMWrapper.UNKNOWN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FREETEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FREETEXT</h4>
<pre>static final int FREETEXT</pre>
<div class="block">FREETEXT is a type of DOM Element representing a piece of text (but not
a CDATA section). For example, <code>Some text</code>. FREETEXT
elements always have a tag name of NULL and have no children. It
maps to a <a href="../../../org/eigenbase/xom/TextDef.html" title="class in org.eigenbase.xom"><code>TextDef</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.eigenbase.xom.DOMWrapper.FREETEXT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ELEMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELEMENT</h4>
<pre>static final int ELEMENT</pre>
<div class="block">ELEMENT is a type of DOM Element representing a named tag, possibly
containing attributes, child elements, and text. It maps to a <a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a> (or a generated class derived from it), or a <a href="../../../org/eigenbase/xom/GenericDef.html" title="class in org.eigenbase.xom"><code>GenericDef</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.eigenbase.xom.DOMWrapper.ELEMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="COMMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMMENT</h4>
<pre>static final int COMMENT</pre>
<div class="block">COMMENT is a type of DOM Element representing an XML comment. It maps
to a <a href="../../../org/eigenbase/xom/CommentDef.html" title="class in org.eigenbase.xom"><code>CommentDef</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.eigenbase.xom.DOMWrapper.COMMENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CDATA">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CDATA</h4>
<pre>static final int CDATA</pre>
<div class="block">CDATA is a type of DOM Element representing a piece of text embedded in
a CDATA section, for example,
<code><![CDATA[Some text]]></code>.
CDATA elements always have a tag name of NULL and have no children. It
maps to a <a href="../../../org/eigenbase/xom/CdataDef.html" title="class in org.eigenbase.xom"><code>CdataDef</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.eigenbase.xom.DOMWrapper.CDATA">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="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>int getType()</pre>
<div class="block">Returns the type of this element/node. DOMWrapper supports only four
possibilities: <a href="../../../org/eigenbase/xom/DOMWrapper.html#FREETEXT"><code>FREETEXT</code></a>, <a href="../../../org/eigenbase/xom/DOMWrapper.html#ELEMENT"><code>ELEMENT</code></a>, <a href="../../../org/eigenbase/xom/DOMWrapper.html#COMMENT"><code>COMMENT</code></a>,
<a href="../../../org/eigenbase/xom/DOMWrapper.html#CDATA"><code>CDATA</code></a>.</div>
</li>
</ul>
<a name="getTagName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTagName</h4>
<pre>java.lang.String getTagName()</pre>
<div class="block">Returns the tag name of this element, or null for TEXT elements.</div>
</li>
</ul>
<a name="getAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre>java.lang.String getAttribute(java.lang.String attrName)</pre>
<div class="block">Returns the value of the attribute with the given attrName. If the
attribute is not defined, this method returns null.</div>
</li>
</ul>
<a name="getAttributeNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeNames</h4>
<pre>java.lang.String[] getAttributeNames()</pre>
<div class="block">Returns a list of attribute names.</div>
</li>
</ul>
<a name="getText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>java.lang.String getText()</pre>
<div class="block">Returns a flattened representation of the text inside thie element.
For a TEXT element, this returns the text itself. For an ELEMENT
element, this returns all pieces of text within the element,
with all markup removed.</div>
</li>
</ul>
<a name="toXML--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toXML</h4>
<pre>java.lang.String toXML()</pre>
<div class="block">Returns this node serialized as XML.</div>
</li>
</ul>
<a name="getChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a>[] getChildren()</pre>
<div class="block">Returns all children of this element, including TEXT elements, as
an array of DOMWrappers.</div>
</li>
</ul>
<a name="getElementChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementChildren</h4>
<pre><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a>[] getElementChildren()</pre>
<div class="block">Returns all element children of this element as an array of
DOMWrappers.</div>
</li>
</ul>
<a name="getLocation--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLocation</h4>
<pre><a href="../../../org/eigenbase/xom/Location.html" title="interface in org.eigenbase.xom">Location</a> getLocation()</pre>
<div class="block">Returns the location of this element.</div>
</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/DOMElementParser.html" title="class in org.eigenbase.xom"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eigenbase/xom/DOMWrapper.html" target="_top">Frames</a></li>
<li><a href="DOMWrapper.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 ======= -->
</body>
</html>
|