com.esri.arcgis.datasourcesnetCDF
Class NetCDFWorkspace

java.lang.Object
  com.esri.arcgis.datasourcesnetCDF.NetCDFWorkspace

All Implemented Interfaces:

IMDWorkspace, INetCDFWorkspace, IDataset, IWorkspace, IWorkspaceProperties, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class NetCDFWorkspace
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspace, INetCDFWorkspace, IMDWorkspace, IDataset, ISupportErrorInfo, IWorkspaceProperties

The NetCDF workspace object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NetCDFWorkspace(Object obj)
Construct a NetCDFWorkspace 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.
IDataset	copy(String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
IDataset	createView(String viewName, IMDDatasetView pView) Creates a dataset from a view definition.
void	delete() Deletes this dataset.
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.
IStringArray	getAttributeNames(String varName) The array of global or variable specific attribute names.
Object	getAttributeValue(String varName, String attName, int valueIndex) The attribute value for a specified variable and an attribute name or keyword.
String	getBrowseName() The browse name of the dataset.
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.
int	getDimensionIndex(String dimName, Object vValue) The dimension index for a specified dimension and value.
IStringArray	getDimensions() The array of dimension items.
IStringArray	getDimensionsByVariable(String varName) The dimension items for a specified variable.
int	getDimensionSize(String dimName) The size or length of a specified dimension.
Object	getDimensionValue(String dimName, int index) The dimension value for a specified dimension and index.
IVariantArray	getDimensionValues(String dimName) The values for a specified dimension.
int	getFieldType(String name) The field type of a variable or dimension.
IName	getFullName() The associated name object.
int	getIndexFromValue(String name, Object value) Return the index of a specified variable or dimension value.
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.
ISpatialReference	getSpatialReference(String varName, String xDim, String yDim) The spatial reference for a variable.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getType() The Type of the Workspace.
Object	getValueFromIndex(int index, String name) The dimension or variable value for a given index.
IStringArray	getVariables() The array of variable strings.
IStringArray	getVariablesByDimension(String dimName) All variables having the specified dimension name.
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	rename(String name) Renames this Dataset.
void	setBrowseName(String name) The browse name of the dataset.
void	setProperty(int propertyGroup, int propertyType, IWorkspaceProperty workspaceProperty) Information about this particular property.

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

NetCDFWorkspace

public NetCDFWorkspace(Object obj)
                throws IOException

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

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

Throws:

IOException - if there are interop problems NetCDFWorkspace theNetCDFWorkspace = (NetCDFWorkspace) 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

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.

getVariables

public IStringArray getVariables()
                          throws IOException,
                                 AutomationException

The array of variable strings.

Product Availability

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

Specified by:

getVariables in interface INetCDFWorkspace

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensions

public IStringArray getDimensions()
                           throws IOException,
                                  AutomationException

The array of dimension items.

Product Availability

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

Specified by:

getDimensions in interface INetCDFWorkspace

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeNames

public IStringArray getAttributeNames(String varName)
                               throws IOException,
                                      AutomationException

The array of global or variable specific attribute names.

Product Availability

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

Specified by:

getAttributeNames in interface INetCDFWorkspace

Parameters:

varName - The varName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionSize

public int getDimensionSize(String dimName)
                     throws IOException,
                            AutomationException

The size or length of a specified dimension.

Product Availability

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

Specified by:

getDimensionSize in interface INetCDFWorkspace

Parameters:

dimName - The dimName (in)

Returns:

The dimSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionsByVariable

public IStringArray getDimensionsByVariable(String varName)
                                     throws IOException,
                                            AutomationException

The dimension items for a specified variable.

Product Availability

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

Specified by:

getDimensionsByVariable in interface INetCDFWorkspace

Parameters:

varName - The varName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVariablesByDimension

public IStringArray getVariablesByDimension(String dimName)
                                     throws IOException,
                                            AutomationException

All variables having the specified dimension name.

Product Availability

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

Specified by:

getVariablesByDimension in interface INetCDFWorkspace

Parameters:

dimName - The dimName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionValue

public Object getDimensionValue(String dimName,
                                int index)
                         throws IOException,
                                AutomationException

The dimension value for a specified dimension and index.

Product Availability

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

Specified by:

getDimensionValue in interface INetCDFWorkspace

Parameters:

dimName - The dimName (in)

index - The index (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionIndex

public int getDimensionIndex(String dimName,
                             Object vValue)
                      throws IOException,
                             AutomationException

The dimension index for a specified dimension and value.

Product Availability

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

Specified by:

getDimensionIndex in interface INetCDFWorkspace

Parameters:

dimName - The dimName (in)

vValue - A Variant (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeValue

public Object getAttributeValue(String varName,
                                String attName,
                                int valueIndex)
                         throws IOException,
                                AutomationException

The attribute value for a specified variable and an attribute name or keyword.

Product Availability

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

Specified by:

getAttributeValue in interface INetCDFWorkspace

Parameters:

varName - The varName (in)

attName - The attName (in)

valueIndex - The valueIndex (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionValues

public IVariantArray getDimensionValues(String dimName)
                                 throws IOException,
                                        AutomationException

The values for a specified dimension.

Product Availability

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

Specified by:

getDimensionValues in interface INetCDFWorkspace

Parameters:

dimName - The dimName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference(String varName,
                                             String xDim,
                                             String yDim)
                                      throws IOException,
                                             AutomationException

The spatial reference for a variable.

Product Availability

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

Specified by:

getSpatialReference in interface INetCDFWorkspace

Parameters:

varName - The varName (in)

xDim - The xDim (in)

yDim - The yDim (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldType

public int getFieldType(String name)
                 throws IOException,
                        AutomationException

The field type of a variable or dimension.

Product Availability

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

Specified by:

getFieldType in interface INetCDFWorkspace

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.geodatabase.esriFieldType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValueFromIndex

public Object getValueFromIndex(int index,
                                String name)
                         throws IOException,
                                AutomationException

The dimension or variable value for a given index.

Product Availability

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

Specified by:

getValueFromIndex in interface INetCDFWorkspace

Parameters:

index - The index (in)

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexFromValue

public int getIndexFromValue(String name,
                             Object value)
                      throws IOException,
                             AutomationException

Return the index of a specified variable or dimension value.

Product Availability

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

Specified by:

getIndexFromValue in interface INetCDFWorkspace

Parameters:

name - The name (in)

value - A Variant (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createView

public IDataset createView(String viewName,
                           IMDDatasetView pView)
                    throws IOException,
                           AutomationException

Creates a dataset from a view definition.

Product Availability

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

Specified by:

createView in interface IMDWorkspace

Parameters:

viewName - The viewName (in)

pView - A reference to a com.esri.arcgis.datasourcesnetCDF.IMDDatasetView (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.

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.

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.

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.