com.esri.arcgis.geodatabase

Interface ISpatialFilter

All Superinterfaces:

IQueryFilter, java.io.Serializable

All Known Implementing Classes:

ImageQueryFilter, ISpatialFilterProxy, SpatialFilter

public interface ISpatialFilter
extends IQueryFilter, java.io.Serializable

COM Interface 'ISpatialFilter'. Generated 4/9/2024 11:09:20 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that return and modify the type of spatial relationship that the filter will use.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDfdfebd94_ed75_11d0_9a95_080009ec734b
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilter

IIDfdfebd93_ed75_11d0_9a95_080009ec734b

Method Summary

Modifier and Type	Method and Description
IGeometry	getGeometry() The query geometry used to filter results.
java.lang.String	getGeometryField() The name of the Geometry field to which the filter applies.
int	getSearchOrder() The search order used by the filter.
int	getSpatialRel() The spatial relationship checked by the filter.
java.lang.String	getSpatialRelDescription() The array elements which describe the spatial relation between the query geometry and the requested geometries.
boolean	isFilterOwnsGeometry() Indicates whether the filter owns the query geometry.
void	setGeometryByRef(IGeometry geometry) The query geometry used to filter results.
void	setGeometryExByRef(IGeometry geometry, boolean rhs2) The query geometry used to filter results.
void	setGeometryField(java.lang.String geomField) The name of the Geometry field to which the filter applies.
void	setSearchOrder(int order) The search order used by the filter.
void	setSpatialRel(int spatialRel) The spatial relationship checked by the filter.
void	setSpatialRelDescription(java.lang.String spatialRelDescription) The array elements which describe the spatial relation between the query geometry and the requested geometries.

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

addField, getOutputSpatialReference, getSubFields, getWhereClause, setOutputSpatialReferenceByRef, setSubFields, setWhereClause

Field Detail

IIDfdfebd94_ed75_11d0_9a95_080009ec734b

static final int IIDfdfebd94_ed75_11d0_9a95_080009ec734b

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getSearchOrder

int getSearchOrder()
            throws java.io.IOException,
                   AutomationException

The search order used by the filter.

Returns:

A com.esri.arcgis.geodatabase.esriSearchOrder constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchOrder

void setSearchOrder(int order)
             throws java.io.IOException,
                    AutomationException

The search order used by the filter.

Parameters:

order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialRel

int getSpatialRel()
           throws java.io.IOException,
                  AutomationException

The spatial relationship checked by the filter.

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialRel

void setSpatialRel(int spatialRel)
            throws java.io.IOException,
                   AutomationException

The spatial relationship checked by the filter.

Parameters:

spatialRel - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
               throws java.io.IOException,
                      AutomationException

The query geometry used to filter results.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

void setGeometryByRef(IGeometry geometry)
               throws java.io.IOException,
                      AutomationException

The query geometry used to filter results.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryExByRef

void setGeometryExByRef(IGeometry geometry,
                        boolean rhs2)
                 throws java.io.IOException,
                        AutomationException

The query geometry used to filter results.

Parameters:

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

rhs2 - The rhs2 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFilterOwnsGeometry

boolean isFilterOwnsGeometry()
                      throws java.io.IOException,
                             AutomationException

Indicates whether the filter owns the query geometry.

Returns:

The spatialFilterOwnsGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryField

java.lang.String getGeometryField()
                           throws java.io.IOException,
                                  AutomationException

The name of the Geometry field to which the filter applies.

Returns:

The geomField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryField

void setGeometryField(java.lang.String geomField)
               throws java.io.IOException,
                      AutomationException

The name of the Geometry field to which the filter applies.

Parameters:

geomField - The geomField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialRelDescription

java.lang.String getSpatialRelDescription()
                                   throws java.io.IOException,
                                          AutomationException

The array elements which describe the spatial relation between the query geometry and the requested geometries. There are 9 chars in this string which can be either 'F', 'T' or '*'; e.g., TT*FFT***' represents CONTAIN.

Returns:

The spatialRelDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialRelDescription

void setSpatialRelDescription(java.lang.String spatialRelDescription)
                       throws java.io.IOException,
                              AutomationException

The array elements which describe the spatial relation between the query geometry and the requested geometries. There are 9 chars in this string which can be either 'F', 'T' or '*'; e.g., TT*FFT***' represents CONTAIN.

Parameters:

spatialRelDescription - The spatialRelDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.