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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: CodeGen 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: CodeGen 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="../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="index.html">Start from Schema</a>
</small>
</div>
<div>
<small>
<span class="menu-selection">CodeGen</span>
</small>
<div>
<small>
<a href="codegen-types.html">Schema Datatype Handling</a>
</small>
</div>
<div>
<small>
<a href="codegen-examples.html">Example Code</a>
</small>
<div>
<small>
<a href="example-default.html">Default Generation</a>
</small>
</div>
<div>
<small>
<a href="example-custom1.html">Simple Customizations</a>
</small>
</div>
<div>
<small>
<a href="example-custom2.html">More Customizations</a>
</small>
</div>
<div>
<small>
<a href="example-modular.html">Modular Generation</a>
</small>
</div>
</div>
<div>
<small>
<a href="codegen-customs.html">Customizations Reference</a>
</small>
<div>
<small>
<a href="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>CodeGen tool</h3>
<p>CodeGen is the tool used to generate Java code and a binding definition from an
XML schema. It currently handles most types of schema definitions, but as with most
data binding tools some aspects of schema with are not completely supported. These
unsupported or partially-supported schema features including the following:</p>
<ul>
<li>Schemas using <xs:any> extension points, where the <xs:any> is not the last
item in a sequence. Most often <xs:any> is used at the end of a content model, since
that way it can be used to provide compatiblity with future extensions of the model
adding more details to the content model. It doesn't have to be used in this way, though,
and in particular it can be used anywhere within a content model if it has the attribute
<code>namespace="##other"</code>. This usage is not currently supported by CodeGen.</li>
<li>Schemas using <xs:anyAttribute> extension points. <xs:anyAttribute> handling is
not yet implemented by CodeGen, and is unlikely to be supported until JiBX version 2.0.</li>
<li>minOccurs values other than "0" or "1", maxOccurs values other than "1" or "unbounded";
CodeGen treats any maxOccurs value greater than "1" as equivalent to "unbounded" (and
ignores the minOccurs value in this case, allowing <i>any</i> number of occurrences,
including none). It also treats minOccurs values greater than "1" as equivalent to "1".
This means that there are really only three variations of minOccurs/maxOccurs generated
by CodeGen: Optional components, with minOccurs="0" and maxOccurs="1"; required
components, with minOccurs="1" and maxOccurs="1"; and repeating components, with
maxOccurs greater than "1".</li>
<li><xs:union> simple type derivations are currently handled as simple string values</li>
<li>The only type of simple type <xs:restriction> facet currently processed by CodeGen
is the <xs:enumeration> facet.</li>
</ul>
</div>
<div class="h3">
<h3>Running CodeGen</h3>
<p>CodeGen 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. 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>,
along with <i>log4j.jar</i> and all the eclipse jars). 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 CodeGen application main class is <code>org.jibx.schema.codegen.CodeGen</code>,
and it takes as parameters the names or name patterns (using '*' wildcard characters) for
schemas to be used as the basis for code generation. Only "top-level" schemas need to be
specified; schemas referenced by means of xs:include or xs:import will automatically be
loaded by CodeGen and included in the code generation.</p>
<p>Here's a sample of running CodeGen on Unix/Linux systems from the <i>examples/codegen</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 org.jibx.schema.codegen.CodeGen
otasubset/OTA_AirLowFareSearchRQ.xsd</pre></div>
<p>On Windows, the corresponding command line is:</p>
<div id="source"><pre>java -cp ..\..\lib\jibx-tools.jar org.jibx.schema.codegen.CodeGen
otasubset\OTA_AirLowFareSearchRQ.xsd</pre></div>
<p>By default, CodeGen 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 Java package(s)
is derived from the schema namespace.</p>
<p>When working with large schemas you may find performance to be a problem using the
standard JVM memory settings. You should be able to dramatically improve performance by
increasing your Java runtime memory settings (with the JVMs provided by Sun this is done
using the <i>-Xms</i> and <i>-Xmx</i> command line flags, so passing the command line
parameters <code>-Xms512M -Xmx512M</code> would increase the memory available to the JVM
from the standard 16 megabytes to 512 megabytes).</p>
</div>
<div class="h3">
<h3>Using build tools</h3>
<p>You can easily run CodeGen from an Ant build, just as you would any other Java application.
The <i>build.xml</i> in the <i>examples/codegen</i> directory gives an example of this
(which passes an optional generation directory path parameter, in addition to a schema
file path pattern), 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 using default settings -->
<target name="codegen" depends="check-runtime,clean">
<echo message="Running code generation from schema"/>
<java classname="org.jibx.schema.codegen.CodeGen" fork="yes"
classpathref="classpath" failonerror="true">
<arg value="-t"/>
<arg value="gen/src"/>
<arg value="otasubset/OTA_AirLowFareSearch*.xsd"/>
</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 CodeGen from within your IDE.</p>
<p>You can change the default memory size for the <java> Ant task using nested
<jvmarg> parameters. By way of example, here's how you'd change the above Ant target
to use 512 megabytes of memory:</p>
<div id="source"><pre> <java classname="org.jibx.schema.codegen.CodeGen" fork="yes"
classpathref="classpath" failonerror="true">
<jvmarg value="-Xms512M"/>
<jvmarg value="-Xmx512M"/>
<arg value="-t"/>
<arg value="gen/src"/>
<arg value="otasubset/OTA_AirLowFareSearch*.xsd"/>
</java></pre></div>
</div>
<div class="h3">
<h3>Command line parameters</h3>
<p>You can pass a variety of command line parameters to CodeGen, 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>-b name</code></td>
<td>Generated root binding definition file name (default name is binding.xml)</td>
</tr>
<tr class="b">
<td><code>-c path</code></td>
<td>Path to input customizations file</td>
</tr>
<tr class="a">
<td><code>-i path1,path2,...</code></td>
<td>Include existing bindings and use mappings from the bindings for matching schema
global definitions (this is the basis for <a href="example-modular.html">modular code generation</a>)</td>
</tr>
<tr class="b">
<td><code>-n package</code></td>
<td>Default package for code generated from schema definitions with no namespace
(default is the package "dflt", if not set)</td>
</tr>
<tr class="a">
<td><code>-p package</code></td>
<td>Default package for code generated from all schema definitions</td>
</tr>
<tr class="b">
<td><code>-s path</code></td>
<td>Root directory path for schema definitions (so that simple names can be used when
specifying multiple schemas)</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>-u uri</code></td>
<td>Namespace applied in code generation when no-namespaced schema definitions are
found (to generate no-namespaced schemas as though they were included in a particular
namespace)</td>
</tr>
<tr class="a">
<td><code>-v</code></td>
<td>Verbose output</td>
</tr>
<tr class="b">
<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 schema paths or file path patterns as command
line parameters to CodeGen. Each schema you specify is used as a starting point for
generating code and binding definitions. CodeGen examines each specified schema to
find references to other schemas, and then recursively examines the referenced schemas,
to find the complete set of schemas used to represent the data. It then generates code
and binding definitions for all of these schemas. The schema names or file path
patterns must be at the end of the command line, following any other command line
parameters. '*' wildcard characters can be used in schema names, but only as part of
file paths. Schema names can also be specified using HTTP or other forms of URLs, but
wildcard characters are not allowed in this case.</p>
<p>Finally, you can pass global customizations to CodeGen 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 CodeGen <a href="codegen-customs.html#command">customization
reference page</a>. Before digging into the details of customizations you may find
it useful to review the CodeGen <a href="codegen-examples.html">examples</a> to learn how CodeGen
works and see some basic applications of customizations.</p>
</div>
<div class="h3">
<h3><a name="logging"></a>Logging support</h3>
<p>CodeGen includes logging code at a variety of levels of detail, using the <i>log4j</i>
library. The <i>jibx-tools.jar</i> includes a default <i>log4j.properties</i> which
only supports ERROR level logging, with output to the console. This default properties
file can be overridden by another <i>log4j.properties</i> which is placed earlier in
the classpath. The <i>log4j.properties</i> file in the <i>examples/codegen</i>
directory is supplied as a sample, which can be activated by changing the classpath
definition in the Ant <i>build.xml</i> as follows:</p>
<div id="source"><pre> <!-- set classpath for compiling and running application with JiBX -->
<path id="classpath">
<pathelement location="."/>
<fileset dir="${jibx-home}/lib" includes="*.jar"/>
<pathelement location="bin"/>
</path></pre></div>
<p>This logging support is only intended for use by JiBX developers and others who
are investigating the operation of the CodeGen program. The logging information is
generally not useful to end users.</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>
|
