com.esri.arcgis.carto

Class FeatureIndex

java.lang.Object

com.esri.arcgis.carto.FeatureIndex

All Implemented Interfaces:

IFeatureIndex, IFeatureIndex2, IIndexQuery, IIndexQuery2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class FeatureIndex
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureIndex, IFeatureIndex2, IIndexQuery, IIndexQuery2

COM Class 'FeatureIndex'. Generated 9/23/2025 7:46:20 AM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'A feature class index.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.IFeatureIndex

IID, IID59f60294_c1fb_11d2_9f23_00c04f6bc886, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IFeatureIndex2

IID, IIDbc2e4428_1311_42fb_b364_0aa46f03a1ac, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IIndexQuery

IID, IID59f60295_c1fb_11d2_9f23_00c04f6bc886, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IIndexQuery2

IID, IID3df5374b_2cee_11d4_a6a5_0008c7d3ae8d, xxDummy

Constructor Summary

Constructors

Constructor and Description
FeatureIndex() Constructs a FeatureIndex using ArcGIS Engine.
FeatureIndex(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. FeatureIndex theFeatureIndex = (FeatureIndex) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
ISpatialReference	getOutputSpatialReference(java.lang.String fieldName) The spatial reference in which to output geometry for a given field.
IFeatureCursor	getWithin(IGeometry pShape) Finds all features that the input shape lies within.
int	hashCode() the hashcode for this object
void	index(ITrackCancel pTrackCancel, IEnvelope pQueryingGeometryFullExtent) Creates index.
void	intersectedFeatures(IGeometry pShape, java.lang.Object[] pSAIds) Finds all intersected features in index to the input shape.
void	nearestFeature(IGeometry pShape, int[] pClosestFeatureFID, double[] pDistance) Finds the nearest feature in index to the input shape.
void	nearestFeatures(IGeometry pShape, java.lang.Object[] pSAIds, double[] pDistance) Finds all nearest features in index to the input shape (i.e.
void	release() Release this COM object reference
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(java.lang.String fieldName, ISpatialReference outputSpatialReference) The spatial reference in which to output geometry for a given field.
int	withinFeature(IGeometry pShape) Finds the first feature that the input shape lies within.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureIndex

public FeatureIndex()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a FeatureIndex using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FeatureIndex

public FeatureIndex(java.lang.Object obj)
             throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureIndex theFeatureIndex = (FeatureIndex) obj;

Construct a FeatureIndex using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FeatureIndex.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass rhs1)
                          throws java.io.IOException,
                                 AutomationException

FeatureClass to index.

Specified by:

setFeatureClassByRef in interface IFeatureIndex

Specified by:

setFeatureClassByRef in interface IFeatureIndex2

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureCursorByRef

public void setFeatureCursorByRef(IFeatureCursor rhs1)
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

setFeatureCursorByRef in interface IFeatureIndex

Specified by:

setFeatureCursorByRef in interface IFeatureIndex2

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

index

public void index(ITrackCancel pTrackCancel,
                  IEnvelope pQueryingGeometryFullExtent)
           throws java.io.IOException,
                  AutomationException

Creates index.

Specified by:

index in interface IFeatureIndex

Specified by:

index in interface IFeatureIndex2

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference(java.lang.String fieldName)
                                            throws java.io.IOException,
                                                   AutomationException

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

Specified by:

getOutputSpatialReference in interface IFeatureIndex2

Parameters:

fieldName - The fieldName (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(java.lang.String fieldName,
                                           ISpatialReference outputSpatialReference)
                                    throws java.io.IOException,
                                           AutomationException

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

Specified by:

setOutputSpatialReferenceByRef in interface IFeatureIndex2

Parameters:

fieldName - The fieldName (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nearestFeature

public void nearestFeature(IGeometry pShape,
                           int[] pClosestFeatureFID,
                           double[] pDistance)
                    throws java.io.IOException,
                           AutomationException

Finds the nearest feature in index to the input shape.

Specified by:

nearestFeature in interface IIndexQuery

Specified by:

nearestFeature in interface IIndexQuery2

Parameters:

pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pClosestFeatureFID - The pClosestFeatureFID (out: use single element array)

pDistance - The pDistance (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWithin

public IFeatureCursor getWithin(IGeometry pShape)
                         throws java.io.IOException,
                                AutomationException

Finds all features that the input shape lies within.

Specified by:

getWithin in interface IIndexQuery

Specified by:

getWithin in interface IIndexQuery2

Parameters:

pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nearestFeatures

public void nearestFeatures(IGeometry pShape,
                            java.lang.Object[] pSAIds,
                            double[] pDistance)
                     throws java.io.IOException,
                            AutomationException

Finds all nearest features in index to the input shape (i.e. equal distance).

Specified by:

nearestFeatures in interface IIndexQuery2

Parameters:

pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pSAIds - A Variant (out: use single element array)

pDistance - The pDistance (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersectedFeatures

public void intersectedFeatures(IGeometry pShape,
                                java.lang.Object[] pSAIds)
                         throws java.io.IOException,
                                AutomationException

Finds all intersected features in index to the input shape.

Specified by:

intersectedFeatures in interface IIndexQuery2

Parameters:

pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pSAIds - A Variant (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

withinFeature

public int withinFeature(IGeometry pShape)
                  throws java.io.IOException,
                         AutomationException

Finds the first feature that the input shape lies within.

Specified by:

withinFeature in interface IIndexQuery2

Parameters:

pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

The pWithinFeatureFID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.