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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Going further with bindings</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>Going further with bindings</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="../../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.html">Binding Tutorial</a>
</small>
<div>
<small>
<a href="binding-start.html">A basic binding</a>
</small>
</div>
<div>
<small>
<span class="menu-selection">Binding extras</span>
</small>
</div>
<div>
<small>
<a href="binding-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="binding-collects.html">Collections and arrays</a>
</small>
</div>
<div>
<small>
<a href="binding-mappings.html">Using mappings</a>
</small>
</div>
<div>
<small>
<a href="binding-advanced.html">Advanced binding</a>
</small>
</div>
<div>
<small>
<a href="binding-extend.html">Method hooks</a>
</small>
</div>
<div>
<small>
<a href="binding-custom.html">Custom code</a>
</small>
</div>
</div>
<div>
<small>
<a href="../precompiled.html">Precompiled Bindings</a>
</small>
</div>
<div>
<small>
<a href="../binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="../contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="../conversions.html">Conversions</a>
</small>
<div>
<small>
<a href="../date-time.html">Date/time conversions</a>
</small>
</div>
</div>
<div>
<small>
<a href="../xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="../binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="../include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="../format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="../namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="../mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="../value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="../structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="../collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="../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="variations">Variations on a theme</a></h3>
<p>The first simple example only used required elements and public fields. JiBX
isn't limited to just these choices, though. You can also work with optional
elements and attributes in your XML, and with both fields and get/set access
methods using any access level. <a href="#figure2">Figure 2</a> gives an example of some of these
features. I've shown the changes to the XML representation from <a href="binding-start.html#figure1">Figure 1</a> in blue,
and the changes to the Java representation in green.</p>
<a name="figure2"><b>Figure 2. Attributes, optional, access, and more...</b></a><br>
<img src="images/example2.gif" width="584" height="362" alt="Attributes, optional, etc."/>
<p>I added <b>value-style="attribute"</b> to the <b>structure</b>
element of the binding definition in order to change the expression of the child
values in the XML from the default of elements to attributes. The
<b>value-style</b> attribute can be used on any of the binding definition
elements that can contain <b>value</b> elements. It changes the default style for
all nested <b>value</b> elements. The actual <b>value</b> element always has the
final say over its XML representation, though, using the <b>style</b> attribute.
In the <a href="#figure2">Figure 2</a> binding the <b>value</b> definition for the <code>lastName</code>
field illustrates this, using an XML representation of <b>text</b> rather than
the <b>attribute</b> representation used for the other fields of the
<code>Person</code> class. The end result is the changed <b>person</b> element
structure in the XML document, with the customer number and first name as
attributes and the last name as text content of the element.</p>
<p>The other change in the XML handling shown in <a href="#figure2">Figure 2</a> is that I made the
<b>zip</b> element optional (and deleted it from the document shown). This change
is shown in the binding definition by the addition of <b>usage="optional"</b> to
the zip element value definition. Using everything as shown, the <code>zip</code>
field will be set to <code>null</code> when unmarshalling the document. You can
also define defaults for optional values. When you unmarshal a document with the
value missing, the default you specify will be used instead. When you marshal
objects to create a document, the value present will be compared to the default.
If the value is the same as the default, JiBX will skip writing the value to the
XML document.</p>
<p>The access methods added on the Java side are reflected in the binding
definition by the use of <b>get-method</b> and <b>set-method</b> attributes on
the appropriate <b>value</b> elements. If both <b>get-method</b> and
<b>set-method</b> are supplied there's no need to include a field name, as shown
by the value definition for the customer number. You can also use a get or set
method in conjunction with direct access to the field, as shown for the phone
number binding. When you do this the supplied method will be used where
possible, with direct field access used for storing values when only a get
method is supplied, or for loading values when only a set method is supplied.</p>
<p>I also changed the type of the <code>zip</code> field in the Java code, from
<code>java.lang.Integer</code> to <code>java.lang.Object</code>. It's sometimes
convenient to use generic types like <code>Object</code> (or interfaces) in
code, even when you know the runtime type is going to be something more
specific. But JiBX needs to know what type to create when unmarshalling a value,
and <code>Object</code> can't be used directly for that purpose. The <b>type</b>
attribute allows you to override the type defined in the source code for a field
(or get/set methods) with a more specific type. In this case I've given
<code>java.lang.Integer</code> as the actual type to be assumed when working
with the <code>zip</code> field.</p>
<p>For full details on the options available for the <b>value</b> element see
the <a href="../value-element.html"><value> element</a> details page.</p>
</div>
<div class="h3">
<h3><a name="mixing">Mixing it up</a></h3>
<p>Another sometimes useful variation supported by JiBX is the ability to use
either ordered or unordered lists of child elements. By default, JiBX assumes
that elements in the XML document are in a fixed order. This allows for more
efficient unmarshalling of documents, and also reflects the most-common usage of
XML. For the exceptional cases where elements are not ordered JiBX allows the
default behavior to be overridden. <a href="#figure3">Figure 3</a> shows how this works, with changes
from <a href="binding-start.html#figure1">Figure 1</a> again highlighted in color.</p>
<a name="figure3"><b>Figure 3. Unordered elements</b></a><br>
<img src="images/example3.gif" width="622" height="312" alt="Unordered elements"/>
<p>As compared to <a href="binding-start.html#figure1">Figure 1</a>, here I've added an
<b>ordered="false"</b> attribute on the <b>mapping</b> element, and also added
<b>usage="optional"</b> on all the
child components of the <b>mapping</b> element in the binding. The first change
tells JiBX that I want to use unordered child elements within the <b>customer</b>
element. The second change, making all the child components optional, used to be
required for an unordered group. As of the 1.1 release this is no longer the
case, so the same binding would work if you took off the <b>usage="optional"</b>
attributes (and would throw an exception at runtime if one of the required
elements was not found when unmarshalling). I've scrambled the
child elements within the XML document in <a href="#figure3">Figure 3</a> to
illustrate the unordered operation.</p>
<p>Note that the <b>ordered="false"</b> setting only applies to the children of
the element with the setting. In the <a href="#figure3">Figure 3</a> example, this means that the
<b>person</b> element of the XML document can occur in any order amoung the
children of the <b>customer</b> element, but the children of the <b>person</b>
element still have to be in their original order. If I wanted to change this I'd
need to add the <b>ordered="false"</b> setting on the <b>structure</b> element
of the binding definition and make all the child elements optional.</p>
<p>As of the JiBX 1.1 release, you have the option of ignoring unknown
elements within an unordered group. To enable this behavior you need to include
a <b>flexible="true"</b> on the binding element containing the group (the same
place you set the <b>ordered="false"</b>). Also as of 1.1, repeated elements
within an unordered group will by default be treated as an error when
unmarshalling (so if the <a href="#figure3">Figure 3</a> sample document had a
second instance of the <b><address></b> element, for instance, the runtime
code would throw an exception). You can disable this checking for repeated
elements by using the <b>allow-repeats="true"</b> attribute on the containing
element. Both these options can only be used in combination with
<b>ordered="false"</b> - if you're using an ordered group, JiBX expects the
elements to be exactly as specified. See the
<a href="../binding-attributes.html#structure">structure attribute</a> description for full
details on these options.</p>
<p>There's one more change I made in <a href="#figure3">Figure 3</a>, though this is a change just for
the purpose of showing that it has no effect. This is the reordering of the
fields within the <code>Person</code> class. The order of the fields in the
class definition is ignored by JiBX - only the order of binding definitions that
reference these fields matter. In this case I kept the order of the <b>value</b>
binding components within the <b>structure</b> definition for the
<code>Person</code> class unchanged, so the XML representation for this class
also remained the same.</p>
<div><p align="center"><a href="binding-structures.html"><b>Next: Structure mapping between XML and Java</b></a></p></div>
</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>
|
