com.esri.arcgis.geodatabase
Interface esriSpatialRelEnum

All Superinterfaces:
java.io.Serializable

public interface esriSpatialRelEnum
extends java.io.Serializable

Queryable Spatial Relationships.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

The esriSpatialRelEnum enumeration defines the common types of spatial relationships.

Remarks

esriSpatialRelUndefined

Used when the spatial relationship is not known at the time of object creation.

esriSpatialRelIntersects


Returns a feature if any spatial relationship is found. Applies to all shape type combinations.

esriSpatialRelEnvelopeIntersects

Returns a feature if the envelope of the two shapes intersects.

esriSpatialRelIndexIntersects

Returns a feature if the envelope of the query geometry intersects the index entry for the target geometry.  Because it uses the underlying index grid, rather than the evelope of the feature, it is faster and is commonly used for return features for display purposes.

esriSpatialRelTouches


Returns a feature if the two shapes share a common boundary. However, the intersection of the interiors of the two shapes must be empty. In the Point/Line case, the point may touch an endpoint only of the line. Applies to all combinations except Point/Point.

esriSpatialRelOverlaps

Returns a feature if the intersection of the two shapes results in an object of the same dimension, but different from both of the shapes. Applies to Area/Area, Line/Line, and Multi-point/Multi-point shape type combinations.

esriSpatialRelCrosses

Returns a feature if the intersection of the interiors of the two shapes is not empty and has a lower dimension than the maximum dimension of the two shapes. Two lines that share an endpoint in common do not cross. Valid for Line/Line, Line/Area, Multi-point/Area, and Multi-point/Line shape type combinations.

esriSpatialRelWithin

Returns a feature if its shape wholly contains the search geometry. Valid for all shape type combinations.

esriSpatialRelContains

Returns a feature if its shape is wholly contained within the search geometry. Valid for all shape type combinations.

esriSpatialRelRelation

This is the expected value for ISpatialFilter::SpatialRel when using ISpatialFilter::SpatialRelDescription to define a custom spatial relationship. See the help on ISpatialFilter for details.

See Also:
ISpatialFilter

Field Summary
static int esriSpatialRelContains
           
static int esriSpatialRelCrosses
           
static int esriSpatialRelEnvelopeIntersects
           
static int esriSpatialRelIndexIntersects
           
static int esriSpatialRelIntersects
           
static int esriSpatialRelOverlaps
           
static int esriSpatialRelRelation
           
static int esriSpatialRelTouches
           
static int esriSpatialRelUndefined
           
static int esriSpatialRelWithin
           
 

Field Detail

esriSpatialRelUndefined

public static final int esriSpatialRelUndefined
See Also:
Constant Field Values

esriSpatialRelIntersects

public static final int esriSpatialRelIntersects
See Also:
Constant Field Values

esriSpatialRelEnvelopeIntersects

public static final int esriSpatialRelEnvelopeIntersects
See Also:
Constant Field Values

esriSpatialRelIndexIntersects

public static final int esriSpatialRelIndexIntersects
See Also:
Constant Field Values

esriSpatialRelTouches

public static final int esriSpatialRelTouches
See Also:
Constant Field Values

esriSpatialRelOverlaps

public static final int esriSpatialRelOverlaps
See Also:
Constant Field Values

esriSpatialRelCrosses

public static final int esriSpatialRelCrosses
See Also:
Constant Field Values

esriSpatialRelWithin

public static final int esriSpatialRelWithin
See Also:
Constant Field Values

esriSpatialRelContains

public static final int esriSpatialRelContains
See Also:
Constant Field Values

esriSpatialRelRelation

public static final int esriSpatialRelRelation
See Also:
Constant Field Values