com.esri.arcgis.trackinganalyst
Interface IDirectData

All Superinterfaces:

Serializable

All Known Implementing Classes:

IDirectDataProxy, TemporalFeatureClass

public interface IDirectData
extends Serializable

Provides access to enable direct access to data.

Description

This interface provides properties and methods that allow direct data ingestion and provide the Temporal Feature Class with Action processing and management.

Product Availability

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

Method Summary

IActionProcessor	getPreActionProcessor() The action processor that will evaluate the data messages before they are stored.
IActionCollection	getPreActions() Collection of actions that will be evaluated before data messages are placed in feature class storage.
void	postMessage(IDataMessage piMsg) All temporal messages enter the temporal feature class environment via this method.
void	readProperties(IStream piStream) Load an object's properties from a stream.
void	setPreActionProcessorByRef(IActionProcessor ppiProcessor) The action processor that will evaluate the data messages before they are stored.
void	setPreActionsByRef(IActionCollection ppiActions) Collection of actions that will be evaluated before data messages are placed in feature class storage.
void	writeProperties(IStream piStream) Write the object's properties to a stream.

Method Detail

writeProperties

void writeProperties(IStream piStream)
                     throws IOException,
                            AutomationException

Write the object's properties to a stream.

Product Availability

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

Parameters:

piStream - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readProperties

void readProperties(IStream piStream)
                    throws IOException,
                           AutomationException

Load an object's properties from a stream.

Product Availability

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

Parameters:

piStream - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

postMessage

void postMessage(IDataMessage piMsg)
                 throws IOException,
                        AutomationException

All temporal messages enter the temporal feature class environment via this method. It performs validity checks, exclusions, data store purges, pre- and post- actions, and database insertion.

Description

This method is the entry point for all data messages into the feature class. This method will perform pre and post action processing as well as data validity checking and database insertions.

Product Availability

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

Parameters:

piMsg - A reference to a com.esri.arcgis.trackinganalyst.IDataMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreActionProcessor

IActionProcessor getPreActionProcessor()
                                       throws IOException,
                                              AutomationException

The action processor that will evaluate the data messages before they are stored. This permits filtering or ignoring messages that the action indicates.

Description

The pre-action processor is the action processor that will evaluate data messages before they are placed in the feature class's internal storage. This action processor has the capability to filter or drop a data message if a user-defined filter rule determines that the data message needs to be excluded.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPreActionProcessorByRef

void setPreActionProcessorByRef(IActionProcessor ppiProcessor)
                                throws IOException,
                                       AutomationException

The action processor that will evaluate the data messages before they are stored. This permits filtering or ignoring messages that the action indicates.

Description

The pre-action processor is the action processor that will evaluate data messages before they are placed in the feature class's internal storage. This action processor has the capability to filter or drop a data message if a user-defined filter rule determines that the data message needs to be excluded.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreActions

IActionCollection getPreActions()
                                throws IOException,
                                       AutomationException

Collection of actions that will be evaluated before data messages are placed in feature class storage.

Description

This property is a collection of actions that will be evaluated before data messages are placed in the 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.trackinganalyst.IActionCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPreActionsByRef

void setPreActionsByRef(IActionCollection ppiActions)
                        throws IOException,
                               AutomationException

Collection of actions that will be evaluated before data messages are placed in feature class storage.

Description

This property is a collection of actions that will be evaluated before data messages are placed in the 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.trackinganalyst.IActionCollection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.