prajna.geo

Class MultiGeoFilter

java.lang.Object

prajna.geo.GeoFilter

prajna.geo.MultiGeoFilter

public class MultiGeoFilter
extends GeoFilter

This class demonstrates using multiple GeoFilters to determine which region a particular point appears in. The demonstration program uses ESRI shape files to extract geographic regions. It also creates arbitrary geographic regions as well to demonstrate checking of geographic regions aside from predefined geometry.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
MultiGeoFilter() Create a MultiGeoFilter object
MultiGeoFilter(GeoFilter filter) Create a MultiGeoFilter object from another GeoFilter.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilter(GeoShape shape) Add a geographic shape to the set of filters.
void	addFilter(java.lang.String shapeName, GeoShape shape) Add a geographic shape to the set of filters.
java.util.Collection<java.lang.String>	getShapeNames() Get the names of all of the shapes that have been added to this filter.
java.lang.String	pickShape(GeoCoord coord) Return the name of the shape picked for the given coordinate.
void	setRadius(double rad) Set the comparison radius.

Methods inherited from class prajna.geo.GeoFilter

checkPoint, getFilterShape, getRadius, setFilterShape

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiGeoFilter

public MultiGeoFilter()

Create a MultiGeoFilter object

MultiGeoFilter

public MultiGeoFilter(GeoFilter filter)

Create a MultiGeoFilter object from another GeoFilter. If the filter uses a GeoMultiShape, then that shape is used for this MultiGeoFilter. Otherwise, the shape is stored as one of the shapes within this MultiGeoFilter.

Parameters:

filter - A GeoFilter to use in creating this GeoMultiFilter

Method Detail

addFilter

public void addFilter(GeoShape shape)

Add a geographic shape to the set of filters. This method will create a new Geographic Filter for the defined shape, using the name contained within the shape's data object to identify it. If the shape does not contain a data object, or the object is not named, the shape will not be added to the set of filters.

Parameters:

shape - The geographic shape

addFilter

public void addFilter(java.lang.String shapeName,
             GeoShape shape)

Add a geographic shape to the set of filters. This method will create a new Geographic Filter for the defined shape, and add it to the internal map. If the shape or the name is null, it is not added to the set of filters.

Parameters:

shapeName - the name of the shape.

shape - The geographic shape

getShapeNames

public java.util.Collection<java.lang.String> getShapeNames()

Get the names of all of the shapes that have been added to this filter.

Returns:

the collection of shape names

pickShape

public java.lang.String pickShape(GeoCoord coord)

Return the name of the shape picked for the given coordinate. The name of the shape is the name associated with the particular filter which matches the coordinate. If multiple shapes intersect, only one matching value is returned.

Parameters:

coord - The coordinate to check

Returns:

the name of the shape associated with the matching filter, or null if no filters match.

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.

Overrides:

setRadius in class GeoFilter

Parameters:

rad - the comparison radius, in meters.