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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Example 1: Default code generation</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>Example 1: Default code generation</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>
<a href="../getting-started.html">Getting Started</a>
</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="index.html">Start from Schema</a>
</small>
</div>
<div>
<small>
<a href="codegen.html">CodeGen</a>
</small>
<div>
<small>
<a href="codegen-types.html">Schema Datatype Handling</a>
</small>
</div>
<div>
<small>
<a href="codegen-examples.html">Example Code</a>
</small>
<div>
<small>
<span class="menu-selection">Default Generation</span>
</small>
</div>
<div>
<small>
<a href="example-custom1.html">Simple Customizations</a>
</small>
</div>
<div>
<small>
<a href="example-custom2.html">More Customizations</a>
</small>
</div>
<div>
<small>
<a href="example-modular.html">Modular Generation</a>
</small>
</div>
</div>
<div>
<small>
<a href="codegen-customs.html">Customizations Reference</a>
</small>
<div>
<small>
<a href="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>CodeGen default code generation</h3>
<p>You can use the Ant 'codegen' target to generate code from the schema using the
CodeGen default settings. Here's the actual 'codegen' target from the <i>build.xml</i>:</p>
<div id="source"><pre> <!-- generate using default settings -->
<target name="codegen" depends="check-runtime,clean">
<echo message="Running code generation from schema"/>
<java classname="org.jibx.schema.codegen.CodeGen" fork="yes"
classpathref="classpath" failonerror="true">
<arg value="-t"/>
<arg value="gen/src"/>
<arg value="otasubset/OTA_AirLowFareSearch*.xsd"/>
</java>
</target>
</pre></div>
<p>This passes the '-t' parameter to CodeGen with the value 'gen/src' to tell it the
target generation directory. The third argument value tells CodeGen to use schemas from
the <i>otasubset</i> directory with names matching the pattern "OTA_AirLowFareSearch*.xsd"
as input for code generation. You can specify as many schema names or schema name patterns
as you want when running CodeGen, but must have at least one - otherwise there's nothing for
CodeGen to generate!</p>
</div>
<div class="h3">
<a name="code"></a><h3>Generated code</h3>
<p>Run the 'codegen' target and see the <i>gen/src</i> directory. (You can also use the
'full' target to generate and compile the code, run the binding compiler, and finally run
a supplied test program which roundtrips the sample documents from the <i>samples</i>
directory.)</p>
<p>CodeGen's default behavior is to derive the package used for generated code from the
schema namespace URI. In this case, the schema namespace is
<code>http://www.opentravel.org/OTA/2003/05</code> (only the <i>OTA_AirLowFareSearchRQ.xsd</i>
and <i>OTA_AirLowFareSearchRS.xsd</i> schemas actually define this target namespace, but
the other schemas assume that namespace by being included into these two schemas, either
directly or indirectly). To derive a package from the namespace, first the entire URI is
converted to lowercase. Next the <code>http://www.</code> part is stripped, then the
remaining components of the authority (host name) are converted to lowercase and
reverse-ordered. This gives <code>org.opentravel</code>. Finally, the remaining path
components are processed. Characters in the path component which are not valid Java name
characters are discarded. This include any path components consisting only of digits, so
the only component that gets used in the package name is <code>OTA</code>. The final
package name is <code>org.opentravel.ota</code>.</p>
<p>The generated classes in this case directly model the schema (with the exception of
xs:union simpleTypes - xs:union is currently not supported directly, instead using a
simple <code>String</code> value as the most general representation). CodeGen was only
asked to generate two schema documents, <i>OTA_AirLowFareSearchRQ.xsd</i> and
<i>OTA_AirLowFareSearchRS.xsd</i> - but these schemas include the other schemas in the
supplied OTA subset, either directly or indirectly. Unless you tell it otherwise, CodeGen
generates every definition (with the exception of xs:attributeGroup and xs:group definitions
which are only referenced once) in each schema, since in the general case all these
definitions are necessary. This does create a lot of classes, though; in this case, 261
top-level classes and an additional 153 inner classes, for a total of 414 classes.</p>
<p>If you look at the generated Java class files, you'll see that each class definition
starts with a JavaDoc comment giving first the documentation from the schema component
matching the Java class, and then the schema fragment matching the class definition.
This schema fragment is from a normalized version of the schema generated after type
substitutions and inlining (the latter not a factor with the default generation used in
this example), stripping annotations, and simplifications from eliminating schema
components not handled by CodeGen (such as xs:unions - currently handled just as
<code>String</code> values - and xs:restriction facets other than xs:enumeration).</p>
<p>Here's a sample of the generated code (reformated for a reasonable page width),
showing portions of the two main classes used for the response message:</p>
<div id="source"><pre>/**
*
The Low Fare Search Response message contains a number of 'Priced Itinerary'
options. Each includes:
- A set of available flights matching the client's request.
- Pricing information including taxes and full fare breakdown for each passenger
type
- Ticketing information
- Fare Basis Codes and the information necessary to make a rules entry.
This message contains similar information to a standard airline CRS or GDS Low
Fare Search Response message.
*
* Schema fragment(s) for this class:
* <pre>
* &lt;xs:element xmlns:ns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="OTA_AirLowFareSearchRS">
* &lt;xs:complexType>
* &lt;xs:sequence>
* &lt;xs:choice>
* &lt;xs:sequence>
* &lt;xs:element type="ns:SuccessType" name="Success"/>
* &lt;xs:element type="ns:WarningsType" name="Warnings"
minOccurs="0"/>
* &lt;xs:element type="ns:PricedItinerariesType"
name="PricedItineraries"/>
* &lt;/xs:sequence>
* &lt;xs:element type="ns:ErrorsType" name="Errors"/>
* &lt;/xs:choice>
* &lt;/xs:sequence>
* &lt;xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
* &lt;/xs:complexType>
* &lt;/xs:element>
* </pre>
*/
public class OTAAirLowFareSearchRS
{
private int choiceSelect = -1;
private static final int SUCCESS_CHOICE = 0;
private static final int ERRORS_CHOICE = 1;
private SuccessType success;
private WarningsType warnings;
private PricedItinerariesType pricedItineraries;
private ErrorsType errors;
private OTAPayloadStdAttributes OTAPayloadStdAttributes;
private void setChoiceSelect(int choice) {
if (choiceSelect == -1) {
choiceSelect = choice;
} else if (choiceSelect != choice) {
throw new IllegalStateException(
"Need to call clearChoiceSelect() before changing existing choice");
}
}
/**
* Clear the choice selection.
*/
public void clearChoiceSelect() {
choiceSelect = -1;
}
/**
* Check if Success is current selection for choice.
*
* @return <code>true</code> if selection, <code>false</code> if not
*/
public boolean ifSuccess() {
return choiceSelect == SUCCESS_CHOICE;
}
/**
* Get the 'Success' element value. Success
Standard way to indicate successful processing of an OTA message. Returning an
empty element of this type indicates success.
*
* @return value
*/
public SuccessType getSuccess() {
return success;
}
/**
* Set the 'Success' element value. Success
Standard way to indicate successful processing of an OTA message. Returning an
empty element of this type indicates success.
*
* @param success
*/
public void setSuccess(SuccessType success) {
setChoiceSelect(SUCCESS_CHOICE);
this.success = success;
}
/**
* Get the 'Warnings' element value. Standard way to indicate successful
processing of an OTA message, but one in which warnings are generated.
*
* @return value
*/
public WarningsType getWarnings() {
return warnings;
}
/**
* Set the 'Warnings' element value. Standard way to indicate successful
processing of an OTA message, but one in which warnings are generated.
*
* @param warnings
*/
public void setWarnings(WarningsType warnings) {
setChoiceSelect(SUCCESS_CHOICE);
this.warnings = warnings;
}
/**
* Get the 'PricedItineraries' element value. Successfull Low Fare priced
itineraries in response to a Low Fare Search request.
*
* @return value
*/
public PricedItinerariesType getPricedItineraries() {
return pricedItineraries;
}
/**
* Set the 'PricedItineraries' element value. Successfull Low Fare priced
itineraries in response to a Low Fare Search request.
*
* @param pricedItineraries
*/
public void setPricedItineraries(PricedItinerariesType pricedItineraries) {
setChoiceSelect(SUCCESS_CHOICE);
this.pricedItineraries = pricedItineraries;
}
...
}
/**
* Container for priced itineraries.
*
* Schema fragment(s) for this class:
* <pre>
* &lt;xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PricedItinerariesType">
* &lt;xs:sequence>
* &lt;xs:element name="PricedItinerary" maxOccurs="unbounded">
* &lt;!-- Reference to inner class PricedItinerary -->
* &lt;/xs:element>
* &lt;/xs:sequence>
* &lt;/xs:complexType>
* </pre>
*/
public class PricedItinerariesType
{
private List<PricedItinerary> pricedItineraryList =
new ArrayList<PricedItinerary>();
/**
* Get the list of 'PricedItinerary' element items.
*
* @return list
*/
public List<PricedItinerary> getPricedItineraryList() {
return pricedItineraryList;
}
/**
* Set the list of 'PricedItinerary' element items.
*
* @param list
*/
public void setPricedItineraryList(List<PricedItinerary> list) {
pricedItineraryList = list;
}
/**
* Itinerary with pricing information.
*
* Schema fragment(s) for this class:
* <pre>
* &lt;xs:element xmlns:ns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PricedItinerary"
maxOccurs="unbounded">
* &lt;xs:complexType>
* &lt;xs:complexContent>
* &lt;xs:extension base="ns:PricedItineraryType">
* &lt;xs:attribute type="xs:integer" use="optional"
name="OriginDestinationRefNumber"/>
* &lt;/xs:extension>
* &lt;/xs:complexContent>
* &lt;/xs:complexType>
* &lt;/xs:element>
* </pre>
*/
public static class PricedItinerary extends PricedItineraryType
{
private BigInteger originDestinationRefNumber;
/**
* Get the 'OriginDestinationRefNumber' attribute value. This attribute
refers back to origin destination information in the OTA_AirLowFareSearchRQ
message.
*
* @return value
*/
public BigInteger getOriginDestinationRefNumber() {
return originDestinationRefNumber;
}
/**
* Set the 'OriginDestinationRefNumber' attribute value. This attribute
refers back to origin destination information in the OTA_AirLowFareSearchRQ
message.
*
* @param originDestinationRefNumber
*/
public void setOriginDestinationRefNumber(
BigInteger originDestinationRefNumber) {
this.originDestinationRefNumber = originDestinationRefNumber;
}
}
}</pre></div>
<p>The above code sample illustrates several aspects of the default code generation.
The <code>OTAAirLowFareSearchRS</code> class represents an <OTA_AirLowFareSearchRS>
element, with a schema structure consisting of a choice between a sequence of a
<Success> element, an optional <Warnings> element, and a <PricedItineraries>
element, or an <Errors> element. The <OTA_AirLowFareSearchRS> element also has
a group of attributes named OTA_PayloadStdAttributes.</p>
<p>The choice between the sequence starting with the <Success> element and the
<Errors> element is represented in the Java code with an internal state variable.
The public methods <code>ifSuccess()</code> and <code>ifErrors()</code> allow you to
check the state currently set for an instance of the class, while any of the set
methods for values (<code>setSuccess()</code>, <code>setWarnings()</code>,'
<code>setPricedItineraries()</code>, and <code>setErrors()</code>) check the internal
state. If the state is not yet set when one of these methods is called, the state is
set to match the value. If the state is set to a conflicting choice, an
<code>IllegalStateException</code> is thrown. There's also a <code>clearChoiceSelect()</code>
method which allows you to clear the current state. These methods all work together
to enforce the semantics of the choice structure of the schema definition. There are
other options for the details of how choices are implemented, though - see the
<a href="codegen-customs.html#choice-exposed">choice-exposed</a> and
<a href="codegen-customs.html#choice-handling">choice-handling</a> customization attributes.</p>
<p>The <code>PricedItinerariesType</code> class shows the default handling for repeated
values, as a Java 5 typed collection with simple get/set access methods. As with the
choice handling, you can use customizations to change the list handling - see the
<a href="codegen-customs.html#repeated-type">repeated-type</a> customization, which is used in
<a href="example-custom2.html">Example 3: More extensive customizations</a> to change the
generated code to use arrays rather than lists. If you stay with lists (either using the
Java 5 typed default, or untyped lists compatible with older versions of Java) you can
add convenience methods to the list handling using a
<a href="codegen-extends.html#extend"><class-decorator> customization</a> referencing the
<code>org.jibx.schema.codegen.extend.CollectionMethodsDecorator</code>.</p>
<p>You can also see from the code listing how CodeGen uses schema documentation components
in creating class and method JavaDocs. The class JavaDoc begins with any documentation
for the corresponding schema component (see <a href="codegen-customs.html#import-docs">import-docs</a>),
followed by the actual schema fragment matching the class (see
<a href="codegen-customs.html#show-schema">show-schema</a> and
<a href="codegen-customs.html#delete-annotations">delete-annotations</a>). The get/set access
methods for each value in a class describe the schema equivalent of the value (as an
element or attribute name) in the first sentence, followed by any schema documentation
provided for that element or attribute (again controlled by
<a href="codegen-customs.html#import-docs">import-docs</a>).</p>
<p>Next: <a href="example-custom1.html">Example 2: Generating only the required classes</a></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>
|