File: bindgen-example1.html

package info (click to toggle)
libjibx1.2-java 1.2.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 26,260 kB
  • sloc: java: 75,013; xml: 14,068; makefile: 17
file content (767 lines) | stat: -rw-r--r-- 31,699 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
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
<!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="index.html">Start from Code</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="bindgen.html">BindGen</a>
                  </small>
                              <div>
            <small>
                    <a href="bindgen-examples.html">Example Code</a>
                  </small>
                              <div>
            <small>
                    <span class="menu-selection">Example 1</span>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="bindgen-example2.html">Example 2</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="bindgen-example3.html">Example 3</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="bindgen-example4.html">Example 4</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="bindgen-customs.html">Customizations Reference</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="schemagen.html">SchemaGen</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="jibx2wsdl.html">Jibx2Wsdl</a>
                  </small>
                              <div>
            <small>
                    <a href="jibx2wsdl-examples.html">Examples</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="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">&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">
      <h3><a name="start"></a>BindGen default code generation</h3>

<p>You can use the Ant 'compile' target to compile the sample code, followed by the
'bindgen' target to run BindGen on the Java 5 version of the code with default settings.
Here's the actual 'bindgen' target from the <i>build.xml</i>:</p>

<div id="source"><pre>  &lt;!-- generate default binding and schema -->
  &lt;target name="bindgen">
  
    &lt;echo message="Running BindGen tool"/>
    &lt;java classpathref="classpath" fork="true" failonerror="true"
        classname="org.jibx.binding.generator.BindGen">
      &lt;arg value="-s"/>
      &lt;arg value="src"/>
      &lt;arg value="org.jibx.starter1.Order"/>
    &lt;/java>
    
  &lt;/target>
</pre></div>

<p>This passes the '-s' parameter to BindGen with the value 'src' to tell it the path to
find the source code for the classes to be included in the XML representation. If you
don't supply the source code BindGen can get all the information it needs from the Java
class files (which must be on the classpath used for running BindGen), but without
access to the source code Javadocs it won't be able to generate schema documentation. The
third argument value tells BindGen to use the <code>org.jibx.starter1.Order</code> class
as a root for generating the binding and schema. You can specify as many root classes as
you want when running BindGen, but must have at least one - otherwise there's nothing for
BindGen to generate!</p>

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

<p>BindGen derives the schema namespace(s) from the Java package name(s), in this case
converting the package name 'org.jibx.starter1' to the namespace URI
'http://jibx.org/starter1'. The generated binding file name is just
<i>binding.xml</i>, and the generated schema name is taken from the last part of the
namespace URI: <i>starter1.xsd</i>. Here's the resulting schema (with the longer
documentation lines split for readability):</p>

