File: example-modular.html

package info (click to toggle)
libjibx1.2-java 1.2.6-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 26,144 kB
  • ctags: 24,132
  • sloc: java: 75,013; xml: 14,068; makefile: 36; sh: 13
file content (713 lines) | stat: -rw-r--r-- 30,079 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>Example 4: Modular 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 4: Modular 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>
                    <a href="example-default.html">Default Generation</a>
                  </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>
                    <span class="menu-selection">Modular Generation</span>
                  </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">&lt;binding&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/include-element.html">&lt;include&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/format-element.html">&lt;format&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/namespace-element.html">&lt;namespace&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/mapping-element.html">&lt;mapping&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/value-element.html">&lt;value&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/structure-element.html">&lt;structure&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/collection-element.html">&lt;collection&gt; 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">
      <a name="intro"></a><h3>Splitting and sharing code</h3>

<p>Large organizations often have separate teams working with different parts of
a large set of schemas. For instance, the full set of OTA schemas include groupings
used for air travel, hotels, automobile rentals, cruises, and more. Different teams
within a single company may be working with one or more of these groupings. It's often
useful to let the teams working with particular portions of the schemas handle their
own data models, while still using a common model for the shared portions (so that
application code working with the shared portions will be compatible organization-wide,
facilitating code reuse and making it easy to combine different projects, when
necessary). This localized control of the data model is even more important when the
organization is building schemas for data exchange, rather than just using supplied
schemas.</p>

<p>CodeGen suports modular code generation to allow organizations flexibility in their
use of schema-based data models. With modular code generation, you start by generating
one or more self-contained schema subsets. The code and binding generated for each
self-contained subset is a base module which can be compiled into class files and bound
by the JiBX binding compiler. The bound class files can be kept as loose files, or more
commonly assembled into a jar file.</p>

<p>You can then generate other modules extending those already generated, from schemas
which build on the previously-generated schemas. The code in the extension modules
reference the Java classes and data bindings generated for the base modules. Each separate
module can again be compiled and bound by the JiBX binding compiler independently, only
needing access to the binding definitions and bound classes (whether loose, or in a jar)
of the appropriate base modules.</p>

<p>To demonstrate how modular generation works, this example splits the OTA schema
subset used by all the CodeGen examples into two modules. The first module consists of
common definitions used across the full range of OTA schemas, and is generated from the
<i>OTA_CommonPrefs.xsd</i>, <i>OTA_CommonTypes.xsd</i>, and <i>OTA_SimpleTypes.xsd</i>
schemas. The second module consists of the air travel-related definitions, generated
from the <i>OTA_AirCommonTypes.xsd</i>, <i>OTA_AirLowFareSearchRQ.xsd</i>,
<i>OTA_AirLowFareSearchRS.xsd</i>, and <i>OTA_AirPreferences.xsd</i> schemas.</p>

</div>
<div class="h3">
<a name="common"></a><h3>Common definitions module</h3>

<p>Since the code generation is done in two parts there are two separate customizations
used. Both customizations are based on the <a href="example-custom2.html#custom">Example 3 customizations</a>.
Here's the <i>custom3a.xml</i> customization file, used for the first generation step
(common definitions module):</p>

<div id="source"><pre>&lt;schema-set prefer-inline="true" package="org.ota.common"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    type-substitutions="xs:integer xs:int xs:decimal xs:float"
    binding-file-name="base-binding.xml">
  &lt;name-converter strip-prefixes="OTA_"
      strip-suffixes="Type AttributeGroup Group Attributes"/>
  &lt;schema-type type-name="dateTime" java-class="org.joda.time.DateTime"
      serializer="org.jibx.runtime.JodaConvert.serializeUTCDateTime"
      deserializer="org.jibx.runtime.JodaConvert.deserializeUTCDateTime"/>
  &lt;schema-type type-name="date" format-name="LocalDate.default"/>
  &lt;schema-type type-name="time" format-name="LocalTime.local"/>
  &lt;schema name="OTA_CommonTypes.xsd" excludes="ConnectionType">
    &lt;complexType name="SourceType">
      &lt;element path="**" name="Position" ignore="true"/>
      &lt;element path="**" name="BookingChannel" ignore="true"/>
    &lt;/complexType>
  &lt;/schema>
&lt;/schema-set>
</pre></div>

