com.esri.arcgis.geometry
Interface ISpatialIndex

All Superinterfaces:
Serializable
All Known Subinterfaces:
ISpatialIndex2
All Known Implementing Classes:
GeometryBag, Multipoint, Polygon, Polyline

public interface ISpatialIndex
extends Serializable

Provides access to members that create a temporary spatial index for improving performance of "Disjoint" and some other relational operators.

Superseded By

ISpatialIndex2

Description

The ISpatialIndex methods can be used to control whether or not a spatial index should be built and used for the IRelationalOperator operations. It also determines if an index should be built when getting an segment enumerators using ISegmentCollection::IndexedEnumSegments method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void invalidate()
          Invalidate the spatial index.
 boolean isAllowIndexing()
          Indicates whether to allow a spatial index to be created for this geometry.
 void setAllowIndexing(boolean allowIndexing)
          Indicates whether to allow a spatial index to be created for this geometry.
 

Method Detail

setAllowIndexing

void setAllowIndexing(boolean allowIndexing)
                      throws IOException,
                             AutomationException
Indicates whether to allow a spatial index to be created for this geometry.

Remarks

The SpatialIndex if enabled is used by the IRelationalOperator's methods.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
allowIndexing - The allowIndexing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAllowIndexing

boolean isAllowIndexing()
                        throws IOException,
                               AutomationException
Indicates whether to allow a spatial index to be created for this geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The allowIndexing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

invalidate

void invalidate()
                throws IOException,
                       AutomationException
Invalidate the spatial index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.