<div id="source"><pre>&lt;xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://jibx.org/starter1"
    elementFormDefault="qualified" targetNamespace="http://jibx.org/starter1">
  &lt;xs:complexType name="address">
    &lt;xs:annotation>
      &lt;xs:documentation>Address information.&lt;/xs:documentation>
    &lt;/xs:annotation>
    &lt;xs:sequence>
      &lt;xs:element type="xs:string" name="street1" minOccurs="0">
        &lt;xs:annotation>
          &lt;xs:documentation>First line of street information (required).&lt;/xs:documentation>
        &lt;/xs:annotation>
      &lt;/xs:element>
      &lt;xs:element type="xs:string" name="street2" minOccurs="0">
        &lt;xs:annotation>
          &lt;xs:documentation>Second line of street information (optional).&lt;/xs:documentation>
        &lt;/xs:annotation>
      &lt;/xs:element>
      &lt;xs:element type="xs:string" name="city" minOccurs="0"/>
      &lt;xs:element type="xs:string" name="state" minOccurs="0">
        &lt;xs:annotation>
          &lt;xs:documentation>State abbreviation (required for the U.S. and Canada, optional
          otherwise).&lt;/xs:documentation>
        &lt;/xs:annotation>
      &lt;/xs:element>
      &lt;xs:element type="xs:string" name="postCode" minOccurs="0">
        &lt;xs:annotation>
          &lt;xs:documentation>Postal code (required for the U.S. and Canada, optional
          otherwise).&lt;/xs:documentation>
        &lt;/xs:annotation>
      &lt;/xs:element>
      &lt;xs:element type="xs:string" name="country" minOccurs="0">
        &lt;xs:annotation>
          &lt;xs:documentation>Country name (optional, U.S. assumed if not 
          supplied).&lt;/xs:documentation>
        &lt;/xs:annotation>
      &lt;/xs:element>
    &lt;/xs:sequence>
  &lt;/xs:complexType>
  &lt;xs:element type="tns:order" name="order"/>
  &lt;xs:complexType name="order">
    &lt;xs:annotation>
      &lt;xs:documentation>Order information.&lt;/xs:documentation>
    &lt;/xs:annotation>
    &lt;xs:sequence>
      &lt;xs:element name="customer" minOccurs="0">
        &lt;xs:complexType>
          &lt;xs:sequence>
            &lt;xs:element type="xs:string" name="firstName" minOccurs="0">
              &lt;xs:annotation>
                &lt;xs:documentation>Personal name.&lt;/xs:documentation>
              &lt;/xs:annotation>
            &lt;/xs:element>
            &lt;xs:element type="xs:string" name="lastName" minOccurs="0">
              &lt;xs:annotation>
                &lt;xs:documentation>Family name.&lt;/xs:documentation>
              &lt;/xs:annotation>
            &lt;/xs:element>
            &lt;xs:element type="xs:string" name="middleName" minOccurs="0" maxOccurs="unbounded"/>
          &lt;/xs:sequence>
          &lt;xs:attribute type="xs:long" use="required" name="customerNumber"/>
        &lt;/xs:complexType>
      &lt;/xs:element>
      &lt;xs:element type="tns:address" name="billTo" minOccurs="0">
        &lt;xs:annotation>
          &lt;xs:documentation>Billing address information.&lt;/xs:documentation>
        &lt;/xs:annotation>
      &lt;/xs:element>
      &lt;xs:element name="shipping" minOccurs="0">
        &lt;xs:simpleType>
          &lt;xs:annotation>
            &lt;xs:documentation>Supported shipment methods. The "INTERNATIONAL" shipment methods
            can only be used for orders with shipping addresses outside the U.S., and one of these
            methods is required in this case.&lt;/xs:documentation>
          &lt;/xs:annotation>
          &lt;xs:restriction base="xs:string">
            &lt;xs:enumeration value="STANDARD_MAIL"/>
            &lt;xs:enumeration value="PRIORITY_MAIL"/>
            &lt;xs:enumeration value="INTERNATIONAL_MAIL"/>
            &lt;xs:enumeration value="DOMESTIC_EXPRESS"/>
            &lt;xs:enumeration value="INTERNATIONAL_EXPRESS"/>
          &lt;/xs:restriction>
        &lt;/xs:simpleType>
      &lt;/xs:element>
      &lt;xs:element type="tns:address" name="shipTo" minOccurs="0">
        &lt;xs:annotation>
          &lt;xs:documentation>Shipping address information. If missing, the billing address is also
          used as the shipping address.&lt;/xs:documentation>
        &lt;/xs:annotation>
      &lt;/xs:element>
      &lt;xs:element name="item" minOccurs="0" maxOccurs="unbounded">
        &lt;xs:complexType>
          &lt;xs:sequence>
            &lt;xs:element type="xs:string" name="id" minOccurs="0">
              &lt;xs:annotation>
                &lt;xs:documentation>Stock identifier. This is expected to be 12 characters in
                length, with two leading alpha characters followed by ten decimal
                digits.&lt;/xs:documentation>
              &lt;/xs:annotation>
            &lt;/xs:element>
            &lt;xs:element type="xs:string" name="description" minOccurs="0">
              &lt;xs:annotation>
                &lt;xs:documentation>Text description of item.&lt;/xs:documentation>
              &lt;/xs:annotation>
            &lt;/xs:element>
          &lt;/xs:sequence>
          &lt;xs:attribute type="xs:int" use="required" name="quantity">
            &lt;xs:annotation>
              &lt;xs:documentation>Number of units ordered.&lt;/xs:documentation>
            &lt;/xs:annotation>
          &lt;/xs:attribute>
          &lt;xs:attribute type="xs:float" use="required" name="price">
            &lt;xs:annotation>
              &lt;xs:documentation>Price per unit.&lt;/xs:documentation>
            &lt;/xs:annotation>
          &lt;/xs:attribute>
        &lt;/xs:complexType>
      &lt;/xs:element>
    &lt;/xs:sequence>
    &lt;xs:attribute type="xs:long" use="required" name="orderNumber"/>
    &lt;xs:attribute type="xs:date" name="orderDate">
      &lt;xs:annotation>
        &lt;xs:documentation>Date order was placed with server.&lt;/xs:documentation>
      &lt;/xs:annotation>
    &lt;/xs:attribute>
    &lt;xs:attribute type="xs:date" name="shipDate">
      &lt;xs:annotation>
        &lt;xs:documentation>&lt;![CDATA[Date order was shipped. This will be
        &lt;code>null&lt;/code> if the order has not yet shipped.]]>&lt;/xs:documentation>
      &lt;/xs:annotation>
    &lt;/xs:attribute>
    &lt;xs:attribute type="xs:float" name="total"/>
  &lt;/xs:complexType>
