com.esri.arcgis.geodatabase
Interface IDatasetContainer2

All Superinterfaces:
IDatasetContainer, Serializable
All Known Subinterfaces:
IDatasetContainer3
All Known Implementing Classes:
CadastralFabricFDExtension, CadastralWorkspaceDatasetExtension, IDatasetContainer2Proxy, IDatasetContainer3Proxy, NetworkDatasetFDExtension, NetworkDatasetWorkspaceExtension, RepresentationWorkspaceExtension, TerrainFeatureDatasetExtension

public interface IDatasetContainer2
extends IDatasetContainer, Serializable

Provides access to members that return datasets by name, ID and index.

Superseded By

IDatasetContainer3

Remarks

The IDatasetContainer2 interface provides access to properties that return datasets by name, ID and index. It also provides the mechanism for creating datasets through the user of the data element. Use the DatasetTypes method to determine the supported datasets for the container.

Product Availability

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


Method Summary
 IDataset createDataset(IDEDataset dataElement)
          Given a data element, create a dataset in this container.
 IDataset getDataset(int type, int index)
          The dataset associated with the specified index value and dataset type.
 IDataset getDatasetByName(int type, String name)
          The dataset of the specified type with the specified name.
 int getDatasetCount(int type)
          The number of datasets of the specified type in this container.
 IEnumDatasetName getDatasetNames(int type)
          The names of all the datasets with the specified type.
 IEnumDataset getDatasets(int type)
          An enumerator over the datasets of the specified type.
 IEnumDatasetType getDatasetTypes()
          The names of all the datasets with the specified type.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IDatasetContainer
addDataset
 

Method Detail

getDataset

IDataset getDataset(int type,
                    int index)
                    throws IOException,
                           AutomationException
The dataset associated with the specified index value and dataset type.

Product Availability

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

Parameters:
type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
index - The index (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.

getDatasets

IEnumDataset getDatasets(int type)
                         throws IOException,
                                AutomationException
An enumerator over the datasets of the specified type.

Product Availability

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

Parameters:
type - 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.

getDatasetCount

int getDatasetCount(int type)
                    throws IOException,
                           AutomationException
The number of datasets of the specified type in this container.

Product Availability

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

Parameters:
type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatasetByName

IDataset getDatasetByName(int type,
                          String name)
                          throws IOException,
                                 AutomationException
The dataset of the specified type with the specified name.

Product Availability

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

Parameters:
type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
name - The name (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.

getDatasetNames

IEnumDatasetName getDatasetNames(int type)
                                 throws IOException,
                                        AutomationException
The names of all the datasets with the specified type.

Product Availability

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

Parameters:
type - 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.

getDatasetTypes

IEnumDatasetType getDatasetTypes()
                                 throws IOException,
                                        AutomationException
The names of all the datasets with the specified type.

Remarks

The DatasetTypes property returns an enumerator of IEnumDatasetType containing the supported esriDatasetTypes for the container. Use this method to determine the supported datasets for the container.

Product Availability

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

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

createDataset

IDataset createDataset(IDEDataset dataElement)
                       throws IOException,
                              AutomationException
Given a data element, create a dataset in this container.

Remarks

The CreateDataset method will create a dataset given a populated data element. Use the DatasetTypes property to determine the supported dataset types.

Product Availability

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

Parameters:
dataElement - A reference to a com.esri.arcgis.geodatabase.IDEDataset (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.