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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: BindGen Tool</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: BindGen Tool</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="index.html">Start from Code</a>
</small>
</div>
<div>
<small>
<span class="menu-selection">BindGen</span>
</small>
<div>
<small>
<a href="bindgen-examples.html">Example Code</a>
</small>
<div>
<small>
<a href="bindgen-example1.html">Example 1</a>
</small>
</div>
<div>
<small>
<a href="bindgen-example2.html">Example 2</a>
</small>
</div>
<div>
<small>
<a href="bindgen-example3.html">Example 3</a>
</small>
</div>
<div>
<small>
<a href="bindgen-example4.html">Example 4</a>
</small>
</div>
</div>
<div>
<small>
<a href="bindgen-customs.html">Customizations Reference</a>
</small>
</div>
</div>
<div>
<small>
<a href="schemagen.html">SchemaGen</a>
</small>
</div>
<div>
<small>
<a href="jibx2wsdl.html">Jibx2Wsdl</a>
</small>
<div>
<small>
<a href="jibx2wsdl-examples.html">Examples</a>
</small>
</div>
<div>
<small>
<a href="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/binding-tutorial.html">Binding Tutorial</a>
</small>
<div>
<small>
<a href="../binding/tutorial/binding-start.html">A basic binding</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-extras.html">Binding extras</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-collects.html">Collections and arrays</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-mappings.html">Using mappings</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-advanced.html">Advanced binding</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-extend.html">Method hooks</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-custom.html">Custom code</a>
</small>
</div>
</div>
<div>
<small>
<a href="../binding/precompiled.html">Precompiled Bindings</a>
</small>
</div>
<div>
<small>
<a href="../binding/binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="../binding/contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="../binding/conversions.html">Conversions</a>
</small>
<div>
<small>
<a href="../binding/date-time.html">Date/time conversions</a>
</small>
</div>
</div>
<div>
<small>
<a href="../binding/xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="../binding/binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/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="intro"></a>BindGen tool</h3>
<p>BindGen is the tool used to generate a binding definition and matching schema
definition from existing Java code.</p>
</div>
<div class="h3">
<h3>Running BindGen</h3>
<p>BindGen executes as a Java application, meaning it needs to be run directly from a
console window using the "java" command, or though some equivalent technique (such as
an Ant <code><java></code> task, discussed below). However it's being run, you need
to include <i>jibx-tools.jar</i> from your JiBX installation <i>lib</i> directory in the
Java classpath, along with the path for the compiled class files you'll use as input to
the generation. You'll also need several of the other jars from the JiBX <i>lib</i>
directory (including <i>jibx-bind.jar</i>, <i>jibx-schema.jar</i>, and <i>jibx-run.jar</i>).
As long as these jars are in the same directory as <i>jibx-tools.jar</i> you don't need to
list them in the classpath, though - they'll be picked up automatically.</p>
<p>The BindGen application main class is <code>org.jibx.binding.generator.BindGen</code>,
and it takes as parameters the fully-qualified names of one or more root class(es) to be
to be included in the binding generation. In schema terms, each of these root classes will
be treated as a separate global definition.</p>
<p>Here's a sample of running BindGen on Unix/Linux systems from the <i>examples/bindgen</i>
directory of the distribution (in a single line, shown split here only for formatting):</p>
<div id="source"><pre>java -cp ../../lib/jibx-tools.jar:bin org.jibx.binding.generator.BindGen
org.jibx.starter1.Order</pre></div>
<p>On Windows, the corresponding command line is:</p>
<div id="source"><pre>java -cp ..\..\lib\jibx-tools.jar;bin org.jibx.binding.generator.BindGen
org.jibx.starter.Order</pre></div>
<p>By default, BindGen output just goes to the current directory where it was executed. The
generated root binding definition is named <i>binding.xml</i>, and the generated schema
name is derived from the target namespace (which in turn is derived from the Java package
name).</p>
</div>
<div class="h3">
<h3>Using build tools</h3>
<p>You can easily run BindGen from an Ant build, just as you would any other Java application.
The <i>build.xml</i> in the <i>examples/bindgen</i> directory gives an example of this
(which passes an optional source directory path parameter, in addition to a root class name),
as shown below:</p>
<div id="source"><pre> <!-- set classpath for compiling and running application with JiBX -->
<path id="classpath">
<fileset dir="${jibx-home}/lib" includes="*.jar"/>
<pathelement location="bin"/>
</path>
...
<!-- generate default binding and schema -->
<target name="bindgen">
<echo message="Running BindGen tool"/>
<java classpathref="classpath" fork="true" failonerror="true"
classname="org.jibx.binding.generator.BindGen">
<arg value="-s"/>
<arg value="src"/>
<arg value="org.jibx.starter1.Order"/>
</java>
</target>
</pre></div>
<p>Most IDEs allow you to directly execute an Ant build target, so you can use the Ant
approach to running BindGen from within your IDE.</p>
</div>
<div class="h3">
<h3>Command line parameters</h3>
<p>You can pass a variety of command line parameters to BindGen, as listed below in
alphabetical order:</p>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<th scope="col">Parameter</th>
<th scope="col">Purpose</th>
</tr>
<tr class="a">
<td><code>-a</code></td>
<td>Force abstract mapping (equivalent to a schema complexType) generation for classes
passed as input parameters.</td>
</tr>
<tr class="b">
<td><code>-b name</code></td>
<td>Generated root binding definition file name (default name is binding.xml)</td>
</tr>
<tr class="a">
<td><code>-c path</code></td>
<td>Path to input customizations file</td>
</tr>
<tr class="b">
<td><code>-m</code></td>
<td>Force concrete mapping (equivalent to a schema complexType plus an element of that
type) generation for classes passed as input parameters</td>
</tr>
<tr class="a">
<td><code>-n uri=name,...</code></td>
<td>Give schema namespace URI and file-name pairs (default generates file names from
schema namespace URIs)</td>
</tr>
<tr class="b">
<td><code>-o</code></td>
<td>Binding generation only (no schema generation)</td>
</tr>
<tr class="a">
<td><code>-p path,...</code></td>
<td>Paths for loading Java class files (default is the classpath used to run BindGen)</td>
</tr>
<tr class="b">
<td><code>-s path,...</code></td>
<td>Paths for loading Java source files (source is not used by default)</td>
</tr>
<tr class="a">
<td><code>-t path</code></td>
<td>Target directory path for generated output (default is current directory)</td>
</tr>
<tr class="b">
<td><code>-v</code></td>
<td>Verbose output</td>
</tr>
<tr class="a">
<td><code>-w</code></td>
<td>Wipe all files from target directory before generating output (ignored if the target directory is the same as the current directory)</td>
</tr>
</table>
<p>You need to specify one or more class names as command line parameters to
BindGen. Each class you name is used as a starting point for generating binding
definitions. BindGen examines each class listed to find references to other classes,
and then recursively examines the referenced classes, to find the complete set of
classes necessary to represent your data. It then generates binding and schema
definitions for all of these classes. The class names must be at the end of the command
line, following any other command line parameters.</p>
<p>You can pass global customizations to BindGen as command-line parameters,
by using <code>--</code> as a special prefix to the customization attribute name.
This is explained in more detail in the BindGen <a href="bindgen-customs.html#command">customization
reference page</a>. Before digging into the details of customizations you may find
it useful to review the BindGen <a href="bindgen-examples.html">examples</a> to learn how BindGen
works and see some basic applications of customizations.</p>
</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>
|
