/*$************************************************************************************************
**
** $Id: Filter.java 831 2006-05-01 00:27:23Z Desruisseaux $
**
** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/filter/Filter.java $
**
** Copyright (C) 2005 Open GIS Consortium, Inc.
** All Rights Reserved. http://www.opengis.org/legal/
**
*************************************************************************************************/
package org.opengis.filter;
// OpenGIS direct dependencies
import org.opengis.feature.Feature;
// Annotations
import org.opengis.annotation.Extension;
import org.opengis.annotation.XmlElement;
/**
* The abstract base class for filters.
*
* A filter defines a constraint that can be checked against an instance of an Object.
*
* Often a filter is used to to define a set {@linkplain Feature feature} instances
* that are to be operated upon. The operating set can be comprised of one or more
* enumerated features or a set of features defined by specifying spatial and
* non-spatial constraints on the geometric and scalar properties of a feature type.
*
* Roughly speaking, a filter encodes the information present in the {@code WHERE}
* clause of a SQL statement. There are various subclasses of this class that
* implement many types of filters, such as simple property comparisons or spatial
* queries.
*
* The second use of Filter focuses on expressing constraints (or Facets). This use
* places restrictions on the allowable and is captured as part of schema information
* (@linkplain FeatureType). This is similar to the XML concept of "facets".
*
*
* @version Implementation specification 1.0
* @author Chris Dillard (SYS Technologies)
* @since GeoAPI 2.0
*/
@XmlElement("Filter")
public interface Filter {
/**
* Given a feature, this method determines whether the feature passes the
* test(s) represented by this filter object.
* @param feature
* @return true if feature passes test(s) represented by this filter
*/
@Extension
boolean evaluate(Feature feature);
/**
* Give an object, this method determines if the test(s) represented by this filter object
* are passed.
*
* This ability is used to allow Queries against non feature data (such as Record) and
* to express constraints on permissable data values.
*
* @param object
* @return true if the test(s) are passed for the provided object
*/
boolean evaulate(Object object);
/**
* Accepts a visitor.
*
* Implementations of all subinterfaces must have with a
* method whose content is the following:
*
return visitor.{@linkplain FilterVisitor#visit visit}(this, extraData);
*
*/
@Extension
Object accept(FilterVisitor visitor, Object extraData);
}
Ads help maintain this website.