/usr/share/doc/libjibx1.2-java-doc/getting-started.html is in libjibx1.2-java-doc 1.2.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: Getting Started</title>
<style type="text/css">
@import url("./style/tigris.css");
@import url("./style/maven.css");
.dtd-comment {
color: #993399;
font-weight: bold;
</style>
<script type="text/javascript">
if (document.layers) {
document.writeln('<link rel="stylesheet" type="text/css" href="./style/ns4_only.css" media="screen" /><link rel="stylesheet" type="text/css" href="./style/maven_ns4_only.css" media="screen" />')
}
</script>
<link rel="stylesheet" type="text/css" href="./style/print.css" media="print" />
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
</head>
<body class="composite">
<div id="banner">
<table border="0" cellspacing="0" cellpadding="8" width="100%">
<tbody>
<tr>
<td><h1>JiBX: Getting Started</h1>
</td>
<td>
<div align="right" id="login"><a href="http://sourceforge.net/projects/jibx"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=69358&type=16" width="150" height="40" border="0" alt="Get JiBX - XML Data Binding for Java at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="breadcrumbs">
<table border="0" cellspacing="0" cellpadding="4" width="100%">
<tbody>
<tr>
<td>
<div align="right">
<a href="./index.html">Home Page</a> |
<a href="http://www.sourceforge.net/projects/jibx/">SourceForge Page</a> |
<a href="./mail-lists.html">Mailing Lists</a> |
<a href="./bugs.html">Bugs</a> |
<a href="http://sourceforge.net/project/showfiles.php?group_id=69358">Downloads</a>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<table border="0" cellspacing="0" cellpadding="8" width="100%" id="main">
<tbody>
<tr valign="top">
<td id="leftcol" width="20%">
<div id="navcolumn">
<div>
<strong>JiBX Basics</strong>
<div>
<small>
<a href="index.html">Overview</a>
</small>
<div>
<small>
<span class="menu-selection">Getting Started</span>
</small>
</div>
<div>
<small>
<a href="bindcomp.html">Binding Compiler</a>
</small>
</div>
<div>
<small>
<a href="bindonload.html">Binding on Load</a>
</small>
</div>
<div>
<small>
<a href="runtime.html">Runtime</a>
</small>
</div>
<div>
<small>
<a href="extras.html">Extras</a>
</small>
</div>
<div>
<small>
<a href="building.html">Building JiBX</a>
</small>
</div>
<div>
<small>
<a href="./jibx-maven-plugin/index.html">Maven</a>
</small>
</div>
<div>
<small>
<a href="contributing.html">Contributing</a>
</small>
</div>
<div>
<small>
<a href="jibx-license.html">License</a>
</small>
</div>
</div>
<div>
<small>
<a href="status.html">News and Status</a>
</small>
</div>
<div>
<small>
<a href="support.html">Support</a>
</small>
<div>
<small>
<a href="faq.html">FAQ</a>
</small>
</div>
<div>
<small>
<a href="mail-lists.html">Mailing Lists</a>
</small>
</div>
<div>
<small>
<a href="bugs.html">Bugs</a>
</small>
</div>
</div>
<div>
<small>
<a href="comments.html">User Comments</a>
</small>
</div>
<div>
<small>
<a href="sponsors.html">Sponsors</a>
</small>
</div>
</div>
<div>
<strong>Start from Code</strong>
<div>
<small>
<a href="fromcode/index.html">Start from Code</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen.html">BindGen</a>
</small>
<div>
<small>
<a href="fromcode/bindgen-examples.html">Example Code</a>
</small>
<div>
<small>
<a href="fromcode/bindgen-example1.html">Example 1</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen-example2.html">Example 2</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen-example3.html">Example 3</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen-example4.html">Example 4</a>
</small>
</div>
</div>
<div>
<small>
<a href="fromcode/bindgen-customs.html">Customizations Reference</a>
</small>
</div>
</div>
<div>
<small>
<a href="fromcode/schemagen.html">SchemaGen</a>
</small>
</div>
<div>
<small>
<a href="fromcode/jibx2wsdl.html">Jibx2Wsdl</a>
</small>
<div>
<small>
<a href="fromcode/jibx2wsdl-examples.html">Examples</a>
</small>
</div>
<div>
<small>
<a href="fromcode/jibx2wsdl-customs.html">Customizations</a>
</small>
</div>
</div>
</div>
<div>
<strong>Start from Schema</strong>
<div>
<small>
<a href="fromschema/index.html">Start from Schema</a>
</small>
</div>
<div>
<small>
<a href="fromschema/codegen.html">CodeGen</a>
</small>
<div>
<small>
<a href="fromschema/codegen-types.html">Schema Datatype Handling</a>
</small>
</div>
<div>
<small>
<a href="fromschema/codegen-examples.html">Example Code</a>
</small>
<div>
<small>
<a href="fromschema/example-default.html">Default Generation</a>
</small>
</div>
<div>
<small>
<a href="fromschema/example-custom1.html">Simple Customizations</a>
</small>
</div>
<div>
<small>
<a href="fromschema/example-custom2.html">More Customizations</a>
</small>
</div>
<div>
<small>
<a href="fromschema/example-modular.html">Modular Generation</a>
</small>
</div>
</div>
<div>
<small>
<a href="fromschema/codegen-customs.html">Customizations Reference</a>
</small>
<div>
<small>
<a href="fromschema/codegen-extends.html">Extensions Reference</a>
</small>
</div>
</div>
</div>
</div>
<div>
<strong>Binding Definition</strong>
<div>
<small>
<a href="binding/tutorial/binding-tutorial.html">Binding Tutorial</a>
</small>
<div>
<small>
<a href="binding/tutorial/binding-start.html">A basic binding</a>
</small>
</div>
<div>
<small>
<a href="binding/tutorial/binding-extras.html">Binding extras</a>
</small>
</div>
<div>
<small>
<a href="binding/tutorial/binding-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="binding/tutorial/binding-collects.html">Collections and arrays</a>
</small>
</div>
<div>
<small>
<a href="binding/tutorial/binding-mappings.html">Using mappings</a>
</small>
</div>
<div>
<small>
<a href="binding/tutorial/binding-advanced.html">Advanced binding</a>
</small>
</div>
<div>
<small>
<a href="binding/tutorial/binding-extend.html">Method hooks</a>
</small>
</div>
<div>
<small>
<a href="binding/tutorial/binding-custom.html">Custom code</a>
</small>
</div>
</div>
<div>
<small>
<a href="binding/precompiled.html">Precompiled Bindings</a>
</small>
</div>
<div>
<small>
<a href="binding/binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="binding/contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="binding/conversions.html">Conversions</a>
</small>
<div>
<small>
<a href="binding/date-time.html">Date/time conversions</a>
</small>
</div>
</div>
<div>
<small>
<a href="binding/xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="binding/binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="binding/include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="binding/format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="binding/namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="binding/mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="binding/value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="binding/structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="binding/collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="binding/binding-attributes.html">Attribute groups</a>
</small>
</div>
</div>
</div>
<div>
<strong>Usage API</strong>
<div>
<small>
<a href="./api/index.html">Runtime JavaDocs</a>
</small>
</div>
</div>
<div>
<strong>Subprojects</strong>
<div>
<small>
<a href="eclipse/index.html">Eclipse Plug-in</a>
</small>
<div>
<small>
<a href="eclipse/index.html">Introduction</a>
</small>
</div>
<div>
<small>
<a href="eclipse/install.html">Install</a>
</small>
</div>
<div>
<small>
<a href="eclipse/usage.html">Usage</a>
</small>
</div>
</div>
<div>
<small>
<a href="jibxws/index.html">JiBX/WS</a>
</small>
</div>
<div>
<small>
<a href="axis2/index.html">Axis2 Usage</a>
</small>
</div>
<div>
<small>
<a href="jibxota/index.html">JiBX/OTA</a>
</small>
</div>
<div>
<small>
<a href="./schema-library/index.html">Schema Library</a>
</small>
</div>
</div>
</div>
</td>
<td>
<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="start"></a>Getting started</h3>
<p>To get started using JiBX, you just need to download the distribution zip file from
the <a href="http://sourceforge.net/project/showfiles.php?group_id=69358">SourceForge
downloads page</a> and unzip it to a convenient location on your system. The distribution
comes with all the core components of JiBX, including the binding compiler, runtime,
extras, and various flavors of generation tools. There are also convenient examples to
help get you going, in four flavors:</p>
<ul>
<li><i>bindgen</i> - use JiBX binding and schema generation from code</li>
<li><i>codegen</i> - use JiBX binding and code generation from schema</li>
<li><i>jibx2wsdl</i> - use JiBX binding, WSDL, and schema generation from code</li>
<li><i>starter</i> - use JiBX with supplied (or hand-written) binding definition</li>
</ul>
<p>All the examples are set up to use the Ant build tool. If you don't already
have Ant installed on your system, you can get it from the <a href="http://ant.apache.org/">Ant
Project page</a>.</p>
<p>Once you've installed the distribution on your system, open the <i>readme.html</i>
file located in the root of the JiBX distribution. This will provide some details of
what's new in the JiBX release, and also links to both the above examples and the
offline version of this documentation, also included in the distribution.</p>
</div>
<div class="h3">
<h3><a name="basic"></a>Basic use of JiBX</h3>
<p>Whether you're using JiBX directly, with a binding definition you've
constructed on your own, or using one of the generator tools to create a
binding, you're going to need to go through certain steps every time you build
your application:</p>
<ol>
<li>Compile your source code (only if compiled class files are out of date)</li>
<li>Run the JiBX binding compiler on your compiled class files</li>
<li>Use the JiBX runtime and some form of parser when you run your application</li>
</ol>
<p>This sequence doesn't mean you can't do other steps in between. You may want
to assemble your class files into jar files, for instance, after you've run the
binding compiler (which currently requires the class files in un-jarred form).
You can even use other bytecode manipulation tools along with JiBX, as long as
those tools obey the JVM rules for bytecode handling.</p>
<p>The starter examples all include these steps as Ant targets. You can also see
the separate pages in this section of the documentation for details on the
<a href="bindcomp.html">binding compiler</a> and <a href="runtime.html">runtime</a> usage.</p>
</div>
<div class="h3">
<h3><a name="fromcode">Start from code</a></h3>
<p>If you're starting from existing Java code, you can use the <a href="fromcode/bindgen.html">BindGen</a>
tool included in the JiBX distribution to automatically generate a binding definition and
corresponding XML schema definition from your code. BindGen uses default behaviors which will
give good XML structure for most data models - but if the default generation is not satisfactory
for your needs you can easily customize the generation handling at every level, with features
such as:</p>
<ul>
<li>Support for both Java 5-style enum and typed collections, and pre-Java 5 alternatives</li>
<li>Specify which class properties are to be included in the XML</li>
<li>Control XML representation as attributes or elements, and required or optional</li>
<li>Format JavaDocs for export to XML schema definition documentation</li>
<li>Change XML naming conventions and namespace usage</li>
</ul>
<p>You can also use the <a href="fromcode/jibx2wsdl.html">Jibx2Wsdl</a> tool to generate a WSDL web
service definition based on an existing service class. Jibx2Wsdl builds on BindGen and
supports all the same customization features for data model classes, along with some added
customizations for the service class and WSDL usage.</p>
<p>The <i>bindgen</i> examples show how to use BindGen for binding and schema generation,
both with and without customizations. The <i>jibx2wsdl</i> examples do the same for the
Jibx2Wsdl tool. For more details of using JiBX with existing Java code, including full
details of the customizations structure, see the <a href="fromcode/index.html">Start from Code</a>
section of this documentation.</p>
</div>
<div class="h3">
<h3><a name="fromschema"></a>Start from schema</h3>
<p>If you're starting from an existing XML schema definition, you can use the
<a href="fromschema/codegen.html">CodeGen</a> tool included in the JiBX distribution to automatically
generate a Java data model and corresponding JiBX binding definition to match your XML
documents. Here again, the code and binding generation uses default behaviors which will
give a good data model for most schemas, but can be customized at every level to improve
handling with features including:</p>
<ul>
<li>Simplify the data model by excluding schema definition components not used in your documents</li>
<li>Selectively ignore the content of portions of input documents</li>
<li>Inline schema definitions which are only used in one place</li>
<li>Support for generating both Java 5-style enum and typed collections, and pre-Java 5 versions</li>
<li>Change Java naming conventions and package usage</li>
<li>Add your own custom extensions to the code generation for special handling</li>
</ul>
<p>The <i>codegen</i> examples show how to use the code and binding generation from schema,
both with and without customizations. For more details of using JiBX with existing XML
schemas, including full details of the customizations structure, see the
<a href="fromschema/index.html">Start from Schema</a> section of this documentation.</p>
</div>
</div>
</div>
</td>
</tr>
</tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
<tbody>
<tr>
<td> © 2003-2011, Dennis M. Sosnoski (<a href="http://www.sosnoski.co.nz">Sosnoski Software Associates Ltd</a>).
Licensed to the JiBX Project for free distribution and use. </td>
</tr>
</tbody>
</table>
</div>
<br>
</body>
</html>
|