com.esri.arcgis.trackinganalyst
Class ITemporalSearchProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.trackinganalyst.ITemporalSearchProxy
All Implemented Interfaces:
ITemporalSearch, Externalizable, Serializable

public class ITemporalSearchProxy
extends com.esri.arcgis.interop.Dispatch
implements ITemporalSearch, Serializable

Provides access to properties and methods needed to manage searching temporal datasets.

Description

This interface provides methods to search for last known features and last known OIDs in the dataset. It also provides a method to query temporal data within the full temporal extent of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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
  ITemporalSearchProxy()
           
  ITemporalSearchProxy(Object obj)
           
protected ITemporalSearchProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 ICursor lastKnownFeatures(Object varStartingTime, Object varEndingTime)
          Searches for last known features in the dataset.
 IFeatureIDSet lastKnownOIDs(Object varStartingTime, Object varEndingTime)
          Searches for the last known OIDs in the dataset.
 void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime)
          Queries temporal data within the full temporal extent of the dataset.
 void removeListener(String iidStr, Object theListener)
           
 
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

ITemporalSearchProxy

public ITemporalSearchProxy()

ITemporalSearchProxy

public ITemporalSearchProxy(Object obj)
                     throws IOException
Throws:
IOException

ITemporalSearchProxy

protected ITemporalSearchProxy(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

lastKnownOIDs

public IFeatureIDSet lastKnownOIDs(Object varStartingTime,
                                   Object varEndingTime)
                            throws IOException,
                                   AutomationException
Searches for the last known OIDs in the dataset.

Description

This method returns a FeatureIDSet containing the most recent OID for each track. If a start and/or end time are specified then features occurring outside of the time span are not factored into the search. Passing NULL for the start time and end time will cause all data in the temporal extent to be evaluated.

Remarks

The start and end time automation compliant date types. In C++ you can use any type that converts to a VT_DATE type, in VB a Date type, and in C# a DateTime type. Getting the LastKnownOIDs is faster than getting the LastKnownFeatures so it is advisable to use this method where possible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
lastKnownOIDs in interface ITemporalSearch
Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureIDSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lastKnownFeatures

public ICursor lastKnownFeatures(Object varStartingTime,
                                 Object varEndingTime)
                          throws IOException,
                                 AutomationException
Searches for last known features in the dataset.

Description

This method returns an ICursor containing the most recent feature for each track. If a start and/or end time are specified, then features occurring outside of the time span are not factored into the search. Passing NULL for the start time and end time will cause all data in the temporal extent to be evaluated.

Remarks

The start and end time automation compliant date types. In C++ you can use any type that converts to a VT_DATE type, in VB a Date type, and in C# a DateTime type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
lastKnownFeatures in interface ITemporalSearch
Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

public void queryTemporalExtent(Object[] pvarStartTime,
                                Object[] pvarEndTime)
                         throws IOException,
                                AutomationException
Queries temporal data within the full temporal extent of the dataset.

Description

This method queries the dataset to find the dates of the oldest feature and newest feature. This time span is the temporal extent of the dataset.

Remarks

The start and end time automation compliant date types. In C++ you can use any type that converts to a VT_DATE type, in VB a Date type, and in C# a DateTime type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
queryTemporalExtent in interface ITemporalSearch
Parameters:
pvarStartTime - A Variant (in/out: use single element array)
pvarEndTime - A Variant (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.