com.esri.arcgis.carto
Interface IMapTableTimeInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

DataObjectTable, GraphicFeatureLayer, MapLayerInfo, StandaloneTableInfo

public interface IMapTableTimeInfo
extends Serializable

Provides access to time properties of a MapLayerInfo.

Product Availability

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

Method Summary

String	getEndTimeFieldName() End time field for the table.
ITimeExtent	getFullTimeExtent() The time extent for all the data in the table.
String	getStartTimeFieldName() Name of the field that has start time or time instant for a table.
double	getTimeInterval() Suggested draw time interval for refreshing the table contents.
int	getTimeIntervalUnits() Draw time interval units.
ITimeReference	getTimeReference() Native TimeReference of the contents of the table.
String	getTimeValueFormat() Time field(s) values format.
String	getTrackIDFieldName() Field that identifies or groups unique objects for which time values are recorded in a table.
boolean	isSupportsTime() Indicates whether the table supports time.

Method Detail

isSupportsTime

boolean isSupportsTime()
                       throws IOException,
                              AutomationException

Indicates whether the table supports time.

Product Availability

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

Returns:

The supports

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

String getStartTimeFieldName()
                             throws IOException,
                                    AutomationException

Name of the field that has start time or time instant for a table.

Remarks

Time from this field is used to define when a feature/row is begun in case when the layer/table is time-enabled with two fields.

When a layer/table is time-enabled with single field, value in this field represents the moment the feature/row is recorded.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

String getEndTimeFieldName()
                           throws IOException,
                                  AutomationException

End time field for the table.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

String getTimeValueFormat()
                          throws IOException,
                                 AutomationException

Time field(s) values format.

Remarks

Only application when a string or numeric field is used for time definition.

Product Availability

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

Returns:

The format

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

String getTrackIDFieldName()
                           throws IOException,
                                  AutomationException

Field that identifies or groups unique objects for which time values are recorded in a table.

Product Availability

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

Returns:

The trackIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Native TimeReference of the contents of the table.

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

The time extent for all the data in the table.

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.

getTimeInterval

double getTimeInterval()
                       throws IOException,
                              AutomationException

Suggested draw time interval for refreshing the table contents.

Product Availability

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

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

int getTimeIntervalUnits()
                         throws IOException,
                                AutomationException

Draw time interval units.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.