com.esri.arcgis.geodatabaseextensions
Interface ITemporalRecordSet

All Superinterfaces:
Serializable
All Known Implementing Classes:
TemporalRecordSet

public interface ITemporalRecordSet
extends Serializable

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

Product Availability

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


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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

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.

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.

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.