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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Advanced binding features</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>Advanced binding features</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>
<a href="binding-extras.html">Binding extras</a>
</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>
<span class="menu-selection">Advanced binding</span>
</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="inner-classes">Inner classes</a></h3>
<p>JiBX fully supports working with inner classes, but there are a couple of
potential surprises in how these are handled. First off is the name representation.
The Java source code naming rules treat classes the same as packages, which leads to
some serious ambiguity. For instance, there's no way to determine whether the
class name <code>org.jibx.Abc.Def</code> refers to a class <code>Def</code> in the
package <code>org.jibx.Abc</code> or to an inner class <code>Def</code> of the
class <code>org.jibx.Abc</code>. To avoid this ambiguity, JiBX uses the naming
rules Java applies in generated bytecode, where the character '$' is used as a
separator between a class name and the name of an inner class. So when you're
working with JiBX binding definitions, the class name <code>org.jibx.Abc.Def</code>
always refers to a class <code>Def</code> in the package <code>org.jibx.Abc</code>,
while the class name <code>org.jibx.Abc$Def</code> always refers to an inner class
<code>Def</code> of the class <code>org.jibx.Abc</code>.</p>
<p>The second issue users sometimes run into when using inner classes with JiBX
is that non-static inner classes can't be used directly for unmarshalling. This
is because each non-static inner class instance contains a hidden reference to
the "owning" outer class instance. You can still work with such non-static inner
classes using JiBX, but you need to use a factory method to create an instance
of the class (see <a href="binding-extend.html#extmeths">User extension
method hooks</a> for details of working with factory methods).</p>
</div>
<div class="h3">
<h3><a name="enumerations">Enumerations</a></h3>
<p>You can use all types of enumerations with JiBX, including both "official"
Java 5 enum types and various forms of typesafe enumerations which are compatible
with earlier Java versions. Enumerations normally represent simple string values,
so they're represented in the binding definition using a <b>value</b> element
(though if you have an enumeration with complex structure, you can instead use a
<b>structure</b> element just as you would for any other complex class).</p>
<p>Simple Java 5 enum types, where the value to be used in the XML representation
is the same as the enum name, are handled automatically by JiBX. If the value for
the XML representation is different from the enum name, you can use the
<b>enum-value-method</b> attribute of the binding <b>value</b> element (technically
part of the <a href="../binding-attributes.html#string">string attribute group</a>) to tell
JiBX which method should be called to obtain the XML representation. The specified
method must take no parameters and return a <code>String</code> value. This
method will be used both when marshalling, to get the text to output, and when
unmarshalling, to see if an enum instance matches the input text (with each enum
value checked in turn until a match is found).</p>
<p>Other types of enumerations require a little more work. Generally the idea of
an enumeration (especially type-safe enumerations) is that only one instance of
the enumeration type is created for each possible value. For JiBX to work with
such an enumeration type for unmarshalling, you need to define a static
deserialization method which takes a text value and returns the corresponding
enumeration instance (see the section <a href="binding-extend.html#serdeser"><b>Custom
serializers and deserializers</b></a> on the next page of the tutorial for
details). If the enumeration type defines a <code>toString()</code> method which
returns the text value used in the XML representation, you don't need to specify
anything special for marshalling (since JiBX uses the <code>toString()</code>
method by default for any object being marshalled as a <b>value</b>). If
<code>toString()</code> does <i>not</i> return the value to be used in XML, you
also need to define a serialization method (again, see
<a href="binding-extend.html#serdeser"><b>Custom serializers and deserializers</b></a>
for details).</p>
<p>If an enumeration type is used in more than one place in your binding, you
may want to use a <b>format</b> definition for the type. Doing this allows you to
specify the added information in just one place, and then have it used
automatically everywhere that type is referenced. See the
<a href="binding-extend.html#extmeths"><b>User extension method hooks</b></a> section
of the next page for details.</p>
</div>
<div class="h3">
<h3><a name="global">Directions and tracking</a></h3>
<p>The <b>binding</b> element that's the root of every binding definition
supports several attributes that control the overall operation of JiBX when
working with that binding. Two of these attributes are worth special mention
as part of this tutorial.</a></p>
<p>The <b>direction</b> attribute lets you define one-way bindings, supporting
either unmarshalling XML to your object classes (<b>direction="input"</b>) or
marshalling your object classes to XML (<b>direction="output"</b>). If you
only need to go in one direction this can simplify your binding definition and
sometimes even your code, since you don't need to define binding attributes
that are only used for the other direction. By default, you always
need to provide all necessary information for going in both directions.</p>
<p>The <b>track-source</b> attribute lets you add source position tracking
when unmarshalling. This can be useful when you want to be able to relate
unmarshalled objects back to particular locations in an input document (as when
reporting errors to a user, for instance). If you use <b>track-source="true"</b>,
the binding compiler will add code to each of your bound object classes to
implement the <code>org.jibx.runtime.ITrackSource</code> interface, and will set
the source position information for each unmarshalled object. You can then
access the source position information (in terms of document name, line number,
and column number) using the methods provided by the interface (though you'll
need to cast your objects to the interface type in order to do this, since the
interface will not be visible at compile time).</p>
<p>See the <a href="../binding-element.html"><binding> element</a> details page for
information on all the available options.</p>
</div>
<div class="h3">
<h3><a name="namespaces">Working with namespaces</a></h3>
<p>Namespaces are an increasingly important part of working with XML. JiBX provides
full support for namespaces, though the <b>namespace</b> element and the <b>ns</b>
attribute for element and attribute names. <a href="#figure18">Figure 18</a>
gives a simple example of a document with two namespaces defined.</p>
<a name="figure18"><b>Figure 18. Working with namespaces</b></a><br>
<img src="images/advanced1.gif" width="572" height="400" alt="Working with namespaces"/>
<p>Here the first <b>namespace</b> element in the binding definition sets the
<i>http://www.sosnoski.com/ns1</i> namespace as the default for elements within
the context of the customer mapping. This is equivalent to a standard default
namespace definition in XML, which is what JiBX creates when marshalling using this
mapping. The portions of the diagram relating to this namespace are highlighted in
blue.</p>
<p>The second <b>namespace</b> element sets the <i>http://www.sosnoski.com/ns2</i>
namespace as the default for both elements and attributes within the context of
the person mapping. This makes the namespace automatically apply to every name
definition unless you override it with a specific namespace using the <b>ns</b>
attribute. The use of this namespace is highlighted in green in the diagram.</p>
<p>If you have namespace definitions that apply to the entire XML document you
can just define these directly as children of the <b>binding</b> element. The
effect of placing a definition there is the same as if it were included separately
within each top-level mapping definition.</p>
<p>See the <a href="../namespace-element.html"><namespace> element</a> details page for
more information on working with namespaces in bindings.</p>
</div>
<div class="h3">
<h3><a name="structuring">Structuring bindings</a></h3>
<p>The <b>include</b> element provides a way to structure
your binding definitions to be more modular and reusable by letting you break
them up into pieces. See the <a href="../include-element.html"><include> element</a>
details page for more information on using this type of modular definition
structure, including how namespaces work in combination with included
bindings.</p>
<p>You should also keep in mind that you can use multiple bindings with a single
set of classes. The only requirement to do this is that all the bindings must be
compiled at the same time - if you compile bindings separately, the last one
compiled will wipe out the information from the earlier bindings. This ability
to work with multiple bindings is an important aspect of JiBX's flexiblity,
allowing such uses as working with multiple versions of XML documents in a
single set of Java classes (unlike other frameworks, which would generally
require a separate set of classes for each version of the documents).</p>
<div><p align="center"><a href="binding-extend.html"><b>Next: Method hooks for extending JiBX</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>
|
