com.esri.arcgis.trackinganalyst
Interface ITemporalFeatureClass

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITemporalFeatureClass3

All Known Implementing Classes:

ITemporalFeatureClassProxy, TemporalFeatureClass

public interface ITemporalFeatureClass
extends Serializable

Provides access to properties that allow the temporal column to be identified within a feature class and to set the TemporalObjectColumn name.

Description

This interface provides properties that allow the temporal column to be identified within a feature class, and properties to set the TemporalObjectColumnName otherwise known as the tracking id. This interface also provides functions to prune the underline table of the TemporalFeatureClass, and to query the feature class using the full temporal extent.

Product Availability

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

Method Summary

IActionProcessor	getPostActionProcessor() Evaluates data messages once they are placed in the feature class' internal storage.
IActionCollection	getPostActions() Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.
double	getPurgePercentage() Indicates percentage of the maximum number of records to delete when the Purge method is called.
int	getPurgeRule() Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).
String	getTemporalColumnName() Name of the column containing the time-date information.
String	getTemporalObjectColumnName() Name of the column containing the track information.
Object	getThreshold() Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.
boolean	isAutoPurge() Controls whether or not to automatically purge records once a user-defined threshold is met.
boolean	isContainsTemporalObjects() Indicates whether or not a temporal object table is used to collect or provide static information about temporal observations.
void	pruneTable() Apply the purge rule to the temporal table.
void	queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime) Queries the feature class using the full temporal extent.
void	registerListener(IListener piListener) Registers a Listener Object with the feature class.
void	setAutoPurge(boolean pVal) Controls whether or not to automatically purge records once a user-defined threshold is met.
void	setPostActionProcessorByRef(IActionProcessor ppiProcessor) Evaluates data messages once they are placed in the feature class' internal storage.
void	setPostActionsByRef(IActionCollection ppiActions) Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.
void	setPurgePercentage(double pVal) Indicates percentage of the maximum number of records to delete when the Purge method is called.
void	setPurgeRule(int pVal) Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).
void	setTemporalColumnName(String pVal) Name of the column containing the time-date information.
void	setThreshold(Object pVal) Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.

Method Detail

queryTemporalExtent

void queryTemporalExtent(Object[] pvarStartTime,
                         Object[] pvarEndTime)
                         throws IOException,
                                AutomationException

Queries the feature class using the full temporal extent.

Description

This function returns the full temporal extent of data stored in the feature class. The returned objects are VT_DATE type (e.g., “mm/dd/yyyy hh:mm:ss AM/PM”).

Product Availability

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

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.

getTemporalColumnName

String getTemporalColumnName()
                             throws IOException,
                                    AutomationException

Name of the column containing the time-date information.

Description

This property is the name of the column that contains the temporal data. This data can be a timestamp or a time period.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

void setTemporalColumnName(String pVal)
                           throws IOException,
                                  AutomationException

Name of the column containing the time-date information.

Description

This property is the name of the column that contains the temporal data. This data can be a timestamp or a time period.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isContainsTemporalObjects

boolean isContainsTemporalObjects()
                                  throws IOException,
                                         AutomationException

Indicates whether or not a temporal object table is used to collect or provide static information about temporal observations.

Description

This property indicates whether or not a temporal object table is used to collect or provide static information about temporal observations. This simply means that for a given temporal observation there is a set of static attributes that do not change from observation to observation.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalObjectColumnName

String getTemporalObjectColumnName()
                                   throws IOException,
                                          AutomationException

Name of the column containing the track information.

Description

This property returns the column name that provides the temporal data. This property is set during the feature classes creation and is read-only.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPostActionProcessor

IActionProcessor getPostActionProcessor()
                                        throws IOException,
                                               AutomationException

Evaluates data messages once they are placed in the feature class' internal storage.

Description

The post action processor is the action processor that will evaluate data messages once they are placed in the feature class's internal storage. These data messages are queued to the actions processor's work queue, and a separate thread is used to perform this processing.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IActionProcessor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPostActionProcessorByRef

