|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITimeTableDefinition
Provides access to time related properties of a layer.
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.
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 |
---|
String getStartTimeFieldName() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setStartTimeFieldName(String fieldName) throws IOException, AutomationException
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getEndTimeFieldName() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEndTimeFieldName(String fieldName) throws IOException, AutomationException
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getTimeValueFormat() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeValueFormat(String format) throws IOException, AutomationException
format
- The format (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getTrackIDFieldName() throws IOException, AutomationException
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).
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTrackIDFieldName(String fieldName) throws IOException, AutomationException
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ITimeReference getTimeReference() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeReferenceByRef(ITimeReference nativeTimeReference) throws IOException, AutomationException
nativeTimeReference
- A reference to a com.esri.arcgis.system.ITimeReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ITimeExtent getCustomTimeExtent() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime) throws IOException, AutomationException
layerVisibiltyTime
- A reference to a com.esri.arcgis.system.ITimeExtent (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |