Class LayerTimeInfo
- java.lang.Object
-
- com.esri.arcgisruntime.arcgisservices.LayerTimeInfo
-
public final class LayerTimeInfo extends java.lang.Object
Metadata about a Layer or Sublayers support for time. It contains various information needed to be able to perform time based queries such as the time fields, the native time reference and the time extent.- Since:
- 100.0.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getEndTimeField()
Gets the name of the field that contains end time for each feature in the layer.TimeValue
getInterval()
Gets the time interval of the data in the layer.java.lang.String
getStartTimeField()
Gets the name of the field that contains the start time for each feature in the layer.TimeExtent
getTimeExtent()
Gets the time extent that is inclusive of all the data in the layer.long
getTimeInterval()
Deprecated.As of 100.3.0, replaced bygetInterval()
.TimeReference
getTimeReference()
Gets information about the time reference used for time values in the layer.TimeUnit
getTimeUnit()
Deprecated.As of 100.3.0, replaced bygetInterval()
.java.lang.String
getTrackIdField()
Gets the field name that defines the track ID.boolean
hasLiveData()
Indicates whether the service has live data or not.
-
-
-
Method Detail
-
getEndTimeField
public java.lang.String getEndTimeField()
Gets the name of the field that contains end time for each feature in the layer. This is available for feature data that has a start and end time stored in two separate fields, where a feature's time is valid for a duration between the start time and the end time.- Returns:
- the end time field name if time is stored in two fields, otherwise null.
- Since:
- 100.0.0
-
hasLiveData
public boolean hasLiveData()
Indicates whether the service has live data or not. If true, export and identify operations will default the TimeExtent to startTime = (current server time - time interval), endTime = current server time.- Returns:
- true if the service has live data, false otherwise.
- Since:
- 100.0.0
-
getStartTimeField
public java.lang.String getStartTimeField()
Gets the name of the field that contains the start time for each feature in the layer. This is available for feature data that has time stored in either a single field where a feature's time is valid for an instant in time, or in two fields where a feature's time is valid for a duration between the start time and the end time.- Returns:
- the start time field name
- Since:
- 100.0.0
- See Also:
getEndTimeField()
-
getTimeInterval
@Deprecated public long getTimeInterval()
Deprecated.As of 100.3.0, replaced bygetInterval()
.Gets the time interval of the data in the layer in the defined time units. If the time units areTimeUnit.UNKNOWN
this will be 0.- Returns:
- the time interval
- Since:
- 100.0.0
- See Also:
getTimeUnit()
-
getInterval
public TimeValue getInterval()
Gets the time interval of the data in the layer. The time interval can be used as a time slider's step size.- Returns:
- the time interval
- Since:
- 100.3.0
-
getTrackIdField
public java.lang.String getTrackIdField()
Gets the field name that defines the track ID. Values in the track ID field uniquely identify individual objects to allow observations of the same object at different times to be represented by different features in the layer.- Returns:
- the track id field name
- Since:
- 100.0.0
-
getTimeReference
public TimeReference getTimeReference()
Gets information about the time reference used for time values in the layer.- Returns:
- the time reference
- Since:
- 100.0.0
-
getTimeUnit
@Deprecated public TimeUnit getTimeUnit()
Deprecated.As of 100.3.0, replaced bygetInterval()
.Gets the unit in which the time interval is measured.- Returns:
- the time unit
- Since:
- 100.0.0
-
getTimeExtent
public TimeExtent getTimeExtent()
Gets the time extent that is inclusive of all the data in the layer.- Returns:
- the time extent, or null if the service is not time aware
- Since:
- 100.3.0
-
-