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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: <value> 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: <value> Element</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>
<a href="xml-summary.html">XML summary</a>
</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>
<span class="menu-selection"><value> element</span>
</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="intro"><value> Element Definition</a></h3>
<p>The <b>value</b> element defines a simple value, one that is bound to
either an attribute or a simple element (one with no attributes or child
elements). This always makes use of a format definition. If no format is
explicitly named in the value definition the default format for the property
type is used (see <a href="conversions.html">Conversions</a> for information
on default formats.</p>
<p>The <b>value</b> element supports four unique attributes along with several
common attribute groups, listed below.</p>
<h4><a name="Attributes">Attributes</a></h4>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td>constant</td>
<td><p>This optional attribute is used to define a constant value. If present,
none of the attributes from the <b>string</b> group and only the <b>usage</b>
attribute from the <b>property</b> group can be present, the <b>format</b>
attribute is not allowed, and the only <b>ident</b> value allowed is
"none". If the value is defined as required it must be present and
match the constant on input; if optional, it is checked for on input and if
found must match the constant. The constant value is always included in the
output when marshalling.</p></td>
</tr>
<tr class="a">
<td>format</td>
<td><p>If present, this gives the name of the format to be used for converting
the property value to and from text. The named format must be defined in an enclosing
context to the <b>value</b> element.</p></td>
</tr>
<tr class="b">
<td>ident</td>
<td><p>This optional attribute is used to designate a property value as an
identifier type. Possible values are "none" (not an identifier type,
the default if this attribute is not used), "def" (value is a unique
identifier for the containing object), and "ref" (value is an object
with an identifier property and the identifier property of the object is used in
the XML representation rather than the actual object). Only one property with
<b>ident="def"</b> is allowed for a mapping; if one is present the
property must be a String, and must be defined directly as a child of the
<b>mapping</b> element; it is not allowed as a child of a <b>structure</b>
element.</p>
<p>Values with <b>ident</b> value "ref" cannot be used directly as
children of a collection; they <i>can</i> be used if there is a wrapper object
for the referenced object, as defined by a <b>structure</b> element with an
object type defined. References contained directly in a collection can be
handled by using custom marshaller/unmarshallers - see the <a
href="../extras.html">JiBX extras</a> description for a base custom
marshaller/unmarshaller you can extend for this
purpose, along with another custom marshaller/unmarshaller you can extend to
include the full representation of an object only at the point of first use
(with a reference if the same object is later used again).</p>
</td>
</tr>
<tr class="a">
<td>style</td>
<td><p>A <b>style</b> attribute present on the <b>value</b> element determines
the type of XML component used to represent the value. The allowed values are
"attribute", "element", "text", and "cdata".
The last two choices are subject to some restrictions. They cannot be used directly
within a <b>collection</b> definition (in other words, for <b>value</b>
elements that have a <b>collection</b> element as their parent), and also
cannot be used for direct children of an unordered <b>mapping</b> or
<b>structure</b>. Even within an ordered <b>mapping</b> or
<b>structure</b>, multiple <b>value</b> elements using these choices must be
separated by a required <b>value</b> using the "element" choice.</p>
<p>The default handling for this attribute is also special. If it isn't specified,
it defaults to the value set by the innermost containing element with a
<b>value-style</b> attribute, which will always be either the "attribute"
or "element" choice. See the <a
href="binding-attributes.html#style">style attribute group</a> description
for details of this type of usage.</p></td>
</tr>
<tr class="b">
<td><a href="binding-attributes.html#name">name</a></td>
<td><p>Attributes from the name group supply the element or attribute name for
this value. At least the <b>name</b> attribute is required if the XML component
type used for this value is an attribute or element, and forbidden otherwise.
See the <a href="binding-attributes.html#name">name attribute group description</a>
for usage details.</p></td>
</tr>
<tr class="a">
<td><a href="binding-attributes.html#property">property</a></td>
<td><p>Attributes from the property group define a property value, including how
it is accessed and whether it is optional or required. A property value is
required for <b>value</b> elements unless they're contained within
a <b>collection</b> element. In this case the value is always an item from
the collection, so the only attributes from this group allowed are the
"usage" and "type" attributes. See the <a
href="binding-attributes.html#property">property attribute group description</a>
for usage details.</p></td>
</tr>
<tr class="b">
<td><a href="binding-attributes.html#string">string</a></td>
<td><p>Attributes from the string group set the conversion handling of this value. See the <a
href="binding-attributes.html#string">string attribute group description</a>
for usage details.</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>
|
