com.esri.arcgis.geodatabase
Class IPlugInWorkspaceHelperProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IPlugInWorkspaceHelperProxy

All Implemented Interfaces:

IPlugInWorkspaceHelper, Externalizable, Serializable

public class IPlugInWorkspaceHelperProxy
extends com.esri.arcgis.interop.Dispatch
implements IPlugInWorkspaceHelper, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IPlugInWorkspaceHelperProxy()
	IPlugInWorkspaceHelperProxy(Object obj)
protected	IPlugInWorkspaceHelperProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IPlugInWorkspaceHelperProxy

public IPlugInWorkspaceHelperProxy()

IPlugInWorkspaceHelperProxy

public IPlugInWorkspaceHelperProxy(Object obj)
                            throws IOException

Throws:

IOException

IPlugInWorkspaceHelperProxy

protected IPlugInWorkspaceHelperProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

isRowCountIsCalculated

public 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

Specified by:

isRowCountIsCalculated in interface IPlugInWorkspaceHelper

Returns:

The rowCountCalculated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOIDIsRecordNumber

public 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

Specified by:

isOIDIsRecordNumber in interface IPlugInWorkspaceHelper

Returns:

The oIDIsRecordNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeType

public 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.

Specified by:

getNativeType in interface IPlugInWorkspaceHelper

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

public 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.

Specified by:

getDatasetNames in interface IPlugInWorkspaceHelper

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

public 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

Specified by:

openDataset in interface IPlugInWorkspaceHelper

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.