com.esri.arcgis.geodatabase
Class IPlugInDatasetHelper2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IPlugInDatasetHelperProxy
          com.esri.arcgis.geodatabase.IPlugInDatasetHelper2Proxy

All Implemented Interfaces:

IPlugInDatasetHelper, IPlugInDatasetHelper2, Externalizable, Serializable

public class IPlugInDatasetHelper2Proxy
extends IPlugInDatasetHelperProxy
implements IPlugInDatasetHelper2, Serializable

Provides access to members that help Plug-In datasets.

Description

This interface allows a dataset helper to implement data source-level filtering of rows using a where clause.

Remarks

This interface can be implemented to optimize queries if there is a way to filter results from the data source more efficiently than checking the attributes of each row one-by-one. For example, data sources that have indexes should implement this interface to take advantage of indexing.

Dataset helpers for data sources without an optimized method of querying (like indexing) do not need to implement this interface.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IPlugInCursorHelper	fetchWithFilter(int classIndex, IEnvelope env, boolean strictSearch, String whereClause, IFIDSet fIDSet, Object fieldMap) Gets the records according to the envelope, where clause or FIDSet.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.geodatabase.IPlugInDatasetHelperProxy

fetchAll, fetchByEnvelope, fetchByID, getBounds, getClassCount, getClassIndex, getClassName, getFields, getOIDFieldIndex, getShapeFieldIndex

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

Methods inherited from interface com.esri.arcgis.geodatabase.IPlugInDatasetHelper

fetchAll, fetchByEnvelope, fetchByID, getBounds, getClassCount, getClassIndex, getClassName, getFields, getOIDFieldIndex, getShapeFieldIndex

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IPlugInDatasetHelper2Proxy

public IPlugInDatasetHelper2Proxy()

IPlugInDatasetHelper2Proxy

public IPlugInDatasetHelper2Proxy(Object obj)
                           throws IOException

Throws:

IOException

IPlugInDatasetHelper2Proxy

protected IPlugInDatasetHelper2Proxy(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 IPlugInDatasetHelperProxy

Throws:

IOException

removeListener

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

Overrides:

removeListener in class IPlugInDatasetHelperProxy

Throws:

IOException

fetchWithFilter

public IPlugInCursorHelper fetchWithFilter(int classIndex,
                                           IEnvelope env,
                                           boolean strictSearch,
                                           String whereClause,
                                           IFIDSet fIDSet,
                                           Object fieldMap)
                                    throws IOException,
                                           AutomationException

Gets the records according to the envelope, where clause or FIDSet.

Product Availability

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

Specified by:

fetchWithFilter in interface IPlugInDatasetHelper2

Parameters:

classIndex - The classIndex (in)

env - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

strictSearch - The strictSearch (in)

whereClause - The whereClause (in)

fIDSet - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

fieldMap - A Variant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.