&lt;/xs:schema>
</pre></div>

<p>BindGen defaults to a mixed schema style, where type definitions are inlined if they're
only used in one place. In this case that results in only two global complexType definitions:
'address' for the <code>Address</code> class (needed because there are two references to
<code>Address</code> within the <code>Order</code> class) and 'order' for the
<code>Order</code> class. The remaining Java classes are represented by local (i.e., nested)
type definitions embedded within the 'order' type: <code>Customer</code> and <code>Item</code>
as complexType definitions, and <code>Shipping</code> as a simpleType definition. The only
global element definition is for the 'order' element, since that's the one class specified
as input to BindGen.</p>

<p>Simple values of limited length (including Java primitive types, as well as date/time
variations) are represented by default using XML attributes, while elements are used for any
structured data. Elements are also used for <code>java.lang.String</code> values, since
there's no limit on the length of a string and very long attribute values are generally
discouraged in XML. Primitive values are treated as required by default, while object values
are treated as optional (since a <code>null</code> value can easily be used to indicate that
an object value is missing, while primitives have no such marker).</p>

<p>As you can see in the above listing, BindGen automatically creates schema documentation
taken from Java source code Javadocs. By default, BindGen examines the field definitions
within each class to find the data to be included in the XML representation of that class,
and the Javadocs associated with the fields are the source of the schema documentation for
individual elements and attributes. Schema documentation for generated complexType
definitions is taken directly from the corresponding class-level Javadocs. If the Javadoc
includes any HTML or XML tags it's wrapped in a CDATA section, as you can see for the
'shipData' attribute near the end of the listing.</p>

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

<p>There's not a lot to be said about the generated binding, except that it uses direct
field access for values (rather than get/set access methods) and matches the schema in
terms of which values are optional and which required. Here's the generated binding in
full:</p>

