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
|
<!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">
<img src="http://sourceforge.net/sflogo.php?group_id=69358&type=5"
width="210" height="62" border="0" alt="SourceForge.net Logo"></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="http://wiki.jibx.org">Wiki</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="../flexibility.html">Flexibility</a>
</small>
</div>
<div>
<small>
<a href="../performance.html">Performance</a>
</small>
</div>
<div>
<small>
<a href="../clean-code.html">Clean code</a>
</small>
</div>
</div>
<div>
<small>
<a href="../status.html">News and Status</a>
</small>
</div>
<div>
<small>
<a href="../comments.html">User Comments</a>
</small>
</div>
<div>
<small>
<a href="../bugs.html">Bugs</a>
</small>
</div>
<div>
<small>
<a href="../start.html">Getting Started</a>
</small>
<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</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="../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">JiBX Extras</a>
</small>
</div>
<div>
<small>
<a href="../building.html">Building JiBX</a>
</small>
</div>
</div>
<div>
<small>
<a href="../schema.html">Schema Compatibility</a>
</small>
</div>
<div>
<small>
<a href="../mail-lists.html">Mailing Lists</a>
</small>
</div>
<div>
<small>
<a href="../faq.html">FAQ</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>
<strong>Binding Definition</strong>
<div>
<small>
<a href="../details/binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="../details/contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="../details/conversions.html">Conversions</a>
</small>
</div>
<div>
<small>
<a href="../details/xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="../details/binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="../details/include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="../details/format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="../details/namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="../details/mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="../details/value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="../details/structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="../details/collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="../details/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="../jibxtools/index.html">Generator Tools</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/index.html">JibxSoap</a>
</small>
</div>
<div>
<small>
<a href="../siteamatic/index.html">SiteAMatic</a>
</small>
</div>
<div>
<small>
<a href="../xsd2jibx/index.html">Xsd2Jibx</a>
</small>
</div>
</div>
</div>
</td>
<td>
<div id="bodycol">
<div class="app">
<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="../details/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="../details/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="../details/include-element.html"><include> element</a>
details page for more information on using this type of modular definition
structure.</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-2005, Dennis M. Sosnoski (<a href="http://www.sosnoski.com">Sosnoski Software Solutions, Inc.</a>).
Licensed to the JiBX Project for free distribution and use. </td>
</tr>
</tbody>
</table>
</div>
<br>
</body>
</html>
|
