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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Example 2: Customizing value usage, and required/optional</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 2: Customizing value usage, and required/optional</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>
<span class="menu-selection">Example 2</span>
</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"><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>Customizing BindGen code generation</h3>
<p>You can supply a customization file to BindGen to control many aspects of the schema
and binding generation. Three separate customization examples are included in the
<i>samples/bindgen</i> directory. This page discusses the first customization example
(<i>custom1.xml</i>), which demonstrates controlling the values used from a class, how
the values are accessed, and whether the values are optional or required.</p>
<p>To pass the customization file to BindGen you need to use a '-c' command line
parameter, followed by the actual path to the customization file. In the supplied Ant
<i>build.xml</i> file the details of this may be a little obscure, due to the use of
properties to select the customization and version of the Java code. Here's what the
Ant target to run BindGen with customizations would look like if written without using
properties:</p>
<div id="source"><pre> <!-- generate custom binding and schema -->
<target name="custgen1">
<echo message="Running BindGen tool"/>
<java classpathref="classpath" fork="true" failonerror="true"
classname="org.jibx.binding.generator.BindGen">
<arg value="-c"/>
<arg value="custom1.xml"/>
<arg value="-s"/>
<arg value="src"/>
<arg value="org.jibx.starter1.Order"/>
</java>
</target>
</pre></div>
</div>
<div class="h3">
<a name="custom"></a><h3>Field vs. property access, values used, and required vs. optional</h3>
<p>Here's the text of <i>custom1.xml</i>:</p>
<div id="source"><pre><custom property-access="true">
<class name="org.jibx.starter1.Address"
includes="street1 city state postCode country" requireds="street1 city"/>
<class name="org.jibx.starter1.Customer"
requireds="firstName lastName customerNumber"/>
<class name="org.jibx.starter1.Item" excludes="description"
requireds="id quantity price"/>
<class name="org.jibx.starter1.Order"
requireds="orderNumber customer billTo shipping orderDate"/>
</custom>
</pre></div>
<p>The <code>property-access="true"</code> attribute on the root 'custom' element
tells BindGen to use property access methods for values, rather than just going
directly to the fields in the class. This applies both to finding the values in the
first place, and to the generated binding. 'property-access' is a nesting attribute,
which means that it can be set on any element of the customizations and applies to
all contained elements (and to any classes not represented by elements in the
customizations) unless overridden by another setting.</p>
<p>This simple example directly specifies each class to be customized with a 'class'
element, using fully-qualified class names (including the package). In this case,
the attributes on the 'class' elements control the values used from each class, the
order of the values in the XML representation, and whether the values are required or
optional. The 'includes' attribute lists the value names to be included in the XML
representation. The 'requireds' attributes list which of the values are required. The
single 'excludes' attribute lists the values (in this case, only one) which are not to
be included in the XML representation. Since property access methods are being used in
this example, the value names in each list are property names as defined by get/set
(or is/set, for <code>boolean</code> values) methods. If field access were being used,
the value names would be the actual field names (optionally with leading prefixes or
trailing suffixes stripped off, as you'll see in a later example).</p>
</div>
<div class="h3">
<a name="order"></a><h3>Value order</h3>
<p>BindGen always inspects each class to find the values to be included in the XML
representation, either directly accessing the fields of the class or (as controlled
by the 'property-access' setting) checking for properties defined by get/set access
methods. If no 'class' customization element is used for the class, the order of
values in the XML representation is the order in which the values are found by
inspecting the class file using the Java Reflection API. With most Java compilers and
JVMs this order will match that of the definitions in the source code, but there's no
guarantee that this will be the case.</p>
<p>The 'includes', 'requireds', and 'optionals' (not used in this case, but just the
inverse of 'requireds') attributes of the 'class' customization element all have an
additional effect besides their main function: The order of values in the lists
controls the order of the corresponding XML elements or attributes. In the case of
attributes this doesn't really matter, but order is important for values represented
by elements. If an 'includes' attribute is used, only those values present in the list
will be used, and they'll be represented in the XML in the same order as in the list.
If no 'includes' attribute is present, order is determined in several steps. If a
'requireds' attribute is present, the values present in that list will be the first
ones in the XML representation, and they'll be in the same order as the list. If an
'optionals' attribute is present, the values present in that list will be next after
those in the 'requireds' list (if any). Any values not included in either a 'requireds'
or 'optionals' list (or an 'excludes' list, of course) will then be added in the default
Java Reflection order.</p>
</div>
<div class="h3">
<a name="schema"></a><h3>Customized 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 'custgen1' target to run BindGen using the
above customizations. Here's the resulting schema (again with the longer
documentation lines split):</p>
<div id="source"><pre><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://jibx.org/starter1"
elementFormDefault="qualified" targetNamespace="http://jibx.org/starter1">
<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>
<xs:element type="xs:string" name="firstName"/>
<xs:element type="xs:string" name="lastName"/>
</xs:sequence>
<xs:attribute type="xs:long" use="required" name="customerNumber"/>
</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>
<xs:element type="xs:string" name="id"/>
</xs:sequence>
<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>If you compare this to the <a href="bindgen-example1.html#schema">Example 1 schema</a> you'll
see that the 'includes', 'excludes', and 'requireds' customization attributes have had
their intended effects: The 'street2' value is now missing from the 'address' complexType
definition (at the top of the listing), since it was left out of the 'includes' list; the
'description' value is now missing from the embedded 'item' definition (near the end of
the listing), since it was listed in the 'excludes' list; and many of the elements which
previously were defined as optional with <code>minOccurs="0"</code> now are required, as
are many of the attributes which now have <code>use="required"</code>, since the
corresponding values were listed in one of the 'requireds' lists.</p>
<p>One thing that hasn't changed is the order of the elements and attributes that are
still present in the schema. The order of value names in the 'includes' and 'requireds'
lists all match the order of the values in the source code, so the order of elements and
attributes in the generated schema definition stays the same. Since the element order
stayed the same, and nothing new has been added, the schema generated using this
customization is compatible with the original default generated schema, in that documents
matching this new schema will also match the original schema (but not necessarily the
other way around - some components which were optional in the original schema are now
required, and the 'street2' and 'description' optional elements in the original schema
are not allowed by the customized schema).</p>
</div>
<div class="h3">
<a name="binding"></a><h3>Generated binding</h3>
<p>Here again, there's not much to be said about the generated binding. It differs from
the <a href="bindgen-example1.html#binding">Example 1 binding</a> in that it uses access methods
rather than direct field access, and reflects the changes to required values shown in
the schema. Here's a sample of the generated binding:</p>
<div id="source"><pre><binding xmlns:tns="http://jibx.org/starter1" name="binding" package="org.jibx.starter1">
<namespace uri="http://jibx.org/starter1" default="elements"/>
<mapping abstract="true" type-name="tns:order" class="org.jibx.starter1.Order">
<value style="attribute" name="orderNumber" get-method="getOrderNumber"
set-method="setOrderNumber"/>
<structure get-method="getCustomer" set-method="setCustomer" name="customer">
<value style="element" name="firstName" get-method="getFirstName"
set-method="setFirstName"/>
<value style="element" name="lastName" get-method="getLastName"
set-method="setLastName"/>
<value style="attribute" name="customerNumber"
get-method="getCustomerNumber" set-method="setCustomerNumber"/>
</structure>
<structure map-as="tns:address" get-method="getBillTo" set-method="setBillTo"
name="billTo"/>
<value style="element" name="shipping" get-method="getShipping"
set-method="setShipping"/>
<value style="attribute" name="orderDate" get-method="getOrderDate"
set-method="setOrderDate"/>
<structure map-as="tns:address" get-method="getShipTo" set-method="setShipTo"
usage="optional" name="shipTo"/>
...</pre></div>
</div>
<div class="h3">
<a name="testing"></a><h3>Testing the binding</h3>
<p>The <a href="bindgen-example1.html#testing">same sample document</a> as used for Example 1
also works with the modified binding and schema. Once you've run the Ant 'compile',
'custgen1', and 'bind' targets you can test the generated binding using the same
'run-base' target as used for Example 1. You can also try out the full 'compile',
'custgen1', 'bind', and 'run-base' sequence by using the Ant target 'custom1'.</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>
|
