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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: Getting Started with JiBX</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>JiBX: Getting Started with JiBX</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>
<span class="menu-selection">Getting Started</span>
</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-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-collects.html">Collections</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-mappings.html">Using mappings</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="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="install">Installation</a></h3>
<p>To install JiBX, just download the distribution <i>zip</i> file and unpack it.
This will create a <i>jibx</i> directory that contains the distribution files,
including a complete copy of this documentation. The <i>readme.html</i> file in
the unpacked root directory gives more information and links to some included
demonstration code, and to the local copy of this documentation.</p>
<p>If you're using Maven, you can use the JiBX repository
at <a href="http://jibx.sourceforge.net/maven/">http://jibx.sourceforge.net/maven/</a>
to get a specific version of the distribution jar files (as <i>jibx-bind-1.0.jar</i>,
<i>jibx-run-1.0.jar</i>, etc.). There's also a <a href="http://jibx.sourceforge.net/maven-jibx-plugin/">
Maven2 plugin</a> available for JiBX.</p>
</div>
<div class="h3">
<h3><a name="binding">Binding definitions</a></h3>
<p>To use JiBX, you'll need to first create a binding definition that describes
how your XML documents are connected to your Java objects. Here's a simple
example just to give you a feeling for how this works:</p>
<a name="figure1"><b>Figure 1. Simple binding example</b></a><br>
<img src="images/simple-binding.gif" width="653" height="211" alt="Simple binding"/>
<p>In this example I've got an XML document with a <b><customer></b> root element
that I want to bind to a <code>Customer</code> class in my Java code. The
<b>binding definition</b> tells JiBX the details of how this binding is to be
performed. The color coding in the diagram shows how the three parts interrelate.
The <b>mapping</b> element within the binding definition (shown in green)
creates the basic linkage between the <b><customer></b> element and the
<code>Customer</code> class. The child elements of the <b>mapping</b>
element provide the details of this linkage - for example, the first <b>value</b>
child element (shown in blue) links the <b><first-name></b> child element to
the <code>firstName</code> field of the <code>Customer</code> class.</p>
<p>JiBX's binding capabilities go far beyond what's shown by this simple example. On the
Java side, you can use fields of any access type (including <code>private</code>),
or use JavaBean-style get/set methods if you prefer. You can easily define
custom serialization handlers for data values, and you can tell JiBX to call
your own methods at various points in the binding process to allow further
customizations. To learn more about using these and many other JiBX features
check out the <a href="tutorial/binding-tutorial.html">Binding Tutorial</a> section of this site.</p>
<p>If you're starting from existing Java code you may find the <a
href="./jibxtools/index.html">Generator Tools</a> subproject useful. This includes a tool which
will generate a default binding for a set of Java classes (and a separate tool
to generate an XML schema definition from a binding definition and the
referenced Java classes). Similarly, if you're starting from an XML schema
definition you may find the <a href="xsd2jibx/index.html">Xsd2Jibx</a> subproject
useful. This provides a tool to generate a set of Java classes and a
corresponding binding definition from a schema. These subprojects can help a lot
in getting started, but you should still take the time to understand
how bindings work before you go too far with JiBX.</p>
</div>
<div class="h3">
<h3><a name="using">Using JiBX</a></h3>
<p>Once you've got a binding definition for your document format you're ready
to begin using JiBX. To do this, you first compile your application classes as
normal, then run the <a href="bindcomp.html">JiBX Binding Compiler</a>. The binding
compiler converts your binding definition into actual code in the form of binding
methods that it adds to your application class files (you can also
<a href="bindonload.html">run the binding compiler at runtime</a>, to modify your
classes before they're loaded into the JVM). The methods added by the binding
compiler are then used by the <a href="runtime.html">JiBX Runtime</a> to actually
marshal and unmarshal your Java classes to and from XML.</p>
</div>
<div class="h3">
<h3><a name="starter">Starter project</a></h3>
<p>The JiBX distribution includes an example starter project, with an Ant
<i>build.xml</i> script for compiling, binding, and running the project
code. This is found in the <i>starter</i> directory off the installation root.
See the <i>index.html</i> page in this directory for details.</p>
</div>
<div class="h3">
<h3><a name="details">Details</a></h3>
<p>That's the summary. Here are the links for the details of these steps,
along with information on some useful tools included in the distribution:</p>
<ul>
<li><a href="tutorial/binding-tutorial.html"><b>Binding Tutorial</b></a></li>
<li><a href="bindcomp.html"><b>Binding Compiler</b></a></li>
<li><a href="bindonload.html"><b>Bind on Load</b></a></li>
<li><a href="runtime.html"><b>Runtime</b></a></li>
<li><a href="extras.html"><b>Extras</b></a></li>
</ul>
</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>
|
