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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Date/time conversions</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>Date/time conversions</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>
<span class="menu-selection">Date/time conversions</span>
</small>
</div>
</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>
<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="issues">Issues with date/time values</a></h3>
<p>W3C XML Schema defines 9 different datatypes for various forms of time-related
values. Most of these are not very useful for data exchange between applications.
Consider gMonthDay, for instance, which represents a particular month and day of
the month without regard to a year - although this could be useful for some specialized
applications, most applications need full date specifications including a year. Three
of the schema time-related datatypes are widely used for data exchange: dateTime, date,
and time. The dateTime datatype is effectively the "core" type, with date and time
types just trimmed versions of the dateTime representation.</p>
<p>Unfortunately, the dateTime/date/time datatypes all suffer from one severe
limitation when it comes to their use for data exchange: Schema allows the values to
be specified either in UTC time (or with a fixed offset from UTC, equivalent to UTC)
or without reference to any time zone. The latter case is what usually causes problems
for data exchange. Applications always want to work either with fully-specified
date/time values, representing a particular instant of time which can be converted at
will into any time zone, or with date/time values without reference to time zone (such
as a birthday). Very few applications are written to work interchangably with both
types of values.</p>
<p>In Java the standard date/time representation uses either a <code>java.util.Date</code>
value or a <code>java.util.Calendar</code> value. The former corresponds to a
fully-specified dateTime value in schema terms, since it is a specific millisecond in
UTC. The latter has no schema equivalent,
since it includes actual time zone information (rather than just an offset from GMT for
a particular instant of time, as allowed by the schema representation). Various methods
are used by different data binding tools to convert these two Java types to and from
XML representations, but no method can correct the inherent differences.</p>
</div>
<div class="h3">
<h3><a name="issues">Date/time conversions in JiBX</a></h3>
<p>Because of these issues of date/time representations in schema, and the problems in matching
the schema datatypes to Java types, JiBX supports working with both standard Java classes
and Joda date/time classes. The Joda library provides a much richer set of representations
for date/time values than standard Java, and the richer representations allow more ways
of handling the conversions. This still doesn't correct for the fundamental flaws in the
schema representation of date/times, but it at least allows you to easily control how the
conversions are handled for your code.</p>
<p>The following table gives the full range of date/time formats built into the JiBX
handling, including both default formats (as indicated) and formats you can specify by
name for use in your bindings:</p>
<h4>Date/time Formats</h4>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<th>Type</th>
<th>Format Label</th>
<th>Conversion</th>
</tr>
<tr class="a">
<td><code>java.util.Date</code></td>
<td>Date.default</td>
<td><p>Converts instances of <code>java.util.Date</code> to and from the schema
dateTime representation (a text representation like "2000-03-21T01:33:00", with
optional trailing fractional seconds, and difference from UTC). Since schema
doesn't have any concept equivalent to Java time zones, this conversion always
serializes times as UTC values (identified by a trailing "Z"). When
deserializing times which do not include a "Z" or offset from UTC it treats the
values as UTC. <b>Default</b></p></td>
</tr>
<tr class="b">
<td><code>java.sql.Date</code></td>
<td>SqlDate.default</td>
<td><p>Converts instances of <code>java.sql.Date</code> to and from the schema
date representation (a text representation like "2000-03-21", with
optional trailing time offset). Time zones and offsets are ignored by this
conversion - any time offset is ignored when unmarshalling, and the output is
generated without an offset or 'Z' UTC indicator when marshalling. <b>Default</b>
</p></td>
</tr>
<tr class="a">
<td><code>java.sql.Time</code></td>
<td>SqlTime.default</td>
<td><p>Converts instances of <code>java.sql.Time</code> to and from the schema
time representation (a text representation like "01:33:00" with optional
trailing fractional seconds and time offset). Time zones and offsets are ignored
by this conversion - any time offset is ignored when unmarshalling, and the output
is generated without an offset or 'Z' UTC indicator when marshalling.
<b>Default</b></p></td>
</tr>
<tr class="b">
<td><code>java.sql.Timestamp</code></td>
<td>Timestamp.default</td>
<td><p>Converts instances of <code>java.sql.Timestamp</code> to and from the
schema dateTime representation, just as the <b>Date:default</b> conversion does
for <code>java.util.Date</code> instances. The only difference is that using the
timestamp value permits greater precision in the time value represented, down to
the nanosecond level. <b>Default</b></p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.LocalDate</code></td>
<td>LocalDate.default</td>
<td><p>Converts instances of <code>org.joda.time.LocalDate</code> to and from the
schema date representation, ignoring time zones (any time offset is ignored when
unmarshalling, and the output is generated without an offset or 'Z' UTC indicator
when marshalling). <b>Default</b></p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateMidnight</code></td>
<td>DateMidnight.zoned</td>
<td><p>Converts instances of <code>org.joda.time.DateMidnight</code> to and from the
schema date representation, including time zone (which is part of the <code>DateMidnight</code>
structure). The local zone is used when deserializing a schema representation with no
time zone information.</p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateMidnight</code></td>
<td>DateMidnight.local</td>
<td><p>Converts instances of <code>org.joda.time.DateMidnight</code> to and from the
schema date representation, with the local zone used for all deserialized values (even
if the schema representation includes time zone information) and no zone specified on
output. <b>Default</b></p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateMidnight</code></td>
<td>DateMidnight.UTC</td>
<td><p>Converts instances of <code>org.joda.time.DateMidnight</code> to and from the
schema date representation, with the UTC zone used for all deserialized values (even
if the schema representation includes time zone information) and zone always specified
as UTC on output (even if that doesn't match the zone information set on the
<code>org.joda.time.DateMidnight</code> value).</p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.LocalTime</code></td>
<td>LocalTime.local</td>
<td><p>Converts instances of <code>org.joda.time.LocalTime</code> to and from the
schema time representation, ignoring any time zone information when deserializing from
a schema representation and leaving off any time zone information when serializing to
a schema representation. <b>Default</b></p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.LocalTime</code></td>
<td>LocalTime.UTC</td>
<td><p>Converts instances of <code>org.joda.time.LocalTime</code> to and from the
schema time representation, ignoring any time zone information when deserializing from
a schema representation and setting the time zone as UTC (with a 'Z' suffix) when
serializing to a schema representation.</p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateTime</code></td>
<td>DateTime.zoned</td>
<td><p>Converts instances of <code>org.joda.time.DateTime</code> to and from the schema
dateTime representation. When a schema dateTime value with time zone information
included is deserialized, the time zone from the schema value is used for the
constructed <code>DateTime</code> instance; if no time zone information is included,
the local time zone is used. The actual zone set on the <code>DateTime</code> instance
is used when serializing.</p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateTime</code></td>
<td>DateTime.UTC</td>
<td><p>Converts instances of <code>org.joda.time.DateTime</code> to and from the schema
dateTime representation. The UTC time zone is used when deserializing a schema dateTime
value with no time zone information supplied. Values are always adjusted to UTC and
specified as UTC (using a 'Z' suffix) when serializing.</p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateTime</code></td>
<td>DateTime.local</td>
<td><p>Converts instances of <code>org.joda.time.DateTime</code> to and from the schema
dateTime representation. Deserialized values always use the local time zone. When
deserializing a schema dateTime value with time zone information included the value is
converted to the local equivalent; if no time zone information is included in the schema
value the local time zone is assumed. The actual zone set on the <code>DateTime</code>
instance is used when serializing. <b>Default</b></p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateTime</code></td>
<td>DateTime.strict-local</td>
<td><p>Like the <b>DateTime.local</b> conversion, above, but requires time zone information
in schema dateTime values being deserialized (throwing an exception if no time zone
information is present).</p></td>
</tr>
<tr class="a">
<td><code>org.joda.time.DateTime</code></td>
<td>DateTime.strict-UTC</td>
<td><p>Like the <b>DateTime.UTC</b> conversion, above, but requires time zone information
in schema dateTime values being deserialized (throwing an exception if no time zone
information is present).</p></td>
</tr>
</table>
<p>The actual implementations of the conversions for standard Java date/time classes
are in the <code>org.jibx.runtime.Utility</code> class, while those for the Joda
date/time classes are in the <code>org.jibx.runtime.JodaConvert</code> class. You can
use the methods in these classes to construct your own custom combinations of
serialization and deserialization handling.</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>
|
