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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: Definition XML Summary</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: Definition XML Summary</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>
<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-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="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>
<div>
<small>
<span class="menu-selection">XML summary</span>
</small>
</div>
<div>
<small>
<a href="binding-element.html"><binding> element</a>
</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="../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="schema">Schema</a></h3>
<p>Both a sample XML Schema definition (<i>binding.xsd</i>) and a sample DTD
(<i>binding.dtd</i>) for JiBX binding definitions are included in the
<i>/docs</i> directory of the JiBX distribution. These grammars will normally be
kept current, and if you find any errors please report them so they can be fixed.
However, the HTML documentation supplied on these pages is the definitive
description of the binding definition format.</p>
</div>
<div class="h3">
<h3><a name="elements">Element Summary</a></h3>
<p>Below is a quick summary of the types of elements used by the binding
definition, along with their functions and possible child elements. Most child
elements are optional and used only where needed. All are ordered, except where
"any combination" is specified.</p>
<h4>Elements</h4>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td><a href="binding-element.html">binding</a></td>
<td><p>The root element of the binding definition, with optional attributes for
binding name and global settings.</p>
<p>Children: <b>include</b>, <b>namespace</b>, <b>format</b>, <b>mapping</b> (at least 1
<b>mapping</b> required)</p></td>
</tr>
<tr class="a">
<td><a href="include-element.html">include</a></td>
<td><p>Include another binding definition within this binding definition.</p>
<p>Children: none</p></td>
</tr>
<tr class="b">
<td><a href="namespace-element.html">namespace</a></td>
<td><p>Namespace declaration that defines a namespace URI and associated
prefix (with the prefix used for marshalling).</p>
<p>Children: none</p></td>
</tr>
<tr class="a">
<td><a href="format-element.html">format</a></td>
<td><p>Format definition for converting simple values to and from text. This is
needed only if you want to use nonstandard conversions.</p>
<p>Children: none</p></td>
</tr>
<tr class="b">
<td><a href="mapping-element.html">mapping</a></td>
<td><p>Defines how objects of a particular class are converted to and from
XML. Each <b>mapping</b> defines a rule that applies within a particular context,
associating a particular element name with objects of a particular Java class.
The mapping definition may be global or local. It's possible to redefine a
mapping within the context of another mapping, for instance. Abstract mappings
can be used to define handling for base classes which can be extended by mappings
for subclasses. Abstract mappings can also be used to define a reusable binding
structure for a Java class, which doesn't need to correspond to a particular
element name or even to a single element of the XML representation.</p>
<p>Children: <b>namespace</b>, <b>format</b>, <b>mapping</b>, followed by any
combination of <b>value</b>, <b>structure</b>, and <b>collection</b> elements</p></td>
</tr>
<tr class="a">
<td><a href="value-element.html">value</a></td>
<td><p>Gives the conversion handling for a simple value (a primitive, or an
object type with <b>format</b> supplied to convert it to and from text. The
XML representation can be an attribute or simple element, or text or CDATA
content within a sequence of elements.</p>
<p>Children: none</p></td>
</tr>
<tr class="b">
<td><a href="structure-element.html">structure</a></td>
<td><p>Structure component of binding, which can represent a Java object, an
XML element, or both. The usual case is where this represents both a Java
object and an XML element linked to that object. A <a href="../tutorial/binding-structures.html">structure
mapping</a> is defined when either the object or the XML element is missing from the
definition. The child elements of the structure may be ordered or unordered.</p>
<p>Children: any combination of <b>value</b>, <b>structure</b>, and <b>collection</b>
elements</p></td>
</tr>
<tr class="a">
<td><a href="collection-element.html">collection</a></td>
<td><p>Representation of a collection object. The collection may define the
name for an element wrapper that contains the XML representations of the items
in the collection. If different types of items are included in the collection
the items may be ordered or unordered.</p>
<p>Children: any combination of <b>value</b>, <b>structure</b>, and <b>collection</b>
elements</p></td>
</tr>
</table>
</div>
<div class="h3">
<h3><a name="attributes">Attribute Group Summary</a></h3>
<p>The binding definition elements define a number of different attributes.
In many cases these attributes are grouped and the attribute groups apply to
more than one element type. The table below gives a list of the basic
attribute groups and the elements that support them. The elements also have
unique attributes in addition to these common groups. In almost all cases the
attributes are optional and are used to qualify or add details to the basic
function of the element.</p>
<h4>Attribute Groups</h4>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td><a href="binding-attributes.html#style">style</a></td>
<td><p>This group consists of only one attribute, the <b>value-style</b> attribute.
It's used to control whether a simple value is expressed in XML as an element
or an attribute.</p>
<p>Used with: <b>binding</b>, <b>mapping</b>, <b>structure</b>,
and <b>collection</b></p></td>
</tr>
<tr class="a">
<td><a href="binding-attributes.html#name">name</a></td>
<td><p>The name attributes define an XML element or attribute name.</p>
<p>Used with: <b>mapping</b>, <b>value</b>, <b>structure</b>,
and <b>collection</b></p></td>
</tr>
<tr class="b">
<td><a href="binding-attributes.html#object">object</a></td>
<td><p>The object group of attributes provide handling options for Java
objects. These include factory, pre- and post-unmarshal, and pre-marshal methods
for objects.</p>
<p>Used with: <b>mapping</b>, <b>structure</b>, and <b>collection</b></p></td>
</tr>
<tr class="a">
<td><a href="binding-attributes.html#structure">structure</a></td>
<td><p>The structure attributes deal with the children of a binding component.
They include control over whether children are ordered or unordered, as well as
linkages that allow portions of a binding definition to be referenced and reused
within the binding.</p>
<p>Used with: <b>value</b>, <b>structure</b>, and <b>collection</b></p></td>
</tr>
<tr class="b">
<td><a href="binding-attributes.html#property">property</a></td>
<td><p>The property attributes control how a value is accessed from a Java
object. These include field and/or get/set/test method names.</p>
<p>Used with: <b>value</b>, <b>structure</b>, and <b>collection</b></p></td>
</tr>
<tr class="a">
<td><a href="binding-attributes.html#string">string</a></td>
<td><p>The string attributes define conversions between Java primitive or
object values and text representations.</p>
<p>Used with: <b>format</b> and <b>value</b></p></td>
</tr>
</table>
</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>
|
