com.esri.arcgis.geodatabase
Interface IDatasetName

All Superinterfaces:
Serializable
All Known Subinterfaces:
IAMSDatasetName, IDatasetName2
All Known Implementing Classes:
AMSDatasetName, CadastralFabricName, CadDrawingName, CoverageFeatureClassName, CoverageName, FeatureClassName, FeatureDatasetName, FeatureQueryName, FgdbFeatureClassName, FgdbTableName, GeometricNetworkName, GPToolboxName, GPToolName, IDatasetNameProxy, MemoryRelationshipClassName, NetCDFFeatureClassName, NetCDFRasterDatasetName, NetCDFTableName, NetworkDatasetName, ObjectClassName, RasterBandName, RasterCatalogName, RasterDatasetName, RelationshipClassName, RelQueryTableName, RepresentationClassName, RouteEventSourceName, SchematicDatasetName, SchematicDiagramClassName, SchematicDiagramName, SchematicFolderName, SchematicWorkspaceName, SdeRasterTableName, TableName, TableQueryName, TerrainName, TinName, TopologyName, XYEventSourceName

public interface IDatasetName
extends Serializable

Provides access to members that supply dataset name information.

Superseded By

IDatasetName2

Remarks

DatasetName is an abstract class that covers Name objects for datasets in a workspace.

DatasetName objects identify and locate datasets within a workspace. In addition they may carry additional properties that describe the named dataset. DatasetName objects supports methods to access metadata for the named object (via the optional IMetadata interface) and to manage privileges for the dataset (via the ISQLPriveleges interface).

The DatasetName object for any existing dataset can be obtained by reading the IDataset::FullName property. DatasetName objects may also be created to specify new datasets that are to be created by some operation.

The IDatasetName interface provides access to the basic properties of a dataset name object.

The Name property returns the identifier for the dataset within the context of its workspace. Note that the value of the name property of the dataset name object (IDatasetName::Name) is the same as the value of the name property for the dataset (IDataset::Name). The WorkspaceName property returns the workspace name object for the workspace containing the dataset being specified by this dataset name object.

You can use the IDataset::FullName property to get a dataset name object from the actual dataset object.

A dataset name can also refer to a dataset that does not yet exist. This is useful when creating new data, for example with the feature data converters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getCategory()
          The category of the dataset.
 String getName()
          The name of the dataset.
 IEnumDatasetName getSubsetNames()
          Subset names contained within this dataset name.
 int getType()
          The type of the dataset.
 IWorkspaceName getWorkspaceName()
          The WorkspaceName of the DatasetName.
 void setCategory(String category)
          The category of the dataset.
 void setName(String name)
          The name of the dataset.
 void setWorkspaceNameByRef(IWorkspaceName workspaceName)
          The WorkspaceName of the DatasetName.
 

Method Detail

getName

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

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException
The name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException
The type of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException
The category of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(String category)
                 throws IOException,
                        AutomationException
The category of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
category - The category (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException
The WorkspaceName of the DatasetName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws IOException,
                                  AutomationException
The WorkspaceName of the DatasetName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubsetNames

IEnumDatasetName getSubsetNames()
                                throws IOException,
                                       AutomationException
Subset names contained within this dataset name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.