<p>This <i>custom3a.xml</i> customization only applies to the common definitions, so
the portions of the <i>custom2.xml</i> customization which apply to the air travel
schemas are removed. The <i>custom2.xml</i> file has an attribute <code>generate-all="false"</code>
on the root &lt;schema-set> element, which has been removed from this customization.
This change is necessary so that CodeGen will actually generate all the components
necessary to represent the common definitions. Alternatively, if you knew you were only
going to be using some specified components from the common definitions you could keep the
<code>generate-all="false"</code> attribute and just list the components to be generated,
as done for Example 3 (and as also done for the second generation step in this modular
approach).</p>

<p>The target package used for the generated classes is also different in this customization.
The different package is necessary when using modular generation to prevent conflicts
when running the JiBX binding compiler, but generally convenient in any case to make it
easy to keep classes from different modules separate.</p>

<p>Finally, there's an added
<a href="codegen-customs.html#binding-file-name"><code>binding-file-name="base-binding.xml"</code></a>
attribute on the root &lt;schema-set> element. This attribute gives a name to be used for
the generated root binding. It's not necessary to specify a name in this way when using
modular generation, but it does help clarify the use of the different generated bindings.</p>

<p>There's one quirk in generating the common definitions as a separate module. The OTA
schemas are structured so that only the top-level message schemas
(<i>OTA_AirLowFareSearchRQ.xsd</i> and <i>OTA_AirLowFareSearchRS.xsd</i>, in the subset
of OTA schemas used for these examples) define a target namespace. All the other schemas
function as what are called "chameleon schemas", meaning that they do not define a target
namespace directly but instead assume a target namespace when they are included (directly
or indirectly) into one of the message schemas.</p>

<p>To generate the common definitions in the OTA namespace another CodeGen parameter
needs to be used. This is the "-u" parameter, which tells CodeGen to force a namespace
for schemas which do not specify one. Here's the complete Ant target used for generating
the common definitions:</p>

<div id="source"><pre>&lt;!-- modular generation of common types -->
  &lt;target name="custgen3a" depends="check-runtime,clean">
    
    &lt;echo message="Running base code generation from schema"/>
    &lt;delete quiet="true" dir="${basedir}/gen"/>
    &lt;java classname="org.jibx.schema.codegen.CodeGen" fork="yes"
        classpathref="classpath" failonerror="true">
      &lt;arg value="-t"/>
      &lt;arg value="${basedir}/gen/src"/>
      &lt;arg value="-c"/>
      &lt;arg value="${basedir}/custom3a.xml"/>
      &lt;arg value="-u"/>
      &lt;arg value="http://www.opentravel.org/OTA/2003/05"/>
      &lt;arg value="otasubset/OTA_Common*.xsd"/>
    &lt;/java>
    
  &lt;/target>
</pre></div>

</div>
<div class="h3">
<a name="common"></a><h3>Air travel module</h3>

<p>The <i>custom3b.xml</i> customization file is used for the second generation step
(air travel module):</p>

<div id="source"><pre>&lt;schema-set prefer-inline="true" generate-all="false" package="org.ota.air"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    type-substitutions="xs:integer xs:int xs:decimal xs:float">
  &lt;name-converter strip-prefixes="OTA_"
      strip-suffixes="Type AttributeGroup Group Attributes"/>
  &lt;schema-type type-name="dateTime" java-class="org.joda.time.DateTime"
      serializer="org.jibx.runtime.JodaConvert.serializeUTCDateTime"
      deserializer="org.jibx.runtime.JodaConvert.deserializeUTCDateTime"/>
  &lt;schema-type type-name="date" format-name="LocalDate.default"/>
  &lt;schema-type type-name="time" format-name="LocalTime.local"/>
  &lt;schema name="OTA_AirLowFareSearchRQ.xsd" includes="OTA_AirLowFareSearchRQ">
    &lt;element name="OTA_AirLowFareSearchRQ" class-name="LowFareSearchRequest">
      &lt;element path="**" name="AlternateLocationInfo" ignore="true"/>
      &lt;element path="**" name="SpecificFlightInfo" ignore="true"/>
      &lt;element path="**" name="ProcessingInfo" ignore="true"/>
    &lt;/element>
  &lt;/schema>
  &lt;schema name="OTA_AirLowFareSearchRS.xsd" includes="OTA_AirLowFareSearchRS">
    &lt;element name="OTA_AirLowFareSearchRS" class-name="LowFareSearchResponse"/>
  &lt;/schema>
  &lt;schema name="OTA_AirCommonTypes.xsd">
    &lt;complexType name="FareType">
      &lt;element path="**" name="Taxes" ignore="true"/>
      &lt;element path="**" name="Fees" ignore="true"/>
      &lt;element path="**" name="FareConstruction" ignore="true"/>
      &lt;element path="**" name="UnstructuredFareCalc" ignore="true"/>
    &lt;/complexType>
    &lt;complexType name="FareInfoType">
      &lt;element path="**" name="Date" ignore="true"/>
      &lt;element path="**" name="FareInfo" ignore="true"/>
    &lt;/complexType>
    &lt;complexType name="PricedItinerariesType">
      &lt;attribute path="**" name="OriginDestinationRefNumber"
          value-name="refNumber"/>
    &lt;/complexType>
    &lt;complexType name="PricedItineraryType">
      &lt;element path="**" name="AirItinerary" ignore="true"/>
      &lt;element path="**" name="AirItineraryPricingInfo"
          value-name="pricingInfo"/>
      &lt;element path="**" name="Notes" ignore="true"/>
      &lt;element path="**" name="TicketingInfo" ignore="true"/>
    &lt;/complexType>
    &lt;complexType name="AirItineraryPricingInfoType">
      &lt;element path="**" name="PTC_FareBreakdowns" ignore="true"/>
    &lt;/complexType>
    &lt;complexType name="TravelerInformationType">
      &lt;element path="**" name="AirTraveler" ignore="true"/>
    &lt;/complexType>
    &lt;complexType name="TravelerInfoSummaryType">
      &lt;element path="**" name="PriceRequestInformation" ignore="true"/>
    &lt;/complexType>
  &lt;/schema>
  &lt;schema name="OTA_AirPreferences.xsd">
    &lt;complexType name="AirSearchPrefsType">
      &lt;element path="**" name="VendorPref" ignore="true"/>
      &lt;element path="**" name="FlightTypePref" ignore="true"/>
      &lt;element path="**" name="EquipPref" ignore="true"/>
      &lt;element path="**" name="CabinPref" ignore="true"/>
      &lt;element path="**" name="TicketDistribPref" ignore="true"/>
    &lt;/complexType>
  &lt;/schema>
