/usr/share/doc/libeigenbase-resgen-java/api/org/eigenbase/xom/package-summary.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 | <!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>org.eigenbase.xom</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="org.eigenbase.xom";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/resgen/package-summary.html">Prev Package</a></li>
<li><a href="../../../org/eigenbase/xom/wrappers/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eigenbase/xom/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package org.eigenbase.xom</h1>
<div class="docSummary">
<div class="block">Provides an object layer for reading and writing XML documents.</div>
</div>
<p>See: <a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/Any.html" title="interface in org.eigenbase.xom">Any</a></td>
<td class="colLast">
<div class="block">An element which has 'Any' content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom">DOMWrapper</a></td>
<td class="colLast">
<div class="block">DOMWrapper implements a Wrapper around the Element class from any DOM-style
XML parser.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/Location.html" title="interface in org.eigenbase.xom">Location</a></td>
<td class="colLast">
<div class="block">Represents the location of a node within its document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/Locator.html" title="interface in org.eigenbase.xom">Locator</a></td>
<td class="colLast">
<div class="block">Callback to find the location of a node within its document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Content.html" title="interface in org.eigenbase.xom">MetaDef.Content</a></td>
<td class="colLast">
<div class="block">The Content class contains all entities which represent types of
content which may appear within an Element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Definition.html" title="interface in org.eigenbase.xom">MetaDef.Definition</a></td>
<td class="colLast">
<div class="block">The Definition class represents a generic type of element definition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.FullDefinition.html" title="interface in org.eigenbase.xom">MetaDef.FullDefinition</a></td>
<td class="colLast">
<div class="block">The FullDefinition class represents a fully-specified definition
that may include content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/NodeDef.html" title="interface in org.eigenbase.xom">NodeDef</a></td>
<td class="colLast">
<div class="block"><code>NodeDef</code> represents a node in a parse tree.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/Parser.html" title="interface in org.eigenbase.xom">Parser</a></td>
<td class="colLast">
<div class="block">The <code>Parser</code> interface abstracts the behavior which the
<code>org.eigenbase.xom</code> package needs from an XML parser.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/CdataDef.html" title="class in org.eigenbase.xom">CdataDef</a></td>
<td class="colLast">
<div class="block">A <code>CdataDef</code> represents a CDATA element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/CommentDef.html" title="class in org.eigenbase.xom">CommentDef</a></td>
<td class="colLast">
<div class="block">todo:</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/DefWalker.html" title="class in org.eigenbase.xom">DefWalker</a></td>
<td class="colLast">
<div class="block">DefWalker is a class designed to help users of plugin elements and elements
with content type ANY.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/DOMElementParser.html" title="class in org.eigenbase.xom">DOMElementParser</a></td>
<td class="colLast">
<div class="block">DOMElementParser is a utility wrapper around DOMWrapper.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom">ElementDef</a></td>
<td class="colLast">
<div class="block">ElementDef is the base class for all element definitions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/GenericDef.html" title="class in org.eigenbase.xom">GenericDef</a></td>
<td class="colLast">
<div class="block">A <code>GenericDef</code> is a <a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a> whose attributes and
children are stored in collections, not generated members.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.html" title="class in org.eigenbase.xom">MetaDef</a></td>
<td class="colLast">
<div class="block">This model is the XOM Meta Model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Any.html" title="class in org.eigenbase.xom">MetaDef.Any</a></td>
<td class="colLast">
<div class="block">The Any content is a special marker which allows an Element to
contain any type of data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Array.html" title="class in org.eigenbase.xom">MetaDef.Array</a></td>
<td class="colLast">
<div class="block">An Array is a set of multiple instances of Elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Attribute.html" title="class in org.eigenbase.xom">MetaDef.Attribute</a></td>
<td class="colLast">
<div class="block">The Attribute entity appears within any Element definition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.CData.html" title="class in org.eigenbase.xom">MetaDef.CData</a></td>
<td class="colLast">
<div class="block">The CData content is a special marker which allows an Element to
contain a single CDATA section as its only content, yet still
have attributes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Class.html" title="class in org.eigenbase.xom">MetaDef.Class</a></td>
<td class="colLast">
<div class="block">A Class Definition defines a class of entities.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Element.html" title="class in org.eigenbase.xom">MetaDef.Element</a></td>
<td class="colLast">
<div class="block">An Element Definition defines a basic entity of the meta model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Import.html" title="class in org.eigenbase.xom">MetaDef.Import</a></td>
<td class="colLast">
<div class="block">An Import as a special type of element that represents another element
stored in an external model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Model.html" title="class in org.eigenbase.xom">MetaDef.Model</a></td>
<td class="colLast">
<div class="block">Model is the top-level element for a model description.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Object.html" title="class in org.eigenbase.xom">MetaDef.Object</a></td>
<td class="colLast">
<div class="block">An Object is a single instance of an Element type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.Plugin.html" title="class in org.eigenbase.xom">MetaDef.Plugin</a></td>
<td class="colLast">
<div class="block">A Plugin in a special type of element whose content may be derived from
a different model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaDef.StringElement.html" title="class in org.eigenbase.xom">MetaDef.StringElement</a></td>
<td class="colLast">
<div class="block">A StringElement is a simple type of element which has no attributes and
whose content is a single String (usually represented as a CDATA section).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaGenerator.html" title="class in org.eigenbase.xom">MetaGenerator</a></td>
<td class="colLast">
<div class="block"><code>MetaGenerator</code> is a utility class which reads a XOM Meta
Model description in XML and generates the corresponding .dtd and .java
definition files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/MetaTester.html" title="class in org.eigenbase.xom">MetaTester</a></td>
<td class="colLast">
<div class="block">The MetaTester class is a utility class for testing generated models.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/ParserTester.html" title="class in org.eigenbase.xom">ParserTester</a></td>
<td class="colLast">
<div class="block">Test the MSParser</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/StringEscaper.html" title="class in org.eigenbase.xom">StringEscaper</a></td>
<td class="colLast">
<div class="block"><code>StringEscaper</code> is a utility for replacing special characters
with escape sequences in strings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/TextDef.html" title="class in org.eigenbase.xom">TextDef</a></td>
<td class="colLast">
<div class="block">A <code>TextDef</code> represents piece of textual data in an XML document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/WrapperElementDef.html" title="class in org.eigenbase.xom">WrapperElementDef</a></td>
<td class="colLast">
<div class="block"><code>WrapperElementDef</code> is an <a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a> which retains the
underlying XML <a href="../../../org/eigenbase/xom/DOMWrapper.html" title="interface in org.eigenbase.xom"><code>DOMWrapper</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/XMLAttrVector.html" title="class in org.eigenbase.xom">XMLAttrVector</a></td>
<td class="colLast">
<div class="block">XMLAttrVector is an class which assists in writing XML attributes to a
stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/XMLOutput.html" title="class in org.eigenbase.xom">XMLOutput</a></td>
<td class="colLast">
<div class="block">XMLOutput is a class which implements streaming XML output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/XMLUtil.html" title="class in org.eigenbase.xom">XMLUtil</a></td>
<td class="colLast">
<div class="block">Utilities for dealing with XML data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/XOMGenTask.html" title="class in org.eigenbase.xom">XOMGenTask</a></td>
<td class="colLast">
<div class="block"><code>XOMGenTask</code> is an ANT task with which to invoke <a href="../../../org/eigenbase/xom/MetaGenerator.html" title="class in org.eigenbase.xom"><code>MetaGenerator</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/XomTest.html" title="class in org.eigenbase.xom">XomTest</a></td>
<td class="colLast">
<div class="block">Unit tests for XOM module.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/XOMUtil.html" title="class in org.eigenbase.xom">XOMUtil</a></td>
<td class="colLast">
<div class="block">Utility functions for the <code>org.eigenbase.xom</code> and
<code>org.eigenbase.xom.wrappers</code> packages.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/AssertFailure.html" title="class in org.eigenbase.xom">AssertFailure</a></td>
<td class="colLast">
<div class="block">todo:</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/eigenbase/xom/XOMException.html" title="class in org.eigenbase.xom">XOMException</a></td>
<td class="colLast">
<div class="block">XOMException extends Exception and provides detailed error messages for
xom-specific exceptions.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.eigenbase.xom Description">Package org.eigenbase.xom Description</h2>
<div class="block">Provides an object layer for reading and writing XML documents. The
XML-Object Mapping layer generates a class for each entity in an XML
schema, a member property for each attribute, collections for sub-objects, and
methods to serialize to and from XML.
<p>
TODO jvs 15-Mar-2005: XOM is nice, but there's no longer a lot of
reason for it to exist now that we have JAXB to do the same thing
without any tricky bootstrapping issues. So we should phase out XOM.
</p>
<p> </p>
<table border="1" width="100%">
<tr>
<th>Revision</th>
<td>$Id: //open/util/resgen/src/org/eigenbase/xom/package.html#2 $</td>
</tr>
<tr>
<th>Copyright</th>
<td>Copyright (C) 2005-2005 The Eigenbase Project</td>
</tr>
<tr>
<th>Copyright</th>
<td>Copyright (C) 2005-2005 Disruptive Tech</td>
</tr>
<tr>
<th>Copyright</th>
<td>Copyright (C) 2005-2005 Red Square, Inc.</td>
</tr>
<tr>
<th>Copyright</th>
<td>Portions Copyright (C) 2001-2005 Kana Software, Inc.</td>
</tr>
<tr>
<th>Author</th>
<td>Dan Sommerfield, Julian Hyde</td>
</tr>
</table>
<h2>Schema format</h2>
<p>The schema is defined in an XML file, whose format is somewhat similar to an
XML Schema. The (self-describing) meta-schema is <code><a href="Meta.xml">meta.xml</a>
(</code>as you can see, an <a href="../../../../misc/Meta.xsl">XSL style-sheet</a> formats each schema into a javadoc-like web
page).</p>
<p>Other schemas include <code><a href="../resgen/resource.xml">resource.xml</a></code>. </p>
<h2>Generated Java Classes</h2>
<p>The utilities in this package enable conversion of XML (stored in a DOM-style
model) into a typesafe Java representation. Roughly, conversion occurs as
follows:
<ul>
<li>Each defined <code>Element</code> becomes a Java Class. The Java Class name matches the
Element name. All classes representing Elements descend from
<a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a>. All classes from the same model are
implemented as static inner classes of a single <i>enclosure class</i>.
By convention, enclosure classes always end in "Def".</li>
<li>Each <code>Attribute</code> becomes a public member of its enclosing Element class.</li>
<li>Text (<code>PCDATA</code>) content becomes a single public String called <code>cdata</code>.</li>
<li>Element content becomes a series of public members. The members are of
the appropriate types. The members' names are defined in the schema.</li>
<li><code>ANY</code> content becomes a single array of <a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a>
called <code>children</code>.
</ul></p>
<p>Converting an XML Document to its XOM representation is a two-step process. First,
you parse the XML into a DOM representation using your favorite W3C DOM Level 1-compliant
parser (<i>note:</i> MSXML is supported as well for backward compatibility).
Then, you instantiate the XOM <a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a> subclass
corresponding to the root element in the document, passing a portion of the DOM
as input to the constructor. After this, the fully-constructed root element
provides complete typesafe access to the whole document!</p>
<p>Specific instructions for parsing using a DOM-compliant parser (such as XERCES):
<ol>
<li>Instantiate your parser, parse the document (validation against the DTD is optional),
and retrieve the parsed <code>Document</code> object.</li>
<li>Call <code>Document.getDocumentElement()</code> to retrieve the toplevel Node
in the document.</li>
<li>Wrap the toplevel node in an instance of
<a href="../../../org/eigenbase/xom/wrappers/W3CDOMWrapper.html" title="class in org.eigenbase.xom.wrappers"><code>W3CDOMWrapper</code></a>.</li>
<li>Construct the appropriate <a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a> subclass
from the wrapped node.</li>
</ol></p>
<p>Specific instructions for parsing using Microsoft's XML Parser:
<ol>
<li>Instantiate your parser, parse the document (validation against the DTD is optional),
and retrieve <code>com.ms.xml.om.Document</code> object representing the document.</li>
<li>Call <code>com.ms.xml.om.Document#getRoot()</code> to retrieve the toplevel Element
in the document.</li>
<li>Wrap the toplevel element in an instance of
<code>org.eigenbase.xom.wrappers.MSXMLWrapper</code>.</li>
<li>Construct the appropriate <a href="../../../org/eigenbase/xom/ElementDef.html" title="class in org.eigenbase.xom"><code>ElementDef</code></a> subclass
from the wrapped node.</li>
</ol></p>
<h2>Generator</h2>
<p>There is now an ANT target, <code>XOMGen</code>, implemented by <a href="../../../org/eigenbase/xom/XOMGenTask.html" title="class in org.eigenbase.xom"><code>XOMGenTask</code></a>.</p>
<h2>Tester</h2>
<p>There is another helpful utility we use to verify that the stuff we generate
works. It is class <code>MetaTester</code>, and you invoke it as follows:</p>
<blockquote><pre>jview <classpath_options> org.eigenbase.xom.MetaTester [-debug]
[-msxml | -xerces] <XML model file> <output dir> [<tests>...]</pre></blockquote>
All the arguments are the same as the ones for <a href="../../../org/eigenbase/xom/MetaGenerator.html" title="class in org.eigenbase.xom"><code>MetaGenerator</code></a>, except for
tests. <tests> is a list of test .xml files that should be valid
according to the generated DTD. The tester will validate the java files
against the DTD and also against the java class. It also runs some basic
checks on the java class to make sure that it works.
<h2>Generation</h2>
For all XML files except <code>meta.xml</code>, we generate corresponding DTD and <code><i>Name</i>Def.java</code>
at build time. <code>MetaDef</code> is tricky, because it
depends upon itself; use the ant all target to rebuild it.
<h2>Guidelines for writing models</h2>
<ol>
<li>Note that within an <code><Entity></code>, all <code><Attribute></code>s
must occur <i>before</i> all <code><Object></code>, <code><Array></code>
or <code><CData></code> elements.</li>
</ol>
<h2>Known Issues</h2>
<h2>Dependencies</h2>
<p>This package is dependent upon the following other packages:</p>
<ul>
<li><code>java.lang</code>, <code>java.io</code>, <code>java.util</code></li>
</ul>
<p>Class <code>XOMGenTask</code> <em>only</em> is dependent upon <code>org.apache.tools.ant</code>. You therefore require <code>ant.jar</code> to build, but not to run.<p>
<p>Class <a href="../../../org/eigenbase/xom/wrappers/XercesDOMParser.html" title="class in org.eigenbase.xom.wrappers"><code>XercesDOMParser</code></a> <em>only</em> is dependent upon <code>org.xml.sax</code> and <code>org.apache.xerces.parsers.DOMParser</code>. You therefore require <code>xerces.jar</code> to build, but not to run.<p></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/resgen/package-summary.html">Prev Package</a></li>
<li><a href="../../../org/eigenbase/xom/wrappers/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/eigenbase/xom/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|