com.esri.arcgis.geodatabase

Class ISpatialFilterProxy

java.lang.Object

com.esri.arcgis.interop.Dispatch

com.esri.arcgis.geodatabase.IQueryFilterProxy

com.esri.arcgis.geodatabase.ISpatialFilterProxy

All Implemented Interfaces:

IQueryFilter, ISpatialFilter, java.io.Externalizable, java.io.Serializable

public class ISpatialFilterProxy
extends IQueryFilterProxy
implements ISpatialFilter, java.io.Serializable

Internal use class Proxy for COM Interface 'ISpatialFilter'. Generated 5/5/2025 2:28:35 PM 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 =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IIDfdfebd94_ed75_11d0_9a95_080009ec734b

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

IIDfdfebd93_ed75_11d0_9a95_080009ec734b

Constructor Summary

Constructors

Modifier	Constructor and Description
	ISpatialFilterProxy() For internal use only
	ISpatialFilterProxy(java.lang.Object obj)
protected	ISpatialFilterProxy(java.lang.Object obj, java.lang.String iid)
	ISpatialFilterProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	ISpatialFilterProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
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	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
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 class com.esri.arcgis.geodatabase.IQueryFilterProxy

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

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

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

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

ISpatialFilterProxy

public ISpatialFilterProxy(java.lang.String CLSID,
                           java.lang.String host,
                           com.esri.arcgis.interop.AuthInfo authInfo)
                    throws java.net.UnknownHostException,
                           java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

ISpatialFilterProxy

public ISpatialFilterProxy()

For internal use only

ISpatialFilterProxy

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

Throws:

java.io.IOException

ISpatialFilterProxy

protected ISpatialFilterProxy(java.lang.Object obj,
                              java.lang.String iid)
                       throws java.io.IOException

Throws:

java.io.IOException

ISpatialFilterProxy

protected ISpatialFilterProxy(java.lang.String CLSID,
                              java.lang.String iid,
                              java.lang.String host,
                              com.esri.arcgis.interop.AuthInfo authInfo)
                       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: com.esri.arcgis.interop.Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class IQueryFilterProxy

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: com.esri.arcgis.interop.Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class IQueryFilterProxy

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

getSearchOrder

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

The search order used by the filter.

Specified by:

getSearchOrder in interface ISpatialFilter

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

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

The search order used by the filter.

Specified by:

setSearchOrder in interface ISpatialFilter

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

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

The spatial relationship checked by the filter.

Specified by:

getSpatialRel in interface ISpatialFilter

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

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

The spatial relationship checked by the filter.

Specified by:

setSpatialRel in interface ISpatialFilter

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

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

The query geometry used to filter results.

Specified by:

getGeometry in interface ISpatialFilter

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

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

The query geometry used to filter results.

Specified by:

setGeometryByRef in interface ISpatialFilter

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

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

The query geometry used to filter results.

Specified by:

setGeometryExByRef in interface ISpatialFilter

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

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

Indicates whether the filter owns the query geometry.

Specified by:

isFilterOwnsGeometry in interface ISpatialFilter

Returns:

The spatialFilterOwnsGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryField

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

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

Specified by:

getGeometryField in interface ISpatialFilter

Returns:

The geomField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryField

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

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

Specified by:

setGeometryField in interface ISpatialFilter

Parameters:

geomField - The geomField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialRelDescription

public 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.

Specified by:

getSpatialRelDescription in interface ISpatialFilter

Returns:

The spatialRelDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialRelDescription

public 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.

Specified by:

setSpatialRelDescription in interface ISpatialFilter

Parameters:

spatialRelDescription - The spatialRelDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.