void setPostActionProcessorByRef(IActionProcessor ppiProcessor)
                                 throws IOException,
                                        AutomationException

Evaluates data messages once they are placed in the feature class' internal storage.

Description

The post action processor is the action processor that will evaluate data messages once they are placed in the feature class's internal storage. These data messages are queued to the actions processor's work queue, and a separate thread is used to perform this processing.

Product Availability

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

Parameters:

ppiProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPostActions

IActionCollection getPostActions()
                                 throws IOException,
                                        AutomationException

Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.

Description

This property is a collection of actions that will be evaluated after data messages are placed in the temporal feature class's internal storage.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IActionCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPostActionsByRef

void setPostActionsByRef(IActionCollection ppiActions)
                         throws IOException,
                                AutomationException

Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.

Description

This property is a collection of actions that will be evaluated after data messages are place in the temporal feature class's internal storage.

Product Availability

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

Parameters:

ppiActions - A reference to a com.esri.arcgis.carto.IActionCollection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

registerListener

void registerListener(IListener piListener)
                      throws IOException,
                             AutomationException

Registers a Listener Object with the feature class.

Product Availability

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

Parameters:

piListener - A reference to a com.esri.arcgis.geodatabaseextensions.IListener (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoPurge

boolean isAutoPurge()
                    throws IOException,
                           AutomationException

Controls whether or not to automatically purge records once a user-defined threshold is met.

Description

This property controls whether or not to automatically purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoPurge

void setAutoPurge(boolean pVal)
                  throws IOException,
                         AutomationException

Controls whether or not to automatically purge records once a user-defined threshold is met.

Description

This property controls whether or not to automatically purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreshold

Object getThreshold()
                    throws IOException,
                           AutomationException

Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.

Description

This property indicates the high-water mark or the number of observations that should not be exceeded. When the auto purge property is enabled or true, this level is the maximum number of records that can exist in the table. The auto purge process occurs or is triggered, and it will prune the table according to the Purge Rule. If Auto Purge is not true or enabled then record inserts will fail and no further data will be allowed into the table.

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.

setThreshold

void setThreshold(Object pVal)
                  throws IOException,
                         AutomationException

Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.

Description

This property indicates the high-water mark or the number of observations that should not be exceeded. When the auto purge property is enabled or true, this level is the maximum number of records that can exist in the table. The auto purge process occurs or is triggered, and it will prune the table according to the Purge Rule. If Auto Purge is not true or enabled then record inserts will fail and no further data will be allowed into the table.

Product Availability

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

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPurgePercentage

double getPurgePercentage()
                          throws IOException,
                                 AutomationException

Indicates percentage of the maximum number of records to delete when the Purge method is called.

Description

This property indicates the percentage of the maximum allowed number of records to delete when the Purge method is called. This maximum allowed limit is also the same as the Threshold property.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPurgePercentage

void setPurgePercentage(double pVal)
                        throws IOException,
                               AutomationException

Indicates percentage of the maximum number of records to delete when the Purge method is called.

Description

This property indicates the percentage of the maximum allowed number of records to delete when the Purge method is called. This maximum allowed limit is also the same as the Threshold property.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPurgeRule

int getPurgeRule()
                 throws IOException,
                        AutomationException

Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).

Description

This property identifies the purge rule to apply when the Purge method is called via user, or the auto purge criteria. See the purge rule enumeration constants for details about each rule.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabaseextensions.enumPurgeRule constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPurgeRule

void setPurgeRule(int pVal)
                  throws IOException,
                         AutomationException

Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).

Description

This property identifies the purge rule to apply when the Purge method is called via user ,or the auto purge criteria.

See the purge rule enumeration constants for details about each rule.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.geodatabaseextensions.enumPurgeRule constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pruneTable

void pruneTable()
                throws IOException,
                       AutomationException

Apply the purge rule to the temporal table.

Description

This function applies the purge rule to the temporal table to purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.