&lt;/schema-set></pre></div>

<p>This is essentially identical to the <i>custom2.xml</i> file used for Example 3,
differing only by missing the reference to the schemas in the common definitions.</p>

<p>CodeGen has to know about the existing modules in order to use them when generating
an extension module. This is done by using the "-i" command line parameter to give the
paths to the binding definitions for any existing modules. CodeGen will use the supplied
binding definitions for any matching schema components, rather than generating new
classes and bindings. Here's the complete Ant target used for generating the air travel
extension module:</p>

<div id="source"><pre>  &lt;target name="custgen3b" depends="check-runtime,check-base,clean-partial">
    
    &lt;echo message="Running extension code generation from schema"/>
    &lt;java classname="org.jibx.schema.codegen.CodeGen" fork="yes"
        failonerror="true">
      &lt;classpath>
        &lt;path refid="classpath"/>
        &lt;pathelement location="${basedir}/base.jar"/>
      &lt;/classpath>
      &lt;arg value="-t"/>
      &lt;arg value="${basedir}/gen/src"/>
      &lt;arg value="-i"/>
      &lt;arg value="classpath:base-binding.xml"/>
      &lt;arg value="-c"/>
      &lt;arg value="${basedir}/custom3b.xml"/>
      &lt;arg value="otasubset/OTA_AirLowFareSearch*.xsd"/>
    &lt;/java>
    
  &lt;/target>
</pre></div>

</div>
<div class="h3">
<a name="code"></a><h3>Generated code</h3>

<p>First run the 'custgen3a' target and view the common definitions module code in the
<i>base/src</i> directory, then run the 'buildbase' target to compile, bind, and jar the
common definitions. Once that's done, you can run the 'custgen3b' target and view the air
travel module code in the <i>gen/src</i> directory. To compile and bind the air travel
module use the 'buildext' target. Finally, you can run the test program to roundtrip the
sample documents with the 'runmodular' target. You can also just run the 'modular' target
to perform all these steps in sequence.</p>

<p>The generated code is very similar in structure to that from the prior examples, so
is not shown here. The main difference is that since all the common definitions were
generated separately they're in unique classes and cannot be inlined at the point of
use (though there are exceptions - by default, CodeGen always inlines attribute group
or group definitions which only contain a single component).</p>

<p>Since all the common definitions are generated as separate classes (except trivial
attribute groups and groups) the total number of classes is considerably higher than in
the last example: 185 top-level classes and 67 inner classes, for a total of 252, in the
common definitions module; plus 7 top-level classes and 26 inner classes, for a total
of 33, in the air travel module. This increased number of classes from the last example
represents a tradeoff for the convenience of a separate common definitions module.</p>

      </div>
      </div>
      </div>


      </td>
    </tr>
  </tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
  <tbody>
    <tr>
      <td> &copy; 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>