gistoolkit.datasources.filter
Class ShapeFilter

java.lang.Object
  extended bygistoolkit.datasources.filter.ShapeFilter
All Implemented Interfaces:
Filter

public class ShapeFilter
extends java.lang.Object
implements Filter

Filter for filtering on the shape.


Field Summary
static int SHAPE_CONTAINS
          Returns all the shapes that contain this shape.
static int SHAPE_EQUALS
          Returns all the shapes that are the same shape as this shape.
static int SHAPE_INTERSECTS
          Returns all the shapes that intersect/overlap this shape.
 
Constructor Summary
ShapeFilter()
          Creates a new filter bassed on this shape for use with the configuration utility.
ShapeFilter(int inComparison, Shape inShape)
          Creates a new filter bassed on this shape.
 
Method Summary
 boolean contains(Record inRecord)
          Determines if this record should or should not be returned as part of the resulting dataset.
 int getComparison()
          Returns the type of comparison to perform.
 java.lang.String getFilterName()
          Get the name for this filter.
 Node getNode()
          Get the configuration information for the filter.
 Shape getShape()
          Return the shape to compare against.
 void setFilterName(java.lang.String inFilterName)
          Set the name for this filter.
 void setNode(Node inNode)
          Set the configuration information in the filter.
 java.lang.String toString()
          The tostring for this filter will nust return the name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SHAPE_CONTAINS

public static final int SHAPE_CONTAINS
Returns all the shapes that contain this shape.

See Also:
Constant Field Values

SHAPE_INTERSECTS

public static final int SHAPE_INTERSECTS
Returns all the shapes that intersect/overlap this shape.

See Also:
Constant Field Values

SHAPE_EQUALS

public static final int SHAPE_EQUALS
Returns all the shapes that are the same shape as this shape.

See Also:
Constant Field Values
Constructor Detail

ShapeFilter

public ShapeFilter()
Creates a new filter bassed on this shape for use with the configuration utility.


ShapeFilter

public ShapeFilter(int inComparison,
                   Shape inShape)
Creates a new filter bassed on this shape.

Method Detail

setFilterName

public void setFilterName(java.lang.String inFilterName)
Set the name for this filter.


getFilterName

public java.lang.String getFilterName()
Get the name for this filter.

Specified by:
getFilterName in interface Filter

getShape

public Shape getShape()
Return the shape to compare against. Creates a defensive copy, so use sparingly.


getComparison

public int getComparison()
Returns the type of comparison to perform.


contains

public boolean contains(Record inRecord)
Description copied from interface: Filter
Determines if this record should or should not be returned as part of the resulting dataset.

Returns True if the record should be included, and returns False if it should not.

Specified by:
contains in interface Filter

toString

public java.lang.String toString()
The tostring for this filter will nust return the name.


getNode

public Node getNode()
Get the configuration information for the filter.

Specified by:
getNode in interface Filter

setNode

public void setNode(Node inNode)
             throws java.lang.Exception
Set the configuration information in the filter.

Specified by:
setNode in interface Filter
Throws:
java.lang.Exception