com.eatthepath.jeospatial

Interface SearchCriteria<T extends GeospatialPoint>

All Known Implementing Classes:

BoundingBoxSearchCriteria

public interface SearchCriteria<T extends GeospatialPoint>

SearchCriteria can be applied to nearest-neighbor searches in a GeospatialPointDatabase to filter the returned list of nearest neighbors by arbitrary criteria beyond the built-in/implicit distance criteria. Points in a GeospatialPointDatabase that match supplementary search criteria may be included in the list of points returned by a call to one of the database's search methods while points that do not match the criteria will not be included.

Author:

Jon Chambers

See Also:

GeospatialPointDatabase.getNearestNeighbor(GeospatialPoint, SearchCriteria), GeospatialPointDatabase.getNearestNeighbor(GeospatialPoint, double, SearchCriteria), GeospatialPointDatabase.getNearestNeighbors(GeospatialPoint, int, SearchCriteria), GeospatialPointDatabase.getNearestNeighbors(GeospatialPoint, int, double, SearchCriteria), GeospatialPointDatabase.getAllNeighborsWithinDistance(GeospatialPoint, double, SearchCriteria)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(T point) Tests whether an individual point matches an arbitrary set of supplementary criteria.

Method Detail

matches

boolean matches(T point)

Tests whether an individual point matches an arbitrary set of supplementary criteria. If the point matches and this method returns true, the point may be included in search results from a GeospatialPointDatabase. If the point does not match and this method returns false, the point will not be included.

Parameters:

point - the point to test against these criteria

Returns:

true if the point matches these criteria or false otherwise