public class

TimeInfo

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

Class Overview

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).

Summary

Public Constructors
TimeInfo()
Public Methods
boolean equals(Object obj)
static TimeInfo fromJson(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()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public TimeInfo ()

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public static TimeInfo fromJson (JsonParser parser)

Create an instance of this class from a JSON string.

Parameters
parser JsonParser: the parser
Returns
TimeInfo the time info
Throws
JsonParseException the json parse exception
IOException Signals that an I/O exception has occurred.

public String getEndTimeField ()

Gets the end time field.

Returns
String the end time field

public TimeOptions getExportOptions ()

Gets the export options.

Returns
TimeOptions the export options

public String getStartTimeField ()

Gets the start time field.

Returns
String the start time field

public TimeExtent getTimeExtent ()

Gets the time extent.

Returns
TimeExtent the time extent

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
int the time interval

public TimeOptions.Units getTimeIntervalUnits ()

Gets the time interval units.

Returns
TimeOptions.Units the time interval units

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
TimeReference the time reference

public String getTrackIdField ()

Gets the track id field.

Returns
String the track ID field

public int hashCode ()

Returns
int

public String toString ()

Returns
String