Esri Geoportal Server
1.0

com.esri.gpt.catalog.discovery
Class SpatialClause

java.lang.Object
  extended by com.esri.gpt.catalog.discovery.DiscoveryComponent
      extended by com.esri.gpt.catalog.discovery.DiscoveryClause
          extended by com.esri.gpt.catalog.discovery.SpatialClause
Direct Known Subclasses:
SpatialClause.GeometryBBOXIntersects, SpatialClause.GeometryContains, SpatialClause.GeometryIntersects, SpatialClause.GeometryIsDisjointTo, SpatialClause.GeometryIsEqualTo, SpatialClause.GeometryIsWithin, SpatialClause.GeometryOverlaps

public class SpatialClause
extends DiscoveryClause

A clause that compares a stored geometry to a supplied geometry.


Nested Class Summary
static class SpatialClause.GeometryBBOXIntersects
          True if the bounding envelope of the stored geometry intersects the input geometry.
static class SpatialClause.GeometryContains
          True if the stored geometry fully contains the input geometry.
static class SpatialClause.GeometryIntersects
          True if there is any positive interaction between the geometries.
static class SpatialClause.GeometryIsDisjointTo
          True if the geometries do not intersect.
static class SpatialClause.GeometryIsEqualTo
          True if the geometries are equal.
static class SpatialClause.GeometryIsWithin
          True if the stored geometry is fully contained by the input geometry.
static class SpatialClause.GeometryOverlaps
          True if the geometries intersect but are not equal.
 
Method Summary
 void echo(StringBuffer sb, int depth)
          Appends property information for the component to a buffer.
 Envelope getBoundingEnvelope()
          Gets the bounding envelope of the constraining geometry.
 String getSrsName()
          Gets the name of the spatial reference system for the constraining geometry.
 Discoverable getTarget()
          Gets the discoverable property targeted by the clause.
 void setSrsName(String name)
          Sets the name of the spatial reference system for the constraining geometry.
 void setTarget(Discoverable target)
          Sets the discoverable property targeted by the clause.
 
Methods inherited from class com.esri.gpt.catalog.discovery.DiscoveryClause
echo
 
Methods inherited from class com.esri.gpt.catalog.discovery.DiscoveryComponent
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getBoundingEnvelope

public Envelope getBoundingEnvelope()
Gets the bounding envelope of the constraining geometry.

Returns:
the bounding envelope

getSrsName

public String getSrsName()
Gets the name of the spatial reference system for the constraining geometry.

Returns:
the spatial reference system name

setSrsName

public void setSrsName(String name)
Sets the name of the spatial reference system for the constraining geometry.

Parameters:
name - the spatial reference system name

getTarget

public Discoverable getTarget()
Gets the discoverable property targeted by the clause.
This will typically be the "Geometry" property.

Returns:
the target property

setTarget

public void setTarget(Discoverable target)
Sets the discoverable property targeted by the clause.
This will typically be the "Geometry" property.

Parameters:
target - the target property

echo

public void echo(StringBuffer sb,
                 int depth)
Appends property information for the component to a buffer.

Overrides:
echo in class DiscoveryClause
Parameters:
sb - the buffer to use when appending information
depth - the depth of the clause

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.