com.esri.core.map
Class TimeInfo

java.lang.Object
  com.esri.core.map.TimeInfo

public class TimeInfo
extends Object

This class contains information about time aware map service layers or individual layers within a map service. Information from a map service will consist of the valid range of date/time covered (getTimeExtent()) and the time zone (getTimeReference()). Information from a single map service layer will also consist of the start and end time fields, the track ID field, the interval between dates/times in the range and the export options that determine the behaviour of the layer when time ranges are set (see TimeOptions).

Since:

10.1.1

Constructor Summary

TimeInfo()

Method Summary

boolean	equals(Object obj)
static TimeInfo	fromJson(org.codehaus.jackson.JsonParser parser) Create an instance of this class from a JSON string.
String	getEndTimeField() Gets the end time field.
TimeOptions	getExportOptions() Gets the export options.
String	getStartTimeField() Gets the start time field.
TimeExtent	getTimeExtent() Gets the time extent.
int	getTimeInterval() Gets the time interval.
TimeOptions.Units	getTimeIntervalUnits() Gets the time interval units.
TimeReference	getTimeReference() Gets the time reference.
String	getTrackIdField() Gets the track id field.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeInfo

public TimeInfo()

Method Detail

getStartTimeField

public String getStartTimeField()

Gets the start time field.

Returns:

the start time field

Since:

10.1.1

getEndTimeField

public String getEndTimeField()

Gets the end time field.

Returns:

the end time field

Since:

10.1.1

getTrackIdField

public String getTrackIdField()

Gets the track id field.

Returns:

the track ID field

Since:

10.1.1

getTimeExtent

public TimeExtent getTimeExtent()

Gets the time extent.

Returns:

the time extent

Since:

10.1.1

getTimeReference

public TimeReference getTimeReference()

Gets the time reference. This indicates the time zone and whether or not daylight saving is honoured. Note that the actual time values used by the server are UTC.

Returns:

the time reference

Since:

10.1.1

getTimeInterval

public int getTimeInterval()

Gets the time interval. This is the suggested step size when stepping through the a time aware layer's time extent. The unit for this is given by getTimeIntervalUnits().

Returns:

the time interval

Since:

10.1.1

getTimeIntervalUnits

public TimeOptions.Units getTimeIntervalUnits()

Gets the time interval units.

Returns:

the time interval units

Since:

10.1.1

getExportOptions

public TimeOptions getExportOptions()

Gets the export options.

Returns:

the export options

Since:

10.1.1

fromJson

public static TimeInfo fromJson(org.codehaus.jackson.JsonParser parser)
                         throws org.codehaus.jackson.JsonParseException,
                                IOException

Create an instance of this class from a JSON string.

Parameters:

parser - the parser

Returns:

the time info

Throws:

org.codehaus.jackson.JsonParseException - the json parse exception

IOException - Signals that an I/O exception has occurred.

Since:

10.1.1

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

10.1.1

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

10.1.1

toString

public String toString()

Overrides:

toString in class Object

Since:

10.1.1