com.esri.arcgis.trackinganalyst
Class AMSWorkspace

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

All Implemented Interfaces:

IAMSWorkspace, IDataset, ITxDiagnostics, IWorkspace, IWorkspaceProperties, java.io.Serializable

public class AMSWorkspace

extends java.lang.Object

implements IWorkspaceProperties, ITxDiagnostics, IWorkspace, IAMSWorkspace, IDataset

Controls the Tracking Server workspace COM object's properties.

Product Availability

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

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.

See Also:

Serialized Form

Constructor Summary

AMSWorkspace(java.lang.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(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
IFeatureClass	createFeatureClass(java.lang.String name, IFields fields, IUID cLSID, IUID eXTCLSID, int featureType, java.lang.String shapeFieldName, java.lang.String configKeyword) Creates a new standalone feature class under the workspace.
IQueryDef	createQueryDef() Create a query definition object.
ITable	createTable(java.lang.String name, IFields fields, IUID cLSID, IUID eXTCLSID, java.lang.String configKeyword) Creates a new table.
void	delete() Deletes this dataset.
void	disconnect() Disconnects a data connection in the tracking workspace.
boolean	equals(java.lang.Object o) Compare this object with another
void	executeSQL(java.lang.String sqlStmt) Executes the specified SQL statement.
boolean	exists() Checks if the workspace exists.
java.lang.String	getActivityLog() Indicates error code value for the last Internet server connection.
IAMSWorkspace	getAsIAMSWorkspace() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDataset	getAsIDataset() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITxDiagnostics	getAsITxDiagnostics() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IWorkspace	getAsIWorkspace() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IWorkspaceProperties	getAsIWorkspaceProperties() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getBrowseName() The browse name of the dataset.
java.lang.String	getCategory() The category of the dataset.
IPropertySet	getConnectionProperties() The connection properties of the workspace.
IEnumDatasetName	getDatasetNames(int datasetType) The DatasetNames in the workspace.
IEnumDataset	getDatasets(int datasetType) The datasets in the workspace.
IName	getFullName() The associated name object.
int	getLastConnectionErrorCode() Indicates error code value for the last Internet server connection.
java.lang.String	getLastConnectionErrorMessage() Indicates error code value for the last Internet server connection.
java.lang.String	getName() The name of the Dataset.
java.lang.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.
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
boolean	isDirectory() TRUE if the workspace is a file system directory.
void	loadProperties(java.lang.String bstrTableName) Loads properties for connection in the workspace.
IFeatureClass	openFeatureClass(java.lang.String name) Opens an existing feature class.
IFeatureDataset	openFeatureQuery(java.lang.String queryName, IQueryDef pQueryDef) Opens a feature dataset containing a single feature dlass defined by the specified Query.
ITable	openTable(java.lang.String name) Opens an existing table.
void	rename(java.lang.String name) Renames this Dataset.
void	setBrowseName(java.lang.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

Constructor Detail

AMSWorkspace

public AMSWorkspace(java.lang.Object obj)
             throws java.io.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 AMSWorkspace theAMSWorkspace = (AMSWorkspace) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIWorkspaceProperties

public IWorkspaceProperties getAsIWorkspaceProperties()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITxDiagnostics

public ITxDiagnostics getAsITxDiagnostics()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIWorkspace

public IWorkspace getAsIWorkspace()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAMSWorkspace

public IAMSWorkspace getAsIAMSWorkspace()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDataset

public IDataset getAsIDataset()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getProperty

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

Description copied from interface: IWorkspaceProperties

Information about this particular property.

Supported Platforms

Windows, Solaris, Linux

Remarks

The IWorkspaceProperties::Property method takes as input the enumerations for the desired WorkspacePropertyGroup and the WorkspacePropertyType and returns the value of the requested property as a WorkspaceProperty object.

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:

AutomationException - If the ArcObject component throws an exception.

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

setProperty

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

Description copied from interface: IWorkspaceProperties

Information about this particular property.

Supported Platforms

Windows, Solaris, Linux

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:

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

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorCode

public int getLastConnectionErrorCode()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: ITxDiagnostics

Indicates error code value for the last Internet server connection.

Specified by:

getLastConnectionErrorCode in interface ITxDiagnostics

Returns:

The pnErrorCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorMessage

public java.lang.String getLastConnectionErrorMessage()
                                               throws java.io.IOException,
                                                      AutomationException

Description copied from interface: ITxDiagnostics

Indicates error code value for the last Internet server connection.

Specified by:

getLastConnectionErrorMessage in interface ITxDiagnostics

Returns:

The pbstrErrorMessage

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getActivityLog

public java.lang.String getActivityLog()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ITxDiagnostics

Indicates error code value for the last Internet server connection.

Specified by:

getActivityLog in interface ITxDiagnostics

Returns:

The pbstrLog

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IWorkspace

The connection properties of the workspace.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getConnectionProperties in interface IWorkspace

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactory

public IWorkspaceFactory getWorkspaceFactory()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IWorkspace

The factory that created the workspace.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getWorkspaceFactory in interface IWorkspace

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDatasets

public IEnumDataset getDatasets(int datasetType)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IWorkspace

The datasets in the workspace.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Datasets method returns an enumerator over the datasets in the workspace of the specified dataset type. Not to be confused with DatasetNames, Datasets will return a fully hydrated data set object.

See esriDatasetType for more information on dataset types.

Using a dataset type of esriDTAny will return all the datasets or datasets in the workspace, across all dataset types. Note that only the top-level datasets in the workspace are returned by these methods. In particular, if a workspace contains both stand-alone feature classes and additional feature classes that are part of a feature dataset, then calling the Datasets property on the workspace with a dataset type of esriDTFeatureClass will return only the standalone feature classes.

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:

AutomationException - If the ArcObject component throws an exception.

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

getDatasetNames

public IEnumDatasetName getDatasetNames(int datasetType)
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IWorkspace

The DatasetNames in the workspace.

Supported Platforms

Windows, Solaris, Linux

Remarks

The DatasetNames method returns an enumerator over the dataset names in the workspace for the specified dataset type. Name objects are lightweight versions of the geodatabase objects they refer to while still providing access to some of the properties/methods available in the geodatabase object. From a name object an instance of the geodatabase object specified by the name object can be created/returned and vice versa.

See esriDatasetType for more information on dataset types.

Browsing applications should use the DatasetNames method to obtain name objects. These dataset name objects contain the essential properties of the corresponding dataset objects and are faster to retrieve. If the actual dataset specified by a name object is required (for example, because the user selected it), then it can easily be instantiated by calling the Open method on the name object.

Using a dataset type of esriDTAny will return all the datasets or dataset names in the workspace, across all dataset types. Note that only the top-level datasets in the workspace are returned by these methods. In particular, if a workspace contains both stand-alone feature classes and additional feature classes that are part of a feature dataset, then calling the DatasetNames property on the workspace with a dataset type of esriDTFeatureClass will return only the standalone feature classes. In order to get the feature class names within a feature dataset, the application needs to get the FeatureClassNames property on the top-level feature dataset name returned by the workspace.

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:

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

AutomationException - If the ArcObject component throws an exception.

getPathName

public java.lang.String getPathName()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IWorkspace

The file system full path of the workspace.

Supported Platforms

Windows, Solaris, Linux

Remarks

If an ArcSDE workspace was created from a PropertySet, PathName will be empty.

Specified by:

getPathName in interface IWorkspace

Returns:

The pathName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IWorkspace

The Type of the Workspace.

Supported Platforms

Windows, Solaris, Linux

Remarks

See esriWorkspaceType for information on the types of workspaces.

Specified by:

getType in interface IWorkspace

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirectory

public boolean isDirectory()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IWorkspace

TRUE if the workspace is a file system directory.

Specified by:

isDirectory in interface IWorkspace

Returns:

The isDir

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exists

public boolean exists()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IWorkspace

Checks if the workspace exists.

Supported Platforms

Windows, Solaris, Linux

Specified by:

exists in interface IWorkspace

Returns:

The exists

Throws:

AutomationException - If the ArcObject component throws an exception.

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

executeSQL

public void executeSQL(java.lang.String sqlStmt)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IWorkspace

Executes the specified SQL statement.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

executeSQL in interface IWorkspace

Parameters:

sqlStmt - The sqlStmt (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

connect

public void connect()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IAMSWorkspace

Creates real-time data connection in the tracking workspace.

Description

This method connects the workspace to the Tracking Server.

Specified by:

connect in interface IAMSWorkspace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IAMSWorkspace

Disconnects a data connection in the tracking workspace.

Description

This method disconnects the workspace from a connected Tracking Server.

Specified by:

disconnect in interface IAMSWorkspace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFeatureClass

public IFeatureClass openFeatureClass(java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IAMSWorkspace

Opens an existing feature class.

Description

This method opens an existing feature class.

Specified by:

openFeatureClass in interface IAMSWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

openTable

public ITable openTable(java.lang.String name)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAMSWorkspace

Opens an existing table.

Description

This method opens an existing table.

Specified by:

openTable in interface IAMSWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createTable

public ITable createTable(java.lang.String name,
                          IFields fields,
                          IUID cLSID,
                          IUID eXTCLSID,
                          java.lang.String configKeyword)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAMSWorkspace

Creates a new table.

Description

This method creates a new table.

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:

AutomationException - If the ArcObject component throws an exception.

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

createFeatureClass

public IFeatureClass createFeatureClass(java.lang.String name,
                                        IFields fields,
                                        IUID cLSID,
                                        IUID eXTCLSID,
                                        int featureType,
                                        java.lang.String shapeFieldName,
                                        java.lang.String configKeyword)
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IAMSWorkspace

Creates a new standalone feature class under the workspace.

Description

This method creates a new standalone feature class under the workspace.

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:

AutomationException - If the ArcObject component throws an exception.

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

createQueryDef

public IQueryDef createQueryDef()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAMSWorkspace

Create a query definition object.

Description

This method creates a query definition object.

Specified by:

createQueryDef in interface IAMSWorkspace

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

openFeatureQuery

public IFeatureDataset openFeatureQuery(java.lang.String queryName,
                                        IQueryDef pQueryDef)
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IAMSWorkspace

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.

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:

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

AutomationException - If the ArcObject component throws an exception.

getServerConnection

public IServerConnection getServerConnection()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IAMSWorkspace

Defines aspects of the server connection.

Specified by:

getServerConnection in interface IAMSWorkspace

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

storeProperties

public void storeProperties()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IAMSWorkspace

Stores connection properties in the workspace.

Specified by:

storeProperties in interface IAMSWorkspace

Throws:

AutomationException - If the ArcObject component throws an exception.

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

loadProperties

public void loadProperties(java.lang.String bstrTableName)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAMSWorkspace

Loads properties for connection in the workspace.

Specified by:

loadProperties in interface IAMSWorkspace

Parameters:

bstrTableName - The bstrTableName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IDataset

The name of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDataset

The associated name object.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IDataset

The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

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

Description copied from interface: IDataset

The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IDataset

The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IDataset

Datasets contained within this dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IDataset

The workspace containing this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Workspace property returns the containing workspace for this dataset.

Specified by:

getWorkspace in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IDataset

The set of properties for the dataset.

Supported Platforms

Windows, Solaris, Linux

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.

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.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IDataset

True if this dataset can be copied.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

AutomationException - If the ArcObject component throws an exception.

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

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IDataset

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

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Copy does not support the copying of Graph objects such as a Geometric Network.

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:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

GeoDBDataTransfer

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDataset

True if this dataset can be deleted.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IDataset

Deletes this dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

delete in interface IDataset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDataset

True if this dataset can be renamed.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

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

Description copied from interface: IDataset

Renames this Dataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.