com.esri.arcgis.geodatabaseextensions
Interface ITemporalRecordSet

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITemporalRecordSetProxy, TemporalRecordSet

public interface ITemporalRecordSet
extends java.io.Serializable

COM Interface 'ITemporalRecordSet'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoDatabaseExtensions.olb'

Description: 'Provides access to methods needed to set up and fill a temporally sorted record set.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID78c74302_17cf_11d5_b7cf_00010265adc5
static int	xxDummy Deprecated. Internal use only

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.
java.lang.Object	getMostCurrentFeature() Returns success, but does nothing.
java.lang.Object	getOldestFeature() Returns success, but does nothing.
java.lang.String	getTemporalColumnName() Identifies the column containing time and date information.
java.lang.String	getTimeSeriesColumnName() Identifies column in the feature class containing temporal observations with time series.
void	indexFeatureClass(java.lang.Object cacheStartingTime, java.lang.Object cacheEndingTime, ISelectionSet selSet, IQueryFilter queryFilter, int localeLanguageID, java.lang.String dateFormat, java.lang.String timeFormat, java.lang.String amDesignator, java.lang.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(java.lang.Object startDate, java.lang.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(java.lang.String name) Identifies the column containing time and date information.
void	setTimeSeriesColumnName(java.lang.String name) Identifies column in the feature class containing temporal observations with time series.

Field Detail

IID78c74302_17cf_11d5_b7cf_00010265adc5

static final int IID78c74302_17cf_11d5_b7cf_00010265adc5

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getTemporalColumnName

java.lang.String getTemporalColumnName()
                                       throws java.io.IOException,
                                              AutomationException

Identifies the column containing time and date information.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

void setTemporalColumnName(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException

Identifies the column containing time and date information.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

void setFeatureClassByRef(IFeatureClass featureClass)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexFeatureClass

void indexFeatureClass(java.lang.Object cacheStartingTime,
                       java.lang.Object cacheEndingTime,
                       ISelectionSet selSet,
                       IQueryFilter queryFilter,
                       int localeLanguageID,
                       java.lang.String dateFormat,
                       java.lang.String timeFormat,
                       java.lang.String amDesignator,
                       java.lang.String pmDesignator)
                       throws java.io.IOException,
                              AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws java.io.IOException,
                    AutomationException

Number of features contained by the cursor.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

search

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheFeatures

boolean isCacheFeatures()
                        throws java.io.IOException,
                               AutomationException

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

Returns:

The cacheTheFeatures

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheFeatures

void setCacheFeatures(boolean cacheTheFeatures)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

cacheTheFeatures - The cacheTheFeatures (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeSeriesColumnName

java.lang.String getTimeSeriesColumnName()
                                         throws java.io.IOException,
                                                AutomationException

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

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeSeriesColumnName

void setTimeSeriesColumnName(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException

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

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureCacheWindow

int getFeatureCacheWindow()
                          throws java.io.IOException,
                                 AutomationException

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

Returns:

The percent

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureCacheWindow

void setFeatureCacheWindow(int percent)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

percent - The percent (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOldestFeature

java.lang.Object getOldestFeature()
                                  throws java.io.IOException,
                                         AutomationException

Returns success, but does nothing.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMostCurrentFeature

java.lang.Object getMostCurrentFeature()
                                       throws java.io.IOException,
                                              AutomationException

Returns success, but does nothing.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectByDate

ISelectionSet selectByDate(java.lang.Object startDate,
                           java.lang.Object endDate)
                           throws java.io.IOException,
                                  AutomationException

Allows user to select record set by its date value.

Parameters:

startDate - A Variant (in)

endDate - A Variant (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.