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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Example 3: More nesting, customizing namespaces, element vs. attribute</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 3: More nesting, customizing namespaces, element vs. attribute</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>
<a href="bindgen-example1.html">Example 1</a>
</small>
</div>
<div>
<small>
<a href="bindgen-example2.html">Example 2</a>
</small>
</div>
<div>
<small>
<span class="menu-selection">Example 3</span>
</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"><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">
<a name="custom"></a><h3>Going further with customizations</h3>
<p>The <a href="bindgen-example2.html#custom">Example 2 customizations</a> showed some basic
modifications to BindGen default behavior. Now it's time to go a couple of steps
further, using <i>custom2.xml</i>:</p>
<div id="source"><pre><custom namespace-style="fixed" namespace="http://www.jibx.org/starters/fromcode"
property-access="true">
<package name="org.jibx.starter1">
<class name="Address" includes="street1 city state postCode country"
requireds="street1 city"/>
<class name="Customer" requireds="lastName firstName /customerNumber"/>
<class name="Item" excludes="description" requireds="@id @quantity price"/>
<class name="Order" requireds="orderNumber customer billTo shipping orderDate"/>
</package>
</custom>
</pre></div>
<p>The <code>namespace-style="fixed"</code> attribute on the root 'custom' element
tells BindGen to use fixed namespaces, rather than deriving namespaces from package
names. The <code>namespace="http://www.jibx.org/starters/fromcode"</code> attribute
then defines the namespace to be used. If you want a single, fixed, namespace for all
your XML definitions you need to use both of these attributes together - if you use
the 'namespace' attribute by itself, the namespace you specify will still be modified
for each nested package.</p>
<p>There are three other differences in this customization file, as compared to
the <a href="bindgen-example2.html#custom">Example 2 customizations</a>. The 'package' element
is a convenient wrapper for the 'class' elements, allowing simple class names to be
used on the 'class' elements instead of fully-qualified class names. You can also add
any nesting customization attributes to the 'package' element. So for example, the
'namespace-style', 'namespace', and 'property-access' attributes could all be moved
from the 'custom' element to the 'package' element.</p>
<p>The other differences are in the 'requireds' value lists for the 'Customer' and
'Item' classes. In this version of the customizations, the list of 'requireds' value
names for the 'Customer' class is in a different order and the 'customerNumber' value
name is prefixed with a slash character ('/'), and the 'id' and 'quantity' value names
in the 'requireds' list for the 'Item' class are prefixed with an at-sign character.
These prefix characters tell BindGen to use a specific representation for the values -
a slash character for an element, an at-sign character for an attribute. The prefix
characters can be used for all the attributes which take value name lists: 'includes',
'optionals', and 'requireds' (they're ignored in the case of 'excludes'). Values names
without one of these indicator prefix characters just use the default representation.</p>
</div>
<div class="h3">
<a name="schema"></a><h3>Generated schema</h3>
<p>You can try out the above customization by again using the Ant 'compile' target to
compile the sample code, followed by the 'custgen2' target to run BindGen using the
above customizations. Here's the resulting schema (again with the longer lines split):</p>
<div id="source"><pre><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://www.jibx.org/starters/fromcode" elementFormDefault="qualified"
<b>targetNamespace="http://www.jibx.org/starters/fromcode"</b>>
<xs:complexType name="address">
<xs:annotation>
<xs:documentation>Address information.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element type="xs:string" name="street1"/>
<xs:element type="xs:string" name="city"/>
<xs:element type="xs:string" name="state" minOccurs="0"/>
<xs:element type="xs:string" name="postCode" minOccurs="0"/>
<xs:element type="xs:string" name="country" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:element type="tns:order" name="order"/>
<xs:complexType name="order">
<xs:annotation>
<xs:documentation>Order information.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="customer">
<xs:complexType>
<xs:sequence>
<b><xs:element type="xs:string" name="lastName"/>
<xs:element type="xs:string" name="firstName"/>
<xs:element type="xs:long" name="customerNumber"/></b>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element type="tns:address" name="billTo"/>
<xs:element name="shipping">
<xs:simpleType>
<xs:annotation>
<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.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="STANDARD_MAIL"/>
<xs:enumeration value="PRIORITY_MAIL"/>
<xs:enumeration value="INTERNATIONAL_MAIL"/>
<xs:enumeration value="DOMESTIC_EXPRESS"/>
<xs:enumeration value="INTERNATIONAL_EXPRESS"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element type="tns:address" name="shipTo" minOccurs="0"/>
<xs:element name="item" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence/>
<b><xs:attribute type="xs:string" use="required" name="id"/></b>
<xs:attribute type="xs:int" use="required" name="quantity"/>
<xs:attribute type="xs:float" use="required" name="price"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute type="xs:long" use="required" name="orderNumber"/>
<xs:attribute type="xs:date" use="required" name="orderDate"/>
<xs:attribute type="xs:date" name="shipDate"/>
<xs:attribute type="xs:float" name="total"/>
</xs:complexType>
</xs:schema></pre></div>
<p>Comparing this to the <a href="bindgen-example2.html#schema">Example 2 schema</a> shows that
the schema target namespace has been changed to that specified by the customizations,
the child elements of 'customer' have been reordered, the 'customerNumber' value is now
an element rather than an attribute, and the 'id' value is now an attribute rather than
an element (all changes shown in bold type in the listing). There's no change to the
'quantity' value representation, since that was already an attribute in the original
schema.</p>
</div>
<div class="h3">
<a name="testing"></a><h3>Testing the binding</h3>
<p>Since the actual XML structure has changed with the customizations used for this
example, testing it requires a different document. The <i>data2.xml</i> document in
the <i>examples/bindgen</i> directory uses the same data as <i>data1.xml</i>, but is
restructured to match the schema changes. Here's the document:</p>
<div id="source"><pre><order orderNumber="12345678" orderDate="2008-10-18" shipDate="2008-10-22"
xmlns="http://www.jibx.org/starters/fromcode">
<customer>
<lastName>Smith</lastName>
<firstName>John</firstName>
<customerNumber>5678</customerNumber>
</customer>
<billTo>
<street1>12345 Happy Lane</street1>
<city>Plunk</city>
<state>WA</state>
<postCode>98059</postCode>
<country>USA</country>
</billTo>
<shipping>PRIORITY_MAIL</shipping>
<shipTo>
<street1>333 River Avenue</street1>
<city>Kirkland</city>
<state>WA</state>
<postCode>98034</postCode>
</shipTo>
<item quantity="1" price="5.99" id="FA9498349851"/>
<item quantity="2" price="9.50" id="GC1234905049"/>
<item quantity="1" price="8.95" id="AX9300048820"/>
</order></pre></div>
<p>You can compare this to the <a href="bindgen-example1.html#testing"><i>data1.xml</i></a>
listing to see the changes.</p>
<p>Once you've run the Ant 'compile', 'custgen2', and 'bind' targets you can test the
generated binding using 'run-alt' (which runs the same test program as used by the prior
examples, but with <i>data2.xml</i> as input and <i>out2.xml</i> as output). You can
also try out the full 'compile', 'custgen2', 'bind', and 'run-alt' sequence by using
the Ant target 'custom2'.</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>
|
