com.esri.arcgis.trackinganalyst
Class AMSWorkspace

java.lang.Object
  com.esri.arcgis.trackinganalyst.AMSWorkspace

All Implemented Interfaces:

IDataset, IWorkspace, IWorkspaceProperties, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IAMSWorkspace, ITemporalWorkspaceStatistics, ITxDiagnostics, Serializable

public class AMSWorkspace
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceProperties, ITxDiagnostics, IWorkspace, IAMSWorkspace, IDataset, ITemporalWorkspaceStatistics, ISupportErrorInfo

Controls the Tracking Server workspace COM object's properties.

Description

This is the AMS workspace object, which is responsible for the following functionality:

• Connecting into an AMS server
• Opening datasets
• Managing these open datasets
• Managing available datasets
• Dispatching data message to the proper open dataset

This object is only createable through the AMSWorkspaceFactory object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

AMSWorkspace(Object obj)
Construct a AMSWorkspace using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	connect() Creates real-time data connection in the tracking workspace.
IDataset	copy(String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
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	delete() Deletes this dataset.
void	disconnect() Disconnects a data connection in the tracking workspace.
boolean	equals(Object o) Compare this object with another
void	executeSQL(String sqlStmt) Executes the specified SQL statement.
boolean	exists() Checks if the workspace exists.
String	getActivityLog() Indicates error code value for the last Internet server connection.
IPropertySet	getAllMessageRates() Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllSampleSizes() Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllTotalFeatureCounts() Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllTrackCounts() Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.
String	getBrowseName() The browse name of the dataset.
String	getCategory() The category of the dataset.
IPropertySet	getConnectionProperties() The connection properties of the workspace.
IPropertySet	getConnectionStatus() Indicates the connection status of each workspace under the workspace factory
IPropertySet	getCurrentDiscardedMessageCounts() Indicates current number of messages discarded.
IEnumDatasetName	getDatasetNames(int datasetType) The DatasetNames in the workspace.
IEnumDataset	getDatasets(int datasetType) The datasets in the workspace.
IPropertySet	getDiscardedMessageCounts() Indicates total number of messages discarded.
IName	getFullName() The associated name object.
int	getLastConnectionErrorCode() Indicates error code value for the last Internet server connection.
String	getLastConnectionErrorMessage() Indicates error code value for the last Internet server connection.
String	getName() The name of the Dataset.
String	getPathName() The file system full path of the workspace.
IWorkspaceProperty	getProperty(int propertyGroup, int propertyType) Information about this particular property.
IPropertySet	getPropertySet() The set of properties for the dataset.
IPropertySet	getPulledMessageCounts() Indicates total number of messages pulled.
IPropertySet	getQueuedMessageCounts() Indicates total number of messages queued.
IPropertySet	getReceivedMessageCounts() Indicates total number of messages received.
IServerConnection	getServerConnection() Defines aspects of the server connection.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getType() The Type of the Workspace.
IWorkspace	getWorkspace() The workspace containing this dataset.
IWorkspaceFactory	getWorkspaceFactory() The factory that created the workspace.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isDirectory() TRUE if the workspace is a file system directory.
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	rename(String name) Renames this Dataset.
void	resetAllFeatureCounts() Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.
void	resetAllMessageRates() Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.
void	setAllSampleSizes(int lSampleSize) Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.
void	setBrowseName(String name) The browse name of the dataset.
void	setProperty(int propertyGroup, int propertyType, IWorkspaceProperty workspaceProperty) Information about this particular property.
void	storeProperties() Stores connection properties in the workspace.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AMSWorkspace

public AMSWorkspace(Object obj)
             throws IOException

Construct a AMSWorkspace using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AMSWorkspace.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
AMSWorkspace o = (AMSWorkspace)obj; // will not work

AMSWorkspace o = new AMSWorkspace(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems AMSWorkspace theAMSWorkspace = (AMSWorkspace) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getProperty

public IWorkspaceProperty getProperty(int propertyGroup,
                                      int propertyType)
                               throws IOException,
                                      AutomationException

Information about this particular property.

Product Availability

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

Specified by:

getProperty in interface IWorkspaceProperties

Parameters:

propertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)

propertyType - The propertyType (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(int propertyGroup,
                        int propertyType,
                        IWorkspaceProperty workspaceProperty)
                 throws IOException,
                        AutomationException

Information about this particular property.

Product Availability

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

Specified by:

setProperty in interface IWorkspaceProperties

Parameters:

propertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)

propertyType - The propertyType (in)

workspaceProperty - A reference to a com.esri.arcgis.geodatabase.IWorkspaceProperty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorCode

public int getLastConnectionErrorCode()
                               throws IOException,
                                      AutomationException

Indicates error code value for the last Internet server connection.

Description

This property indicates error code value for the last internet server connection.

Product Availability

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

Specified by:

getLastConnectionErrorCode in interface ITxDiagnostics

Returns:

The pnErrorCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorMessage

public String getLastConnectionErrorMessage()
                                     throws IOException,
                                            AutomationException

Indicates error code value for the last Internet server connection.

Description

This property indicates error message for the last internet server connection.

Product Availability

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

Specified by:

getLastConnectionErrorMessage in interface ITxDiagnostics

Returns:

The pbstrErrorMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivityLog

public String getActivityLog()
                      throws IOException,
                             AutomationException

Indicates error code value for the last Internet server connection.

Description

This property indicates the activity log for the internet server connection.

Product Availability

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

Specified by:

getActivityLog in interface ITxDiagnostics

Returns:

The pbstrLog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

The connection properties of the workspace.

Remarks

The ConnectionProperties property of a workspace returns the set of named connection properties for this workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionProperties in interface IWorkspace

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactory

public IWorkspaceFactory getWorkspaceFactory()
                                      throws IOException,
                                             AutomationException

The factory that created the workspace.

Remarks

The WorkspaceFactory property can be used to get a reference back to the workspace factory for this workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceFactory in interface IWorkspace

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets(int datasetType)
                         throws IOException,
                                AutomationException

The datasets in the workspace.

Product Availability

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

Specified by:

getDatasets in interface IWorkspace

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumDatasetName getDatasetNames(int datasetType)
                                 throws IOException,
                                        AutomationException

The DatasetNames in the workspace.

Product Availability

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

Specified by:

getDatasetNames in interface IWorkspace

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathName

public String getPathName()
                   throws IOException,
                          AutomationException

The file system full path of the workspace.

Remarks

If a remote workspace is opened using connection properties, this will be empty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPathName in interface IWorkspace

Returns:

The pathName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The Type of the Workspace.

Remarks

See esriWorkspaceType for information on the types of workspaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IDataset

Specified by:

getType in interface IWorkspace

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirectory

public boolean isDirectory()
                    throws IOException,
                           AutomationException

TRUE if the workspace is a file system directory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirectory in interface IWorkspace

Returns:

The isDir

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exists

public boolean exists()
               throws IOException,
                      AutomationException

Checks if the workspace exists.

Remarks

This method can be used with workspaces from file-based data sources to detect if they've been deleted by another application. For example, a shapefile workspace is a directory and can be deleted while the workspace is open.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

exists in interface IWorkspace

Returns:

The exists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

executeSQL

public void executeSQL(String sqlStmt)
                throws IOException,
                       AutomationException

Executes the specified SQL statement.

Remarks

The ExecuteSQL method can be used to send an arbitrary SQL statement to the underlying database for execution. The statement can be any DDL (data definition language) or DML (data manipulation language) statement but can not return any result sets. The syntax for the SQL is as required by the underlying database. The workspace supports an optional ISQLSyntax interface that provides information to applications on aspects of the SQL Syntax for the underlying database.

To determine if a workspace supports the ExecutesSQL method, an application can check the value of the canExecuteSQLworkspace property via the optional IWorkspaceProperties interface. In general, this method is only supported on local and remote database workspaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

executeSQL in interface IWorkspace

Parameters:

sqlStmt - The sqlStmt (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public 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.

Specified by:

connect in interface IAMSWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public 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.

Specified by:

disconnect in interface IAMSWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFeatureClass

public 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.

Specified by:

openFeatureClass in interface IAMSWorkspace

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

public 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.

Specified by:

openTable in interface IAMSWorkspace

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

public 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.

Specified by:

createTable in interface IAMSWorkspace

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

public 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.

Specified by:

createFeatureClass in interface IAMSWorkspace

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

public 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.

Specified by:

createQueryDef in interface IAMSWorkspace

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

public 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.

Specified by:

openFeatureQuery in interface IAMSWorkspace

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

public 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.

Specified by:

getServerConnection in interface IAMSWorkspace

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

public 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.

Specified by:

storeProperties in interface IAMSWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadProperties

public 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.

Specified by:

loadProperties in interface IAMSWorkspace

Parameters:

bstrTableName - The bstrTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the Dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The associated name object.

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFullName in interface IDataset

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name of the dataset.

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException

The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the dataset.

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException

Datasets contained within this dataset.

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspace in interface IDataset

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

The set of properties for the dataset.

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertySet in interface IDataset

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException

True if this dataset can be copied.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

• CAD Drawings
• Coverages
• DBase Tables
• Info Tables
• Raster Datasets
• SDC datasets
• SDC Network Datasets
• Shapefiles
• Shapefile Network Datasets

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException

Copies this dataset to a new dataset with the specified name.

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface IDataset

Parameters:

copyName - The copyName (in)

copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException

True if this dataset can be deleted.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes this dataset.

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

delete in interface IDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException

True if this dataset can be renamed.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String name)
            throws IOException,
                   AutomationException

Renames this Dataset.

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllTrackCounts

public IPropertySet getAllTrackCounts()
                               throws IOException,
                                      AutomationException

Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.

Description

This property provides the caller track count for each temporal feature class under the workspace or workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

Product Availability

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

Specified by:

getAllTrackCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.getAllTrackCounts(), ITemporalFeatureClassStatistics.getTrackCount()

getAllMessageRates

public IPropertySet getAllMessageRates()
                                throws IOException,
                                       AutomationException

Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

This property provides the caller message rate (per second) for each temporal feature class under the workspace or workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

Product Availability

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

Specified by:

getAllMessageRates in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.getAllSampleSizes(), ITemporalWorkspaceStatistics.setAllSampleSizes(int)

getAllSampleSizes

public IPropertySet getAllSampleSizes()
                               throws IOException,
                                      AutomationException

Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

This property provides the caller sample size for each temporal feature class under the workspace or workspace factory. Sample size is the maximum number of most current samples used for computing message rate. If the total number of samples is less than the sample size, the total number of samples will be used for computing message rate. The default sample size is 500. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

Product Availability

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

Specified by:

getAllSampleSizes in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.getAllMessageRates(), ITemporalWorkspaceStatistics.setAllSampleSizes(int)

getAllTotalFeatureCounts

public IPropertySet getAllTotalFeatureCounts()
                                      throws IOException,
                                             AutomationException

Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.

Description

This property provides the caller total feature count for each temporal feature class under the workspace or workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

Product Availability

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

Specified by:

getAllTotalFeatureCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.resetAllFeatureCounts()

getConnectionStatus

public IPropertySet getConnectionStatus()
                                 throws IOException,
                                        AutomationException

Indicates the connection status of each workspace under the workspace factory

Description

This property provides the caller connection status (esriWorkspaceConnectionStatus.esriWCSUp or esriWorkspaceConnectionStatus.esriWCSDown) for the workspace or each workspace under the workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_ConnectionName” in the property set. If the function is called by a workspace object, the name of each property shows as “ConnectionName” in the property set.

Product Availability

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

Specified by:

getConnectionStatus in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReceivedMessageCounts

public IPropertySet getReceivedMessageCounts()
                                      throws IOException,
                                             AutomationException

Indicates total number of messages received.

Description

This property provides the caller total received message count for the workspace or each workspace under the workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Received Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Received Message Count” in the property set.

Product Availability

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

Specified by:

getReceivedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPulledMessageCounts

public IPropertySet getPulledMessageCounts()
                                    throws IOException,
                                           AutomationException

Indicates total number of messages pulled.

Description

This property provides the caller total pulled message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue. Pulled message count is needed because some received messages could be discarded from the queue once the queue grows to exceed its pre-defined size. It could happen when, for instance, Tracking Analyst cannot process received messages at a rate faster than they are arriving. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Pulled Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Pulled Message Count” in the property set.

Product Availability

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

Specified by:

getPulledMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiscardedMessageCounts

public IPropertySet getDiscardedMessageCounts()
                                       throws IOException,
                                              AutomationException

Indicates total number of messages discarded.

Description

This property provides the caller discarded message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue. Some messages could be discarded from the queue once the queue grows to exceed its pre-defined size. It could happen when, for instance, Tracking Analyst cannot process received messages at a rate faster than they are arriving. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Discarded Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Discarded Message Count” in the property set.

Product Availability

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

Specified by:

getDiscardedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDiscardedMessageCounts

public IPropertySet getCurrentDiscardedMessageCounts()
                                              throws IOException,
                                                     AutomationException

Indicates current number of messages discarded.

Description

This property provides the caller current discarded message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue. Some messages could be discarded from the queue once the queue grows to exceed its pre-defined size. It could happen when, for instance, Tracking Analyst cannot process received messages at a rate faster than they are arriving. The difference between current discarded message count and discarded message count is that current discarded message count resets once the internal message queue is no long full whereas discarded message count does not reset. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Discarded Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Discarded Message Count” in the property set.

Product Availability

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

Specified by:

getCurrentDiscardedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueuedMessageCounts

public IPropertySet getQueuedMessageCounts()
                                    throws IOException,
                                           AutomationException

Indicates total number of messages queued.

Description

This property provides the caller queued message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue before they are pulled for processing. Queued message count indicates the number of messages currently in the queue waiting to be processed. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Discarded Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Discarded Message Count” in the property set.

Product Availability

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

Specified by:

getQueuedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAllFeatureCounts

public void resetAllFeatureCounts()
                           throws IOException,
                                  AutomationException

Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.

Description

This method resets total feature count to zero for each temporal feature class under the workspace or workspace factory. This method is typically used when the user wants to count the total number of new features after a specific event or time.

Product Availability

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

Specified by:

resetAllFeatureCounts in interface ITemporalWorkspaceStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.getAllTotalFeatureCounts()

resetAllMessageRates

public void resetAllMessageRates()
                          throws IOException,
                                 AutomationException

Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

This method resets message rate for each temporal feature class under the workspace or workspace factory. The message rate is determined by sampling a number (sample size) of received features. After the method is called, message rates will be calculated using only new features received after the method call. This method is typically used when the rate of incoming message changes so that historical data may affect the accuracy of the current message rate.

Product Availability

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

Specified by:

resetAllMessageRates in interface ITemporalWorkspaceStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.getAllMessageRates()

setAllSampleSizes

public void setAllSampleSizes(int lSampleSize)
                       throws IOException,
                              AutomationException

Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.

Description

This method sets sample size for each temporal feature class under the workspace or workspace factory. Sample size is the number of samples used for calculating the message rate for a temporal feature class. (If the total number of messages received is less than the sample size, the message rate will be calculated based on the messages received.) The default value of sample size is 500.

Product Availability

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

Specified by:

setAllSampleSizes in interface ITemporalWorkspaceStatistics

Parameters:

lSampleSize - The lSampleSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITemporalWorkspaceStatistics.getAllMessageRates(), ITemporalWorkspaceStatistics.getAllSampleSizes(), ITemporalFeatureClassStatistics.getMessageRate()

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.