com.datagis.terraexplorer.util

Class TimeZoneMapper

java.lang.Object

com.datagis.terraexplorer.util.TimeZoneMapper

public class TimeZoneMapper
extends Object

Provides a simple mapping between Java and TerraExplorer time zones.

Since:

TEJ2.0

Author:

Carsten Klein

Constructor Summary

Constructors

Constructor and Description
TimeZoneMapper(String timeZoneListXML) Initializes a newly created TimeZoneMapper object with the native time zones from the specified XML-formatted time zone list.

Method Summary

Modifier and Type	Method and Description
void	addTimeZone(String key, int offset) Adds a time zone mapping with the specified key and raw offset in milliseconds to the mapper.
String	getKey(TimeZone tz) Returns a TerraExplorer time zone key for the specified TimeZone object.
TimeZone	getTimeZone(String key) Returns a TimeZone object for the specified TerraExplorer time zone key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeZoneMapper

public TimeZoneMapper(String timeZoneListXML)

Initializes a newly created TimeZoneMapper object with the native time zones from the specified XML-formatted time zone list.

Parameters:

timeZoneListXML - an XML-formatted list of native time zones

Method Detail

addTimeZone

public void addTimeZone(String key,
                        int offset)

Adds a time zone mapping with the specified key and raw offset in milliseconds to the mapper. This operation replaces any existing mapping for the key specified.

Parameters:

key - the TerraExplorer time zone key for the new mapping to add

offset - the raw offset in milliseconds

getKey

public String getKey(TimeZone tz)

Returns a TerraExplorer time zone key for the specified TimeZone object.

This method uses the raw offset to UTC time obtained from the specified time zone's getRawOffset method to get a TerraExplorer time zone key from keys.

Parameters:

tz - the TimeZone object to get a TerraExplorer time zone key for

Returns:

a TerraExplorer time zone key for the specified TimeZone object or null, if no key was found for the specified time zone

getTimeZone

public TimeZone getTimeZone(String key)

Returns a TimeZone object for the specified TerraExplorer time zone key.

This method returns the time zone with the first id returned by TimeZone.getAvailableIDs(offset) for the offset mapped against the specified key. So, basically this method returns any time zone with proper raw offset. Only if the raw offset equals the raw offset of the current default time zone, this current default time zone is returned. If no offset was found for the specified key, null is returned.

Parameters:

key - the TerraExplorer time zone key to get a TimeZone object for

Returns:

a TimeZone object for the specified TerraExplorer time zone key or null, if no time zone was found for the specified key