com.esri.arcgis.geodatabase
Interface IPlugInWorkspaceHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

FMEWorkspaceHelper, IPlugInWorkspaceHelperProxy

public interface IPlugInWorkspaceHelper
extends Serializable

Provides access to members that help the Plug-In workspace.

Description

This interface must be implemented by the plug-in workspace helper class of a plug-in data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Method Summary

IArray	getDatasetNames(int datasetType) An array of dataset helpers for each dataset in the workspace.
INativeType	getNativeType(int datasetType, String localName) The native type object for datasetType.
boolean	isOIDIsRecordNumber() Indicates whether the OID is the number of the record, i.e., whether id's are continuous.
boolean	isRowCountIsCalculated() Indicates if a dataset has to count each row to get the number of rows in the dataset.
IPlugInDatasetHelper	openDataset(String localName) Opens a dataset helper for the dataset identified by localName.

Method Detail

isRowCountIsCalculated

boolean isRowCountIsCalculated()
                               throws IOException,
                                      AutomationException

Indicates if a dataset has to count each row to get the number of rows in the dataset.

Description

Returns true if the only way to count the number of rows in the dataset is to get a cursor and count. If the data source has a faster method for getting a count of rows in a dataset, this method should return false and the optional interface IPlugInFastRowCount should be implemented on dataset helpers returned by OpenDataset. It is always safe to return true here.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The rowCountCalculated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOIDIsRecordNumber

boolean isOIDIsRecordNumber()
                            throws IOException,
                                   AutomationException

Indicates whether the OID is the number of the record, i.e., whether id's are continuous.

Description

It should return true if the record number of your data source is used as the Object ID, that is the Object IDs are always continuous. If true, some joins are optimized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The oIDIsRecordNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeType

INativeType getNativeType(int datasetType,
                          String localName)
                          throws IOException,
                                 AutomationException

The native type object for datasetType.

Product Availability

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

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

localName - The localName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

IArray getDatasetNames(int datasetType)
                       throws IOException,
                              AutomationException

An array of dataset helpers for each dataset in the workspace.

Product Availability

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

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDataset

IPlugInDatasetHelper openDataset(String localName)
                                 throws IOException,
                                        AutomationException

Opens a dataset helper for the dataset identified by localName.

Description

Creates and initializes an instance of the dataset helper class and returns its IPlugInDatasetHelper pointer. If localName is not a local name of a dataset, the method should fail and return a null pointer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

localName - The localName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.