sarathonline.com/blog
Try my blog on: Ajax Version
Search

Friday, January 23, 2009

Java TimeZone ++: mapping Calendar to Oracle Date or TimeStamp

In Oracle Database date and timestamp columns can be read in java using s[g]etTimeStamp() methods for storing date and time information. However, they do not save the TimeZone information! The read and write operations are done on java.sql.TimeStamp which is a subclass of java.util.Date. When reading and writing to database, they just write out the *face value* (read my previous post on dates for explaination) in Java VM's default TimeZone the code is running on. And read the value too 'TO' the java VM's Default TimeZone. So assuming you WriteDate program on a VM in EST and ReadDate program on another VM in PST (or just change system timezone) - You are getting a different *value* in the date Object.

So, How do you tackle this issue. The best way is to set your application to run on a specified (constant) default timezone. As mentioned in the earlier post this can be achieved by TimeZone.setDefault(). If you are unable to do it (For reasons unknown to me, so far), JDBC specification allows sql dates to be read and written using a specified calendar. The resultSet.s[g]etTimeStamp method has an overloaded cousin, that takes a Calendar parameter. These methods save the date *face value* into the db after converting it to the timezone of the calendar passed as argument. So if there is a central place, You would want to have code some thing like this.

static final Calendar networkCal = Calendar.getInstance(TimeZone.getTimeZone("EST"));

 //Writing somewhere
 PreparedStatement ps = conn.prepareStatement("Update datex set dt = ?, tms = ?, faceval =? where id=1");
 ps.setDate(1, new java.sql.Date(userDate.getTime()));
 ps.setTimestamp(2, new Timestamp(userDate.getTime()), networkCal);

 //Reading Elsewhere
 ResultSet rs = st.executeQuery("select * from datex where id = 1");
 sqlTS = rs.getTimestamp("tms", networkCal);

In iBatis (we use iBatis), You can have a TypeHandlerCallback for Calender-TimeStamp mapping
class CalendarTypeHandlerCallback implements TypeHandlerCallback {

    private static final Calendar netWorkCal = Calendar.getInstance(TimeZone.getTimeZone("EST"));

 public Object getResult(ResultGetter getter) throws SQLException {
        Date date = getter.getDate(netWorkCal);
        Calendar calendar = null;

        if (date != null) {
            calendar = Calendar.getInstance();
            calendar.setTime(date);
        }

        return calendar;
    }

    public void setParameter(ParameterSetter setter, Object parameter)
        throws SQLException {
        GregorianCalendar calendar = (GregorianCalendar) parameter;
        java.sql.Date date = new java.sql.Date(calendar.getTimeInMillis());
        setter.setDate(date, netWorkCal);
    }

    public Object valueOf(String s) {
        return s;
    }
}
A Sample jdbc test case is uploaded here. If you are using Hibernate, You could use a user type to get similar effect.

Adventurously, I used the TimeZone.setDefault method on non-production systems of an application involving Tomcat, WebLogic a couple of wars and one ear. So far, I have not observed any issues, Google doesnot have any pages that give any known situations either. If I come to know, I will update.

2 comments:

Anna said...

Hello,

I have a question - what about a situation when I want my date 'face value' not to be converted to the given in the calendar timezone but i want to store the date with the specified timezone in the database? The timezone on my machine is GMT+01:00 and the same id DBTIMEZONE but i want to store timestamp with timezone = GMT+02:00? Is it possible?

Regards,
Ania

Sarath Chandra Pandurangi said...

The Code snippets given do the exact thing.

Consider the first snippet,
in your case, You have to set networkCal to GMT+02:00
your userDate is in GMT+01:00.

Ex: a time of 2009-04-15 12:00 GMT+01:00 (user date) after doing
ps.setTimestamp(2, new Timestamp(userDate.getTime()), networkCal);
will evaluate to store "2009-04-15 11:00:00" in the DB [observe - it doesnot store Timezone info, format may change based on your db]. Which is what you want.

Post a Comment

© SarathOnline.com 2000-'09