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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Generation Tools: Binding Generation Example</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>Generation Tools: Binding Generation Example</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="../bugs.html">Bugs</a>
</small>
</div>
<div>
<small>
<a href="../start.html">Getting Started</a>
</small>
<div>
<small>
<a href="../tutorial/binding-tutorial.html">Binding Tutorial</a>
</small>
<div>
<small>
<a href="../tutorial/binding-start.html">A basic binding</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-extras.html">Binding extras</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-collects.html">Collections</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-advanced.html">Advanced binding</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/binding-extend.html">Method hooks</a>
</small>
</div>
<div>
<small>
<a href="../tutorial/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="index.html">Generator Tools</a>
</small>
<div>
<small>
<a href="index.html">Introduction</a>
</small>
</div>
<div>
<small>
<a href="bindgen.html">Binding Generator</a>
</small>
<div>
<small>
<span class="menu-selection">Example</span>
</small>
</div>
<div>
<small>
<a href="bindopts.html">Options</a>
</small>
</div>
</div>
<div>
<small>
<a href="schemagen.html">Schema Generator</a>
</small>
<div>
<small>
<a href="schema-example.html">Example</a>
</small>
</div>
<div>
<small>
<a href="schemaopts.html">Options</a>
</small>
</div>
</div>
</div>
<div>
<small>
<a href="../jibxsoap/index.html">JibxSoap</a>
</small>
<div>
<small>
<a href="../jibxsoap/index.html">Introduction</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/server.html">Server</a>
</small>
<div>
<small>
<a href="../jibxsoap/server-config.html">Configuration</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/service-def.html">Definition</a>
</small>
</div>
</div>
<div>
<small>
<a href="../jibxsoap/client.html">Client</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/example.html">Example</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/install.html">Install</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/status.html">Status</a>
</small>
</div>
<div>
<small>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/./api/index.html">JavaDocs</a>
</small>
</div>
</div>
<div>
<small>
<a href="../siteamatic/index.html">SiteAMatic</a>
</small>
</div>
<div>
<small>
<a href="../xsd2jibx/index.html">Xsd2Jibx</a>
</small>
</div>
<div>
<small>
<a href="../plugin/index.html">Eclipse Plugin</a>
</small>
</div>
</div>
</div>
</td>
<td>
<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="code">Example code</a></h3>
<p>Here's a set of classes to be used as an example for the binding generation
tool, all from the <code>example</code> package:</p>
<p></p>
<div id="source"><pre>public class Customer {
private Name name;
private Address address;
private Order[] orders;
}
public class Name {
private String firstName;
private String lastName;
}
public class Address {
private String street;
private String city;
private String state;
private Integer zip;
}
import java.math.BigDecimal;
import java.sql.Date;
public class Order {
private Date date;
private BigDecimal amount;
}</pre></div>
</div>
<div class="h3">
<h3><a name="running">Running the binding generator</a></h3>
<p>I'll assume that the above set of classes have been compiled into the
current directory, and that the <i>jibx-genbinding.jar</i> has been copied
into the <i>lib</i> directory of the JiBX installation located at
<i>/home/dennis/jibx</i>. Then to generate a default binding for these classes
I just need to run the following:</p>
<div id="source"><pre>java -jar /home/dennis/jibx/lib/jibx-genbinding.jar example.Customer example.Order</pre></div>
<p>Note that you don't need to specify every class to be included in the binding
definition, only those classes which should be bound using <b><mapping></b>
elements. In this case the <code>example.Customer</code> class is the root
object of the data structure, so it needs to be specified. The
<code>example.Order</code> class also needs to be specified, since it's
referenced as the elements of an array. The other classes which need to be
included in the binding are referenced directly from the
<code>example.Customer</code> class, so these do not need to be specified.</p>
<p>Here's the generated binding, slightly reformatted to fit the page width:</p>
<p></p>
<div id="source"><pre><?xml version="1.0" encoding="UTF-8"?>
<binding forwards="false" value-style="attribute">
<mapping class="example.Customer" name="customer">
<structure field="name" usage="optional" name="name">
<value style="element" name="first-name" field="firstName" usage="optional"/>
<value style="element" name="last-name" field="lastName" usage="optional"/>
</structure>
<structure field="address" usage="optional" name="address">
<value style="element" name="street" field="street" usage="optional"/>
<value style="element" name="city" field="city" usage="optional"/>
<value style="element" name="state" field="state" usage="optional"/>
<value name="zip" field="zip" usage="optional"/>
</structure>
<structure field="orders" usage="optional"
marshaller="org.jibx.extras.TypedArrayMapper"
unmarshaller="org.jibx.extras.TypedArrayMapper"></structure>
</mapping>
<mapping class="example.Order" name="order">
<value name="date" field="date" usage="optional"/>
<value name="amount" field="amount" usage="optional"/>
</mapping>
</binding></pre></div>
</div>
<div class="h3">
<h3><a name="problems">Binding generation problems</a></h3>
<p>Problems and potential problems in the binding generation are reported in the
console output from the binding generator tool. For example, suppose the array
of <code>example.Order</code> references is instead a
<code>java.util.ArrayList</code>:</p>
<p></p>
<div id="source"><pre>import java.util.ArrayList;
public class Customer {
private Name name;
private Address address;
private ArrayList orders;
}</pre></div>
<p>Then running the binding generation tool gives a warning message:</p>
<div id="source"><pre>Warning: field orders requires mapped implementation of item classes</pre></div>
<p>Similar warning or error messages may result from other types of situations
which cannot be handled by the binding generator. The <a
href="bindopts.html">command line options</a>
supported by the binding generator can be used to handle many of these
situations by supplying additional instructions to the binding generator.</p>
</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>
|
