com.esri.arcgis.system
Class TimeZoneFactory

java.lang.Object
  com.esri.arcgis.system.TimeZoneFactory

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ITimeZoneFactory, Serializable

public class TimeZoneFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITimeZoneFactory

An object that creates TimeZoneInfo instances.

Description

The TimeZoneFactory class is used to generate a reference to a TimeReference instance. The desired TimeReference can be identified using the esriTimeZoneWKID enumeration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

TimeZoneFactory()
Constructs a TimeZoneFactory using ArcGIS Engine.

TimeZoneFactory(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeZoneFactory theTimeZoneFactory = (TimeZoneFactory) obj;

Method Summary

ILocaleInfo	createLocaleInfoFromLocaleID(int localeID) Obtains the locale display name that corresponds to the given locale ID.
ITimeReference	createTimeReferenceFromWindowsID(String windowsID) Creates a time reference from a windows ID.
ITimeZoneInfo	createTimeZoneInfoFromWindowsID(String windowsID) Creates a time zone info from a windows ID.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getFirstLocaleID() The first locale ID.
String	getFirstTimeZoneWindowsID() The first time zone windows ID.
int	getNextLocaleID(int currenteLocaleID) The locale ID that cyclicly proceeds the given locale ID.
String	getNextTimeZoneWindowsID(String currentTimeZoneWindowsID) The time zone windows ID that cyclicly proceeds the given time zone windows ID.
int	hashCode() the hashcode for this object
boolean	isValidLocaleID(int localeID) Returns whether a given locale ID is valid for creating a locale info.
boolean	isValidTimeZoneWindowsID(String windowsID) Returns whether a given time zone windows ID is valid for creating a time zone info or a time reference.
String	queryLocalTimeZoneWindowsID() Obtains the machine's current local time zone Windows ID.
String[]	queryTimeZoneOlsonIDsFromWindowsID(String windowsID) Obtains all the olson time zone IDs that correspond to the given time zone windows ID.
String	queryTimeZoneWindowsIDFromOlsonID(String olsonID) Returns the time zone windows ID that corresponds to the given olson time zone ID.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TimeZoneFactory

public TimeZoneFactory()
                throws IOException,
                       UnknownHostException

Constructs a TimeZoneFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TimeZoneFactory

public TimeZoneFactory(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeZoneFactory theTimeZoneFactory = (TimeZoneFactory) obj;

Construct a TimeZoneFactory using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TimeZoneFactory.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

createTimeZoneInfoFromWindowsID

public ITimeZoneInfo createTimeZoneInfoFromWindowsID(String windowsID)
                                              throws IOException,
                                                     AutomationException

Creates a time zone info from a windows ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createTimeZoneInfoFromWindowsID in interface ITimeZoneFactory

Parameters:

windowsID - The windowsID (in)

Returns:

A reference to a com.esri.arcgis.system.ITimeZoneInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTimeReferenceFromWindowsID

public ITimeReference createTimeReferenceFromWindowsID(String windowsID)
                                                throws IOException,
                                                       AutomationException

Creates a time reference from a windows ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createTimeReferenceFromWindowsID in interface ITimeZoneFactory

Parameters:

windowsID - The windowsID (in)

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTimeZoneWindowsIDFromOlsonID

public String queryTimeZoneWindowsIDFromOlsonID(String olsonID)
                                         throws IOException,
                                                AutomationException

Returns the time zone windows ID that corresponds to the given olson time zone ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

queryTimeZoneWindowsIDFromOlsonID in interface ITimeZoneFactory

Parameters:

olsonID - The olsonID (in)

Returns:

The windowsID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTimeZoneOlsonIDsFromWindowsID

public String[] queryTimeZoneOlsonIDsFromWindowsID(String windowsID)
                                            throws IOException,
                                                   AutomationException

Obtains all the olson time zone IDs that correspond to the given time zone windows ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

queryTimeZoneOlsonIDsFromWindowsID in interface ITimeZoneFactory

Parameters:

windowsID - The windowsID (in)

Returns:

The olsonIDs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryLocalTimeZoneWindowsID

public String queryLocalTimeZoneWindowsID()
                                   throws IOException,
                                          AutomationException

Obtains the machine's current local time zone Windows ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

queryLocalTimeZoneWindowsID in interface ITimeZoneFactory

Returns:

The localTimeZoneWindowsID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstTimeZoneWindowsID

public String getFirstTimeZoneWindowsID()
                                 throws IOException,
                                        AutomationException

The first time zone windows ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFirstTimeZoneWindowsID in interface ITimeZoneFactory

Returns:

The firstTimeZoneWindowsID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextTimeZoneWindowsID

public String getNextTimeZoneWindowsID(String currentTimeZoneWindowsID)
                                throws IOException,
                                       AutomationException

The time zone windows ID that cyclicly proceeds the given time zone windows ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getNextTimeZoneWindowsID in interface ITimeZoneFactory

Parameters:

currentTimeZoneWindowsID - The currentTimeZoneWindowsID (in)

Returns:

The nextTimeZoneWindowsID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstLocaleID

public int getFirstLocaleID()
                     throws IOException,
                            AutomationException

The first locale ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFirstLocaleID in interface ITimeZoneFactory

Returns:

The firstLocaleID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextLocaleID

public int getNextLocaleID(int currenteLocaleID)
                    throws IOException,
                           AutomationException

The locale ID that cyclicly proceeds the given locale ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getNextLocaleID in interface ITimeZoneFactory

Parameters:

currenteLocaleID - The currenteLocaleID (in)

Returns:

The nextLocaleID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createLocaleInfoFromLocaleID

public ILocaleInfo createLocaleInfoFromLocaleID(int localeID)
                                         throws IOException,
                                                AutomationException

Obtains the locale display name that corresponds to the given locale ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createLocaleInfoFromLocaleID in interface ITimeZoneFactory

Parameters:

localeID - The localeID (in)

Returns:

A reference to a com.esri.arcgis.system.ILocaleInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValidTimeZoneWindowsID

public boolean isValidTimeZoneWindowsID(String windowsID)
                                 throws IOException,
                                        AutomationException

Returns whether a given time zone windows ID is valid for creating a time zone info or a time reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isValidTimeZoneWindowsID in interface ITimeZoneFactory

Parameters:

windowsID - The windowsID (in)

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValidLocaleID

public boolean isValidLocaleID(int localeID)
                        throws IOException,
                               AutomationException

Returns whether a given locale ID is valid for creating a locale info.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isValidLocaleID in interface ITimeZoneFactory

Parameters:

localeID - The localeID (in)

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.