com.esri.arcgisws
Class SpatialFilter

java.lang.Object
  com.esri.arcgisws.QueryFilter
      com.esri.arcgisws.SpatialFilter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TimeQueryFilter

public class SpatialFilter
extends QueryFilter
implements Serializable

ESRI Spatial Filter Object.

Java class for SpatialFilter complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="SpatialFilter">
   <complexContent>
     <extension base="{http://www.esri.com/schemas/ArcGIS/10.0}QueryFilter">
       <sequence>
         <element name="SearchOrder" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriSearchOrder"/>
         <element name="SpatialRel" type="{http://www.esri.com/schemas/ArcGIS/10.0}esriSpatialRelEnum"/>
         <element name="SpatialRelDescription" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="FilterGeometry" type="{http://www.esri.com/schemas/ArcGIS/10.0}Geometry"/>
         <element name="GeometryFieldName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="FilterOwnsGeometry" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

ESRI Spatial Filter Object.

See Also:

Serialized Form

Constructor Summary

SpatialFilter()
SpatialFilter default constructor.

SpatialFilter(String subFields, String whereClause, String spatialReferenceFieldName, double resolution, SpatialReference outputSpatialReference, FIDSet fidSet, String postfixClause, FilterDef[] filterDefs, String prefixClause, EsriSearchOrder searchOrder, EsriSpatialRelEnum spatialRel, String spatialRelDescription, Geometry filterGeometry, String geometryFieldName, boolean filterOwnsGeometry)
Deprecated.

Method Summary

Geometry	getFilterGeometry() The query geometry used to filter results.
String	getGeometryFieldName() The name of the Geometry field to which the filter applies.
EsriSearchOrder	getSearchOrder() The search order used by the filter.
EsriSpatialRelEnum	getSpatialRel() The spatial relationship checked by the filter.
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	setFilterGeometry(Geometry value) The query geometry used to filter results.
void	setFilterOwnsGeometry(boolean value) Indicates whether the filter owns the query geometry.
void	setGeometryFieldName(String value) The name of the Geometry field to which the filter applies.
void	setSearchOrder(EsriSearchOrder value) The search order used by the filter.
void	setSpatialRel(EsriSpatialRelEnum value) The spatial relationship checked by the filter.
void	setSpatialRelDescription(String value) The array elements which describe the spatial relation between the query geometry and the requested geometries.

Methods inherited from class com.esri.arcgisws.QueryFilter

getFIDSet, getFilterDefs, getOutputSpatialReference, getPostfixClause, getPrefixClause, getResolution, getSpatialReferenceFieldName, getSubFields, getWhereClause, setFIDSet, setFilterDefs, setOutputSpatialReference, setPostfixClause, setPrefixClause, setResolution, setSpatialReferenceFieldName, setSubFields, setWhereClause

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialFilter

@Deprecated
public SpatialFilter(String subFields,
                                String whereClause,
                                String spatialReferenceFieldName,
                                double resolution,
                                SpatialReference outputSpatialReference,
                                FIDSet fidSet,
                                String postfixClause,
                                FilterDef[] filterDefs,
                                String prefixClause,
                                EsriSearchOrder searchOrder,
                                EsriSpatialRelEnum spatialRel,
                                String spatialRelDescription,
                                Geometry filterGeometry,
                                String geometryFieldName,
                                boolean filterOwnsGeometry)

Deprecated.

SpatialFilter constructor.

SpatialFilter

public SpatialFilter()

SpatialFilter default constructor.

Method Detail

getSearchOrder

public EsriSearchOrder getSearchOrder()

The search order used by the filter. Gets the value of the searchOrder property.

Returns:

possible object is EsriSearchOrder

setSearchOrder

public void setSearchOrder(EsriSearchOrder value)

The search order used by the filter. Sets the value of the searchOrder property.

Parameters:

value - allowed object is EsriSearchOrder

getSpatialRel

public EsriSpatialRelEnum getSpatialRel()

The spatial relationship checked by the filter. Gets the value of the spatialRel property.

Returns:

possible object is EsriSpatialRelEnum

setSpatialRel

public void setSpatialRel(EsriSpatialRelEnum value)

The spatial relationship checked by the filter. Sets the value of the spatialRel property.

Parameters:

value - allowed object is EsriSpatialRelEnum

getSpatialRelDescription

public String getSpatialRelDescription()

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. Gets the value of the spatialRelDescription property.

Returns:

possible object is String

setSpatialRelDescription

public void setSpatialRelDescription(String value)

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. Sets the value of the spatialRelDescription property.

Parameters:

value - allowed object is String

getFilterGeometry

public Geometry getFilterGeometry()

The query geometry used to filter results. Gets the value of the filterGeometry property.

Returns:

possible object is Geometry

setFilterGeometry

public void setFilterGeometry(Geometry value)

The query geometry used to filter results. Sets the value of the filterGeometry property.

Parameters:

value - allowed object is Geometry

getGeometryFieldName

public String getGeometryFieldName()

The name of the Geometry field to which the filter applies. Gets the value of the geometryFieldName property.

Returns:

possible object is String

setGeometryFieldName

public void setGeometryFieldName(String value)

The name of the Geometry field to which the filter applies. Sets the value of the geometryFieldName property.

Parameters:

value - allowed object is String

isFilterOwnsGeometry

public boolean isFilterOwnsGeometry()

Indicates whether the filter owns the query geometry. Gets the value of the filterOwnsGeometry property.

setFilterOwnsGeometry

public void setFilterOwnsGeometry(boolean value)

Indicates whether the filter owns the query geometry. Sets the value of the filterOwnsGeometry property.