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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: <binding> Element</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: <binding> Element</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="../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="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 and arrays</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="precompiled.html">Precompiled Bindings</a>
</small>
</div>
<div>
<small>
<a href="binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="conversions.html">Conversions</a>
</small>
<div>
<small>
<a href="date-time.html">Date/time conversions</a>
</small>
</div>
</div>
<div>
<small>
<a href="xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<span class="menu-selection"><binding> element</span>
</small>
</div>
<div>
<small>
<a href="include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="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"><binding> Element Definition</a></h3>
<p>The <b>binding</b> element is the root of a binding definition. This defines
characteristics for the entire binding. It supports several unique attributes
as well as two common attribute groups:</p>
<h4><a name="Attributes">Attributes</a></h4>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td>add-constructors</td>
<td><p>When this optional attribute is present with value "true", the binding
compiler will add a default constructor to a bound class when necessary to make
it usable in the binding. Default constructors are needed when there's no
unmarshaller or factory method for an object reference. Constructors can only be
added to classes which are available as class files for modification during the
binding compile.</p></td>
</tr>
<tr class="a">
<td>direction</td>
<td><p>Binding direction, which must be "input" (unmarshalling only),
"output" (marshalling only), or "both" (both marshalling
and unmarshalling, the default if this attribute is not given).</p></td>
</tr>
<tr class="b">
<td>force-classes</td>
<td><p>When this optional attribute is present with value "true", it forces
generation of marshaller/unmarshaller classes for top-level abstract mappings
which are not extended by other mappings. Normally these classes would not be
generated, since such mappings are never used directly within the binding. The
classes can be used at runtime by custom code, though, as the equivalent of type
mappings. The default value is "false".</p></td>
</tr>
<tr class="a">
<td>forwards</td>
<td><p>Controls whether forward references to ids are supported when
unmarshalling, at the cost of some (minor) additional overhead and code size.
If supplied the value must be "true" (forwards supported) or
"false" (ids must be defined before they are referenced). The
default is "true".</p></td>
</tr>
<tr class="b">
<td>name</td>
<td><p>The name for this binding. The supplied name must consist only of
characters which are valid as part of a Java identifier (so no spaces, periods,
etc.). The default if this attribute is not used is to take the name of the file
containing the definition document, with any file extension suffix stripped off
and invalid characters replaced by underscores (so a binding definition in a
file named "binding-2.xml" has the default name
"binding_2").</p></td>
</tr>
<tr class="a">
<td>package</td>
<td><p>Java package used for created binding factory class. By default this is
the same package as the class associated with the first <b>mapping</b> child
element. If present, the value must be a Java package name
(as in "org.jibx.runtime").</p></td>
</tr>
<tr class="b">
<td>track-source</td>
<td><p>When this optional attribute is present with value "true", the binding
compiler adds code to each bound object class to implement the
<code>org.jibx.runtime.ITrackSource</code> interface and store source position
information when instance objects are unmarshalled. This interface lets you
retrieve information about the source document and specific line and column
location of the document component associated with that object. The default
value is "false".</p></td>
</tr>
<tr class="a">
<td>trim-whitespace</td>
<td><p>When this optional attribute is present with value "true", whitespace is
trimmed from all simple text values before the value is deserialized. The effect
is the same as if all the built-in <a href="conversions.html">conversions</a> were
defined using whitespace="trim" (see the <a href="binding-attributes.html#string">string</a>
attribute group). This makes the conversions compatible with schema types.</p></td>
</tr>
<tr class="b">
<td><a href="binding-attributes.html#style">style</a></td>
<td><p>A <b>value-style</b> attribute present on the <b>binding</b> element sets a
default for all contained elements. See the <a
href="binding-attributes.html#style">style attribute group</a> description
for usage details.</p></td>
</tr>
<!--<td>global-ids</td>
<td><p>Determines whether object id values are global (as in normal XML ID/IDREF
usage) or specific to a particular object type. If supplied the value must be
"true" (global ids) or "false" (type-specific ids). The
default is "true". <b>Not implemented for Beta 3a.</b></p></td>
</tr>
<tr class="a"> -->
<!--<tr class="b">
<td>auto-prefix</td>
<td><p>Prefix used if automatically generating object ids. By default this is
"id_", but any prefix can be defined using this attribute. <b>Not
implemented for Beta 3a.</b></p></td>
</tr> -->
</table>
</div>
</div>
</div>
</td>
</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>
|
