com.esri.arcgis.carto
Interface ITimeTableDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadastralFabricSubLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, ImageServerLayer, ITimeTableDefinitionProxy, MosaicLayer, StandaloneTable, TemporalFeatureLayer

public interface ITimeTableDefinition
extends Serializable

Provides access to time related properties of a layer.

Description

This interface is used to provide all of the detailed meta-data related to time that is needed to perform time-related operations on the data set. The EndTimeFieldName, TimeReference, and TrackIDFieldName are optional properties.

Product Availability

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

Method Summary

ITimeExtent	getCustomTimeExtent() Custom time extent during which a layer is visible.
String	getEndTimeFieldName() Name of the field that has end time for a row.
String	getStartTimeFieldName() Name of the field that has start time for a row.
ITimeReference	getTimeReference() Time reference for the data.
String	getTimeValueFormat() Time value format if the field name is of the string format.
String	getTrackIDFieldName() Field that contains the rows that uniquely identifies the object whose time is being tracked.
void	setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime) Custom time extent during which a layer is visible.
void	setEndTimeFieldName(String fieldName) Name of the field that has end time for a row.
void	setStartTimeFieldName(String fieldName) Name of the field that has start time for a row.
void	setTimeReferenceByRef(ITimeReference nativeTimeReference) Time reference for the data.
void	setTimeValueFormat(String format) Time value format if the field name is of the string format.
void	setTrackIDFieldName(String fieldName) Field that contains the rows that uniquely identifies the object whose time is being tracked.

Method Detail

getStartTimeFieldName

String getStartTimeFieldName()
                             throws IOException,
                                    AutomationException

Name of the field that has start time for a row.

Description

This property contains the name of the column which contains the start time for each feature. If the feature has only one associated time, then this field is used, and the EndTimeFieldName is not set.

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.

setStartTimeFieldName

void setStartTimeFieldName(String fieldName)
                           throws IOException,
                                  AutomationException

Name of the field that has start time for a row.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

String getEndTimeFieldName()
                           throws IOException,
                                  AutomationException

Name of the field that has end time for a row.

Description

If the data in a table has a start and an end time, this property contains the name of the column that holds the end time for each feature. If the data only has one time associated with it (it is instantaneous) then this property is not set.

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.

setEndTimeFieldName

void setEndTimeFieldName(String fieldName)
                         throws IOException,
                                AutomationException

Name of the field that has end time for a row.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

String getTimeValueFormat()
                          throws IOException,
                                 AutomationException

Time value format if the field name is of the string format.

Description

This property contains an emumeration representing the format of the data stored in the Start Time Field and the End Time Field. The Start Time Field and the End Time Field must use the same format. Only formats allowed by this enumeration are allowed.

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.

setTimeValueFormat

void setTimeValueFormat(String format)
                        throws IOException,
                               AutomationException

Time value format if the field name is of the string format.

Product Availability

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

Parameters:

format - The format (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

String getTrackIDFieldName()
                           throws IOException,
                                  AutomationException

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Description

The TrackIDFieldName property contains the name of the field which can be used to group features by the object they represent. For example, if a table contains observations of automobiles, and each feature in the table represents the location of one automobile at one point in time, there will be one field that uniquely identifies which automobile a feature is associated with (e.g. license plate number). The TrackIDFieldName is the field that can be used to group the attributes by the real-world object that they represent (the "Track" that they belong to).

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.

setTrackIDFieldName

void setTrackIDFieldName(String fieldName)
                         throws IOException,
                                AutomationException

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Product Availability

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

Parameters:

fieldName - The fieldName (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 data.

Description

The TimeReference is the time zone and daylight savings time information that was used when recording the underlying data set. This is useful for correctly aligning data from different time zones.

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.

setTimeReferenceByRef

void setTimeReferenceByRef(ITimeReference nativeTimeReference)
                           throws IOException,
                                  AutomationException

Time reference for the data.

Product Availability

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

Parameters:

nativeTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomTimeExtent

ITimeExtent getCustomTimeExtent()
                                throws IOException,
                                       AutomationException

Custom time extent during which a layer is visible.

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.

setCustomTimeExtentByRef

void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
                              throws IOException,
                                     AutomationException

Custom time extent during which a layer is visible.

Product Availability

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

Parameters:

layerVisibiltyTime - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.