<div id="source"><pre>&lt;binding xmlns:tns="http://jibx.org/starter1" name="binding" package="org.jibx.starter1">
  &lt;namespace uri="http://jibx.org/starter1" default="elements"/>
  &lt;mapping abstract="true" type-name="tns:order" class="org.jibx.starter1.Order">
    &lt;value style="attribute" name="orderNumber" field="orderNumber"/>
    &lt;structure field="customer" usage="optional" name="customer">
      &lt;value style="attribute" name="customerNumber" field="customerNumber"/>
      &lt;value style="element" name="firstName" field="firstName" usage="optional"/>
      &lt;value style="element" name="lastName" field="lastName" usage="optional"/>
      &lt;collection field="middleNames" usage="optional" create-type="java.util.ArrayList">
        &lt;value name="middleName" type="java.lang.String"/>
      &lt;/collection>
    &lt;/structure>
    &lt;structure map-as="tns:address" field="billTo" usage="optional" name="billTo"/>
    &lt;value style="element" name="shipping" field="shipping" usage="optional"/>
    &lt;structure map-as="tns:address" field="shipTo" usage="optional" name="shipTo"/>
    &lt;collection field="items" usage="optional" create-type="java.util.ArrayList">
      &lt;structure type="org.jibx.starter1.Item" name="item">
        &lt;value style="element" name="id" field="id" usage="optional"/>
        &lt;value style="element" name="description" field="description" usage="optional"/>
        &lt;value style="attribute" name="quantity" field="quantity"/>
        &lt;value style="attribute" name="price" field="price"/>
      &lt;/structure>
    &lt;/collection>
    &lt;value style="attribute" name="orderDate" field="orderDate" usage="optional"/>
    &lt;value style="attribute" name="shipDate" field="shipDate" usage="optional"/>
    &lt;value style="attribute" name="total" field="total" usage="optional"/>
  &lt;/mapping>
  &lt;mapping class="org.jibx.starter1.Order" name="order">
    &lt;structure map-as="tns:order"/>
  &lt;/mapping>
  &lt;mapping abstract="true" type-name="tns:address" class="org.jibx.starter1.Address">
    &lt;value style="element" name="street1" field="street1" usage="optional"/>
    &lt;value style="element" name="street2" field="street2" usage="optional"/>
    &lt;value style="element" name="city" field="city" usage="optional"/>
    &lt;value style="element" name="state" field="state" usage="optional"/>
    &lt;value style="element" name="postCode" field="postCode" usage="optional"/>
    &lt;value style="element" name="country" field="country" usage="optional"/>
  &lt;/mapping>
&lt;/binding></pre></div>

      </div>
      <div class="h3">
      <a name="testing"></a><h3>Testing the binding</h3>

<p>The <i>examples/bindgen</i> directory includes a sample document, <i>data1.xml</i>,
matching the default generated schema. Here's the listing:</p>

<div id="source"><pre>&lt;order orderNumber="12345678" orderDate="2008-10-18" shipDate="2008-10-22"
    xmlns="http://jibx.org/starter1">
  &lt;customer customerNumber="5678">
    &lt;firstName>John&lt;/firstName>
    &lt;lastName>Smith&lt;/lastName>
  &lt;/customer>
  &lt;billTo>
    &lt;street1>12345 Happy Lane&lt;/street1>
    &lt;city>Plunk&lt;/city>
    &lt;state>WA&lt;/state>
    &lt;postCode>98059&lt;/postCode>
    &lt;country>USA&lt;/country>
  &lt;/billTo>
  &lt;shipping>PRIORITY_MAIL&lt;/shipping>
  &lt;shipTo>
    &lt;street1>333 River Avenue&lt;/street1>
    &lt;city>Kirkland&lt;/city>
    &lt;state>WA&lt;/state>
    &lt;postCode>98034&lt;/postCode>
    &lt;country>USA&lt;/country>
  &lt;/shipTo>
  &lt;item quantity="1" price="5.99">
    &lt;id>FA9498349851&lt;/id>
  &lt;/item>
  &lt;item quantity="2" price="9.50">
    &lt;id>GC1234905049&lt;/id>
  &lt;/item>
  &lt;item quantity="1" price="8.95">
    &lt;id>AX9300048820&lt;/id>
  &lt;/item>
&lt;/order>
</pre></div>

<p>Once you've run the Ant 'compile', 'bindgen', and 'bind' targets you can test the
generated binding using 'run-base' (which runs the supplied test program
<code>org.jibx.starter1.Test</code> to read in the order document, compute the order
total, and write the document back out with total included as <i>out1.xml</i>). You can
also try out the full 'compile', 'bindgen', 'bind', and 'run-base' sequence by using
the Ant target 'full'.</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>