com.esri.arcgis.trackinganalyst
Interface IAMSWorkspace

All Superinterfaces:

Serializable

All Known Implementing Classes:

AMSWorkspace, IAMSWorkspaceProxy

public interface IAMSWorkspace
extends Serializable

Provides access to properties and methods needed to control and manage in the tracking workspace.

Description

This interface provides the methods and properties required to open temporal feature classes and tables from an AMS (tracking) server, and to create new standalone feature classes, tables and query definition objects under the workspace. This interface also allows the disconnect and re-connection of the AMS server without degrading the data already received.

Product Availability

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

Method Summary

void	connect() Creates real-time data connection in the tracking workspace.
IFeatureClass	createFeatureClass(String name, IFields fields, IUID clsid, IUID eXTCLSID, int featureType, String shapeFieldName, String configKeyword) Creates a new standalone feature class under the workspace.
IQueryDef	createQueryDef() Create a query definition object.
ITable	createTable(String name, IFields fields, IUID clsid, IUID eXTCLSID, String configKeyword) Creates a new table.
void	disconnect() Disconnects a data connection in the tracking workspace.
IServerConnection	getServerConnection() Defines aspects of the server connection.
void	loadProperties(String bstrTableName) Loads properties for connection in the workspace.
IFeatureClass	openFeatureClass(String name) Opens an existing feature class.
IFeatureDataset	openFeatureQuery(String queryName, IQueryDef pQueryDef) Opens a feature dataset containing a single feature dlass defined by the specified Query.
ITable	openTable(String name) Opens an existing table.
void	storeProperties() Stores connection properties in the workspace.

Method Detail

connect

void connect()
             throws IOException,
                    AutomationException

Creates real-time data connection in the tracking workspace.

Description

This method connects the workspace to an AMS (tracking) server.

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.

disconnect

void disconnect()
                throws IOException,
                       AutomationException

Disconnects a data connection in the tracking workspace.

Description

This method disconnects the workspace from a connected AMS (Tracking) Server.

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.

openFeatureClass

IFeatureClass openFeatureClass(String name)
                               throws IOException,
                                      AutomationException

Opens an existing feature class.

Description

This method opens an existing feature class specified by the name.

Product Availability

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

Parameters:

name - The name (in)

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.

openTable

ITable openTable(String name)
                 throws IOException,
                        AutomationException

Opens an existing table.

Description

This method opens an existing table specified by the name.

Product Availability

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

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTable

ITable createTable(String name,
                   IFields fields,
                   IUID clsid,
                   IUID eXTCLSID,
                   String configKeyword)
                   throws IOException,
                          AutomationException

Creates a new table.

Description

This method creates a new table specified by the name. Current version of Tracking Analyst does not support the capability to create tables.

Product Availability

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

Parameters:

name - The name (in)

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

clsid - A reference to a com.esri.arcgis.system.IUID (in)

eXTCLSID - A reference to a com.esri.arcgis.system.IUID (in)

configKeyword - The configKeyword (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFeatureClass

IFeatureClass createFeatureClass(String name,
                                 IFields fields,
                                 IUID clsid,
                                 IUID eXTCLSID,
                                 int featureType,
                                 String shapeFieldName,
                                 String configKeyword)
                                 throws IOException,
                                        AutomationException

Creates a new standalone feature class under the workspace.

Description

This method creates a new feature class specified by the name. Current version of Tracking Analyst does not support the capability to create feature classes.

Product Availability

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

Parameters:

name - The name (in)

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

clsid - A reference to a com.esri.arcgis.system.IUID (in)

eXTCLSID - A reference to a com.esri.arcgis.system.IUID (in)

featureType - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)

shapeFieldName - The shapeFieldName (in)

configKeyword - The configKeyword (in)

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.

createQueryDef

IQueryDef createQueryDef()
                         throws IOException,
                                AutomationException

Create a query definition object.

Description

This method creates a new query definition object. Current version of Tracking Analyst does not support the capability to create query definitions.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFeatureQuery

IFeatureDataset openFeatureQuery(String queryName,
                                 IQueryDef pQueryDef)
                                 throws IOException,
                                        AutomationException

Opens a feature dataset containing a single feature dlass defined by the specified Query.

Description

This method opens a feature dataset containing a single feature class defined by the specified query. Current version of Tracking Analyst does not support the capability to open feature queries.

Product Availability

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

Parameters:

queryName - The queryName (in)

pQueryDef - A reference to a com.esri.arcgis.geodatabase.IQueryDef (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerConnection

IServerConnection getServerConnection()
                                      throws IOException,
                                             AutomationException

Defines aspects of the server connection.

Description

This property defines aspects of the server connection.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

storeProperties

void storeProperties()
                     throws IOException,
                            AutomationException

Stores connection properties in the workspace.

Description

This method stores the workspace properties information for itself and its feature classes into the legacy .atn file(s) and a new technique that stores this info into the connection properties object. The latter allows the information about purge rules, buffer size, and actions to be transported between users and machines.

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.

loadProperties

void loadProperties(String bstrTableName)
                    throws IOException,
                           AutomationException

Loads properties for connection in the workspace.

Description

This method is called by the feature class upon initialization to load in state properties that were configured by the user. These properties can be loaded from one of two sources, a .atn file in the users applications dir or from the connection properties. The precedence of loading is to try the connection properties first and if that is not successful, then load from the .atn file. The .atn file is the legacy method.

Product Availability

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

Parameters:

bstrTableName - The bstrTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.