com.esri.arcgis.geodatabase
Interface IPlugInDatasetHelper2

All Superinterfaces:

IPlugInDatasetHelper, Serializable

All Known Implementing Classes:

IPlugInDatasetHelper2Proxy

public interface IPlugInDatasetHelper2
extends IPlugInDatasetHelper, 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.

Method Summary

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.

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

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

Method Detail

fetchWithFilter

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.

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.