prajna.geo

Class GeoFilter

java.lang.Object

prajna.geo.GeoFilter

Direct Known Subclasses:

EsriGeoFilter, MultiGeoFilter

public class GeoFilter
extends java.lang.Object

This class is designed to allow filtering based upon geographic coordintes. It tests points against a geographic shape to determine if the point is within the shape, within a certain radius of the shape, or outside the shape.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GeoFilter() Create a Geographic filter without a predefined shape.
GeoFilter(GeoShape shape) Create a Geographic filter using the specified geographic shape

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkPoint(GeoCoord coord) Check the given coordinates to see if it intersects, or lies near, the target geographic entity.
GeoShape	getFilterShape() Get the internal geographic shape used to filter points.
double	getRadius() Get the radius for comparisons.
void	setFilterShape(GeoShape shape) Set the shape used to perform the geographic filtering.
void	setRadius(double rad) Set the comparison radius.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoFilter

public GeoFilter()

Create a Geographic filter without a predefined shape.

GeoFilter

public GeoFilter(GeoShape shape)

Create a Geographic filter using the specified geographic shape

Parameters:

shape - the shape to use for the filter

Method Detail

checkPoint

public boolean checkPoint(GeoCoord coord)

Check the given coordinates to see if it intersects, or lies near, the target geographic entity. If the check radius is zero, this method checks for strict inclusion. If the radius > 0, then this method checks a rectangle with width and height equal to the specified radius. The check is performed using coordinate space, rather than a physical check.

Parameters:

coord - the geographic coordinate to check.

Returns:

true if the coordinate lies near or within the geographic region, false otherwise.

getFilterShape

public GeoShape getFilterShape()

Get the internal geographic shape used to filter points.

Returns:

the geographic filter shape

getRadius

public double getRadius()

Get the radius for comparisons. The radius is specified in meters.

Returns:

the comparison radius

setFilterShape

public void setFilterShape(GeoShape shape)

Set the shape used to perform the geographic filtering.

Parameters:

shape - the shape to use for filtering.

setRadius

public void setRadius(double rad)

Set the comparison radius. If the radius is zero (the default), the filter checks for strict inclusion. If the radius is greater than zero, the filter checks to determine if the coordinate is within the specified radius from the geographic object.

Parameters:

rad - the comparison radius, in meters.