com.esri.arcgis.carto
Interface ITimeData

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITimeData2

All Known Implementing Classes:

CadastralFabricSubLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, ImageServerLayer, ITimeDataProxy, MapServerLayer, MapServerRESTLayer, MapServerRESTSubLayer, MosaicLayer, NetworkLayer, RasterLayer, StandaloneTable, TemporalFeatureLayer, WMSMapLayer

public interface ITimeData
extends Serializable

Provides access to time related properties of a layer.

Description

The ITimeData interface is implemented by all layers that can display time-related data or respond to time-related queries. However, for a layer to properly support time, it must be configured by a user with information from the ITimeDataDisplay interface. Once this information has been configured, the UseTime property in this interface is set to true, indicating that the layer not only has the ability to display time-related data, but also has all of the information (meta-data) it needs to display time-related data.

Product Availability

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

Method Summary

ITimeExtent	getFullTimeExtent() Returns the time extent for all the data in the layer.
ITimeReference	getTimeReference() Time reference for the contents of the layer.
boolean	isSupportsTime() Indicates whether the layer has any time data.
boolean	isUseTime() Indicates whether to use the time for animation purposes.
void	setUseTime(boolean useTime) Indicates whether to use the time for animation purposes.

Method Detail

isSupportsTime

boolean isSupportsTime()
                       throws IOException,
                              AutomationException

Indicates whether the layer has any time data.

Description

This property indicates whether the layer is able to render time-related data. If this property is false, it means that time-related data cannot be handled by the underlying software.

Product Availability

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

Returns:

The hasTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTime

boolean isUseTime()
                  throws IOException,
                         AutomationException

Indicates whether to use the time for animation purposes.

Description

This property indicates whether the meta-data used to properly configure time-related rendering has been provided. The property is also used to indicate whether the layer should use the time-related meta-data to render time-related data. If the property is false, it can mean two things:

1. The layer has not yet been provided with information like the name of the attribute in the data which contains the time of each feature.

2. The layer has simply been told not to display time-related data. This may be a temporary state change desired by a user that does not want the layer to change when running an animation.

Product Availability

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

Returns:

The useTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTime

void setUseTime(boolean useTime)
                throws IOException,
                       AutomationException

Indicates whether to use the time for animation purposes.

Product Availability

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

Parameters:

useTime - The useTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Time reference for the contents of the layer.

Description

This is the time reference for the data that this layer is rendering/providing. This property is read-only in the ITimeData interface because not all layers have the ability to change the TimeReference property of the data they represent. If the layer has the ability to change this property, it will implement the ITimeTableDefinition interface, and through that interface provide the ability to change the property's value.

Product Availability

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

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.

getFullTimeExtent

ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

Returns the time extent for all the data in the layer.

Description

This property provides a TimeExtent which represents the time from the earliest time stamp in the data to the latests time stamp in the data.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.