com.esri.arcgis.carto
Interface IFeatureIndex2

All Superinterfaces:

Serializable

All Known Implementing Classes:

FeatureIndex

public interface IFeatureIndex2
extends Serializable

Provides access to members that control the creation of an index on a feature class.

Description

Used on FeatureIndex object to build a spatial index for a group of features. Corresponding methods on IIndexQuery can then access this infomation.

It is important to set the OutputSpatialReference if the FeatureClass being passed in has a different spatial reference than that of the input shape on the IIndexQuery methods

Product Availability

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

Method Summary

ISpatialReference	getOutputSpatialReference(String fieldName) The spatial reference in which to output geometry for a given field.
void	index(ITrackCancel pTrackCancel, IEnvelope pQueryingGeometryFullExtent) Creates index.
void	setFeatureClassByRef(IFeatureClass rhs1) FeatureClass to index.
void	setFeatureCursorByRef(IFeatureCursor rhs1) Cursor on feature class, to reduce the number of feature indexed (optional).
void	setOutputSpatialReferenceByRef(String fieldName, ISpatialReference outputSpatialReference) The spatial reference in which to output geometry for a given field.

Method Detail

setFeatureClassByRef

void setFeatureClassByRef(IFeatureClass rhs1)
                          throws IOException,
                                 AutomationException

FeatureClass to index.

Description

The feature class to index

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureCursorByRef

void setFeatureCursorByRef(IFeatureCursor rhs1)
                           throws IOException,
                                  AutomationException

Cursor on feature class, to reduce the number of feature indexed (optional).

Description

A cusror that may contain a subset of the features that are in the FeatureClass to index. This will increase performance by minimizing the size of the spatial index. It is still necessary to set IFeatureIndex2.FeatureClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

index

void index(ITrackCancel pTrackCancel,
           IEnvelope pQueryingGeometryFullExtent)
           throws IOException,
                  AutomationException

Creates index.

Description

Actuallly queries the database for the features in the FeatureClass (or optionally the FeatureCursor) and creates a spatial index in memory of the resulting features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

ISpatialReference getOutputSpatialReference(String fieldName)
                                            throws IOException,
                                                   AutomationException

The spatial reference in which to output geometry for a given field.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

void setOutputSpatialReferenceByRef(String fieldName,
                                    ISpatialReference outputSpatialReference)
                                    throws IOException,
                                           AutomationException

The spatial reference in which to output geometry for a given field.

Description

Sets the current Output SpatialReference. It is important that this is set to the same SpatialReference as the input Shape's SpatialReference used as input in the IIndexQuery methods.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

outputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.