com.esri.arcgis.carto
Class ITimeTableDefinitionProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.ITimeTableDefinitionProxy

All Implemented Interfaces:

ITimeTableDefinition, Externalizable, Serializable

public class ITimeTableDefinitionProxy
extends com.esri.arcgis.interop.Dispatch
implements ITimeTableDefinition, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ITimeTableDefinitionProxy()
	ITimeTableDefinitionProxy(Object obj)
protected	ITimeTableDefinitionProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITimeTableDefinitionProxy

public ITimeTableDefinitionProxy()

ITimeTableDefinitionProxy

public ITimeTableDefinitionProxy(Object obj)
                          throws IOException

Throws:

IOException

ITimeTableDefinitionProxy

protected ITimeTableDefinitionProxy(Object obj,
                                    String iid)
                             throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getStartTimeFieldName

public 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.

Specified by:

getStartTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

public 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.

Specified by:

setStartTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

public 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.

Specified by:

getEndTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

public 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.

Specified by:

setEndTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

public 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.

Specified by:

getTimeValueFormat in interface ITimeTableDefinition

Returns:

The format

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

public 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.

Specified by:

setTimeValueFormat in interface ITimeTableDefinition

Parameters:

format - The format (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

public 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.

Specified by:

getTrackIDFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackIDFieldName

public 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.

Specified by:

setTrackIDFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public 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.

Specified by:

getTimeReference in interface ITimeTableDefinition

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

public void setTimeReferenceByRef(ITimeReference nativeTimeReference)
                           throws IOException,
                                  AutomationException

Time reference for the data.

Product Availability

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

Specified by:

setTimeReferenceByRef in interface ITimeTableDefinition

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

public 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.

Specified by:

getCustomTimeExtent in interface ITimeTableDefinition

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

public 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.

Specified by:

setCustomTimeExtentByRef in interface ITimeTableDefinition

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.