| 1 | /*
|
|---|
| 2 | * GeoTools - The Open Source Java GIS Toolkit
|
|---|
| 3 | * http://geotools.org
|
|---|
| 4 | *
|
|---|
| 5 | * (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
|
|---|
| 6 | *
|
|---|
| 7 | * This library is free software; you can redistribute it and/or
|
|---|
| 8 | * modify it under the terms of the GNU Lesser General Public
|
|---|
| 9 | * License as published by the Free Software Foundation;
|
|---|
| 10 | * version 2.1 of the License.
|
|---|
| 11 | *
|
|---|
| 12 | * This library is distributed in the hope that it will be useful,
|
|---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 15 | * Lesser General Public License for more details.
|
|---|
| 16 | */
|
|---|
| 17 | package org.geotools.filter;
|
|---|
| 18 |
|
|---|
| 19 | import org.opengis.filter.spatial.DistanceBufferOperator;
|
|---|
| 20 |
|
|---|
| 21 |
|
|---|
| 22 | /**
|
|---|
| 23 | * Defines geometry filters with a distance element.
|
|---|
| 24 | *
|
|---|
| 25 | * <p>
|
|---|
| 26 | * These filters are defined in the filter spec by the DistanceBufferType,
|
|---|
| 27 | * which contains an additioinal field for a distance. The two filters that
|
|---|
| 28 | * use the distance buffer type are Beyond and DWithin.
|
|---|
| 29 | * </p>
|
|---|
| 30 | *
|
|---|
| 31 | * <p>
|
|---|
| 32 | * From the spec: The spatial operators DWithin and Beyond test whether the
|
|---|
| 33 | * value of a geometric property is within or beyond a specified distance of
|
|---|
| 34 | * the specified literal geometric value. Distance values are expressed using
|
|---|
| 35 | * the Distance element.
|
|---|
| 36 | * </p>
|
|---|
| 37 | *
|
|---|
| 38 | * <p>
|
|---|
| 39 | * For now this code does not take into account the units of distance, we will
|
|---|
| 40 | * assume that the filter units are the same as the geometry being filtered.
|
|---|
| 41 | * </p>
|
|---|
| 42 | *
|
|---|
| 43 | * <p></p>
|
|---|
| 44 | *
|
|---|
| 45 | * @author Chris Holmes, TOPP
|
|---|
| 46 | *
|
|---|
| 47 | * @source $URL: http://svn.osgeo.org/geotools/branches/2.7.x/modules/library/api/src/main/java/org/geotools/filter/GeometryDistanceFilter.java $
|
|---|
| 48 | * @version $Id: GeometryDistanceFilter.java 37280 2011-05-24 07:53:02Z mbedward $
|
|---|
| 49 | *
|
|---|
| 50 | * @task REVISIT: add units for distance. Should it just be a string? Or
|
|---|
| 51 | * should it actually resolve the definition?
|
|---|
| 52 | *
|
|---|
| 53 | * @deprecated use {@link org.opengis.filter.spatial.DistanceBufferOperator}
|
|---|
| 54 | *
|
|---|
| 55 | */
|
|---|
| 56 | public interface GeometryDistanceFilter extends GeometryFilter, DistanceBufferOperator {
|
|---|
| 57 | /**
|
|---|
| 58 | * Returns true if the passed in object is the same as this filter. Checks
|
|---|
| 59 | * to make sure the filter types are the same as well as all three of the
|
|---|
| 60 | * values.
|
|---|
| 61 | *
|
|---|
| 62 | * @param obj The filter to test equality against.
|
|---|
| 63 | *
|
|---|
| 64 | * @return True if the objects are equal.
|
|---|
| 65 | */
|
|---|
| 66 | boolean equals(Object obj);
|
|---|
| 67 | }
|
|---|
