com.esri.arcgis.geodatabase
Interface IPlugInDatasetInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

FMEDatasetHelper, IPlugInDatasetInfoProxy

public interface IPlugInDatasetInfo
extends Serializable

Provides access to members that describe a dataset.

Description

Must be implemented by the plug-in dataset helper class of a plug-in data source. The methods are called for data browsing, so they should be lightweight.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Method Summary

int	getDatasetType() The type of the dataset.
int	getGeometryType() The geometry type of the dataset.
String	getLocalDatasetName() The name of the dataset within the workspace.
String	getShapeFieldName() The name of the dataset's shape field.

Method Detail

getLocalDatasetName

String getLocalDatasetName()
                           throws IOException,
                                  AutomationException

The name of the dataset within the workspace.

Description

Returns the local name of this dataset. This is the name that will show up in ArcCatalog, and that will be passed to the OpenDataset method of the workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The localName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetType

int getDatasetType()
                   throws IOException,
                          AutomationException

The type of the dataset.

Description

Returns the dataset type of this dataset. Determines what kind of icon the dataset will have in ArcCatalog.

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.

getGeometryType

int getGeometryType()
                    throws IOException,
                           AutomationException

The geometry type of the dataset.

Description

Returns the geometry type of this dataset. Only called if the dataset type is feature class. Determines which feature class icon the dataset will have in ArcCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShapeFieldName

String getShapeFieldName()
                         throws IOException,
                                AutomationException

The name of the dataset's shape field.

Description

Returns the name of the shape field of this dataset. Only called if dataset type is feature class and geometry type is not null. Used to construct the FeatureClassName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The shapeFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.