com.esri.arcgis.trackinganalyst
Interface ITemporalRecordSet

All Superinterfaces:

Serializable

All Known Implementing Classes:

ITemporalRecordSetProxy, TemporalRecordSet

public interface ITemporalRecordSet
extends Serializable

Provides access to methods needed to set up and fill a temporally sorted record set.

Description

This Interface exposes methods needed to set up and fill a temporally sorted record set. This interface also provides methods to build the temporal index and cache features based on time window specified.

Product Availability

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

Method Summary

int	getCount() Number of features contained by the cursor.
int	getFeatureCacheWindow() Determines the number of features to cache if FeaturesCached property is true.
IFeatureClass	getFeatureClass() A reference to the feature class of which this record set is a member.
Object	getMostCurrentFeature() Returns success, but does nothing.
Object	getOldestFeature() Returns success, but does nothing.
String	getTemporalColumnName() Identifies the column containing time and date information.
String	getTimeSeriesColumnName() Identifies column in the feature class containing temporal observations with time series.
void	indexFeatureClass(Object cacheStartingTime, Object cacheEndingTime, ISelectionSet selSet, IQueryFilter queryFilter, int localeLanguageID, String dateFormat, String timeFormat, String aMDesignator, String pMDesignator) Re-builds the temporal index and caches features based on the supplied temporal parameters.
boolean	isCacheFeatures() Controls whether features are cached in the renderer's feature memory or are read from the feature class.
IFeatureCursor	search(IQueryFilter queryFilter, boolean recycling, boolean forDrawing) Performs a query on the record set for the given time range, returning a feature cursor.
ISelectionSet	selectByDate(Object startDate, Object endDate) Allows user to select record set by its date value.
void	setCacheFeatures(boolean cacheTheFeatures) Controls whether features are cached in the renderer's feature memory or are read from the feature class.
void	setFeatureCacheWindow(int percent) Determines the number of features to cache if FeaturesCached property is true.
void	setFeatureClassByRef(IFeatureClass featureClass) A reference to the feature class of which this record set is a member.
void	setTemporalColumnName(String name) Identifies the column containing time and date information.
void	setTimeSeriesColumnName(String name) Identifies column in the feature class containing temporal observations with time series.

Method Detail

getTemporalColumnName

String getTemporalColumnName()
                             throws IOException,
                                    AutomationException

Identifies the column containing time and date information.

Description

This property is the name of the temporal column name. This column contains time-date information.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

void setTemporalColumnName(String name)
                           throws IOException,
                                  AutomationException

Identifies the column containing time and date information.

Description

This property is the name of the temporal column name. This column contains time-date information.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException

A reference to the feature class of which this record set is a member.

Description

This property sets a reference to the feature class that this record set is a part of.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

void setFeatureClassByRef(IFeatureClass featureClass)
                          throws IOException,
                                 AutomationException

A reference to the feature class of which this record set is a member.

Description

This routine sets a reference to the feature class that this record set is a part of.

Product Availability

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

Parameters:

featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexFeatureClass

void indexFeatureClass(Object cacheStartingTime,
                       Object cacheEndingTime,
                       ISelectionSet selSet,
                       IQueryFilter queryFilter,
                       int localeLanguageID,
                       String dateFormat,
                       String timeFormat,
                       String aMDesignator,
                       String pMDesignator)
                       throws IOException,
                              AutomationException

Re-builds the temporal index and caches features based on the supplied temporal parameters.

Description

This method re-builds the temporal index and caches features based on the supplied temporal parameters. This method indexes all features in a feature class but only caches or saves the features object instances that fall within the parameters supplied.

Remarks

The cvarCacheStartingTime and cvarCacheEndingTime are 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.

Parameters:

cacheStartingTime - A Variant (in)

cacheEndingTime - A Variant (in)

selSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

localeLanguageID - The localeLanguageID (in)

dateFormat - The dateFormat (in)

timeFormat - The timeFormat (in)

aMDesignator - The aMDesignator (in)

pMDesignator - The pMDesignator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of features contained by the cursor.

Description

This property provides the number of features that this record set contains.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

search

IFeatureCursor search(IQueryFilter queryFilter,
                      boolean recycling,
                      boolean forDrawing)
                      throws IOException,
                             AutomationException

Performs a query on the record set for the given time range, returning a feature cursor.

Description

This method performs a query on the record set for the given time range and returns a Feature Cursor that the caller can iterate through to extract the features in ascending or descending temporal order.

The starting or ending date can be set to the constant TEMPORALEXTENT and the starting or ending time will begin with the first or last time in the record set depending on which argument it is set to. If both arguments are set to TEMPORALEXTENT then the whole record set is traversed.

Product Availability

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

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

forDrawing - The forDrawing (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureCursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheFeatures

boolean isCacheFeatures()
                        throws IOException,
                               AutomationException

Controls whether features are cached in the renderer's feature memory or are read from the feature class.

Product Availability

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

Returns:

The cacheTheFeatures

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheFeatures

void setCacheFeatures(boolean cacheTheFeatures)
                      throws IOException,
                             AutomationException

Controls whether features are cached in the renderer's feature memory or are read from the feature class.

Description

This property controls whether Features are cached in the renders feature memory or are read from the feature class.

Product Availability

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

Parameters:

cacheTheFeatures - The cacheTheFeatures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeSeriesColumnName

String getTimeSeriesColumnName()
                               throws IOException,
                                      AutomationException

Identifies column in the feature class containing temporal observations with time series.

Description

This property identifies the feature class's column that identifies or groups temporal observations with time series.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeSeriesColumnName

void setTimeSeriesColumnName(String name)
                             throws IOException,
                                    AutomationException

Identifies column in the feature class containing temporal observations with time series.

Description

This property identifies the feature class's column that identifies or groups temporal observations with time series.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureCacheWindow

int getFeatureCacheWindow()
                          throws IOException,
                                 AutomationException

Determines the number of features to cache if FeaturesCached property is true.

Description

This property determines the amount of features to cache if features Cached property is true. This property uses the temporal references temporal period property to determine the period and then adds x percent to each end of the current temporally displayable features. For example, if the temporal period is 10 min and this property is 50, the resulting cached features will be 5 min before and 5 min after the 10 min period that is currently displayed.

Product Availability

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

Returns:

The percent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureCacheWindow

void setFeatureCacheWindow(int percent)
                           throws IOException,
                                  AutomationException

Determines the number of features to cache if FeaturesCached property is true.

Description

This property determines the amount of features to cache if features Cached property is true. This property uses the temporal references temporal period property to determine the period and then adds x percent to each end of the current temporally displayable features. For example, if the temporal period is 10 min and this property is 50, the resulting cached features will be 5 min before and 5 min after the 10 min period that is currently displayed.

Product Availability

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

Parameters:

percent - The percent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOldestFeature

Object getOldestFeature()
                        throws IOException,
                               AutomationException

Returns success, but does nothing.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMostCurrentFeature

Object getMostCurrentFeature()
                             throws IOException,
                                    AutomationException

Returns success, but does nothing.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectByDate

ISelectionSet selectByDate(Object startDate,
                           Object endDate)
                           throws IOException,
                                  AutomationException

Allows user to select record set by its date value.

Product Availability

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

Parameters:

startDate - A Variant (in)

endDate - A Variant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.