1 /*
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2004 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45 package org.exolab.castor.xml.handlers;
46
47 import java.sql.Timestamp;
48 import java.util.Date;
49
50 import org.exolab.castor.mapping.GeneralizedFieldHandler;
51
52 /**
53 * An implementation of GeneralizedFieldHandler for java.sql.Timestamp.
54 *
55 * @author <a href="kvisco@intalio.com">Keith Visco</a>
56 * @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
57 * @see org.exolab.castor.mapping.FieldDescriptor
58 * @see org.exolab.castor.mapping.FieldHandler
59 */
60 public class SQLTimestampFieldHandler extends GeneralizedFieldHandler {
61 /** Position of the literal 'T' character in an xsd:dateTime. */
62 private static final int OFFSET_OF_LITERAL_T = 10;
63
64 /**
65 * Creates a new SQLTimestampFieldHandler.
66 */
67 public SQLTimestampFieldHandler() {
68 super();
69 }
70
71 /**
72 * This method is used to convert the value when the getValue method is
73 * called. The getValue method will obtain the actual field value from given
74 * 'parent' object. This convert method is then invoked with the field's
75 * value. The value returned from this method will be the actual value
76 * returned by getValue method.
77 *
78 * @param value the object value to convert after performing a get operation
79 * @return the converted value.
80 */
81 public Object convertUponGet(final Object value) {
82 //-- no conversion necessary for marshaling
83 return value;
84 } //-- convertUponGet
85
86 /**
87 * This method is used to convert the value when the setValue method is
88 * called. The setValue method will call this method to obtain the converted
89 * value. The converted value will then be used as the value to set for the
90 * field.
91 *
92 * @param value the object value to convert before performing a set
93 * operation
94 * @return the converted value.
95 */
96 public Object convertUponSet(final Object value) {
97 if (value == null) {
98 return null;
99 }
100
101 Timestamp timestamp = null;
102
103 // XML Schema compatibility: If 'T' exists at the correct spot,
104 // then we most likely have an XML Schema dateTime format.
105 String str = value.toString();
106 if (str.indexOf('T') == OFFSET_OF_LITERAL_T) {
107 try {
108 Date date = DateFieldHandler.parse(str);
109 timestamp = new Timestamp(date.getTime());
110 } catch (java.text.ParseException px) {
111 throw new IllegalStateException(px.getMessage());
112 }
113 } else {
114 timestamp = Timestamp.valueOf(str);
115 }
116 return timestamp;
117 } //-- convertUponSet;
118
119 /**
120 * Returns the class type for the field that this GeneralizedFieldHandler
121 * converts to and from. This should be the type that is used in the object
122 * model.
123 *
124 * @return the class type of of the field
125 */
126 public Class getFieldType() {
127 return java.sql.Timestamp.class;
128 } //-- getFieldType
129
130 /**
131 * Creates a new instance of the object described by this field.
132 *
133 * @param parent The object for which the field is created
134 * @return A new instance of the field's value
135 * @throws IllegalStateException This field is a simple type and cannot be
136 * instantiated
137 */
138 public Object newInstance(final Object parent) throws IllegalStateException {
139 return new java.sql.Timestamp(0);
140 }
141
142 } //-- SQLTimestampFieldHandler