/*$************************************************************************************************
**
** $Id: FilterFactory.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/FilterFactory.java $
**
** Copyright (C) 2005 Open GIS Consortium, Inc.
** All Rights Reserved. http://www.opengis.org/legal/
**
*************************************************************************************************/
package org.opengis.filter;
// J2SE direct dependencies
import java.util.List;
import java.util.Set;
// OpenGIS direct dependencies
import org.opengis.filter.expression.Add;
import org.opengis.filter.expression.Divide;
import org.opengis.filter.expression.Expression;
import org.opengis.filter.expression.Function;
import org.opengis.filter.expression.Literal;
import org.opengis.filter.expression.Multiply;
import org.opengis.filter.expression.PropertyName;
import org.opengis.filter.expression.Subtract;
import org.opengis.filter.spatial.BBOX;
import org.opengis.filter.spatial.Beyond;
import org.opengis.filter.spatial.Contains;
import org.opengis.filter.spatial.Crosses;
import org.opengis.filter.spatial.DWithin;
import org.opengis.filter.spatial.Disjoint;
import org.opengis.filter.spatial.Equals;
import org.opengis.filter.spatial.Intersects;
import org.opengis.filter.spatial.Overlaps;
import org.opengis.filter.spatial.Touches;
import org.opengis.filter.spatial.Within;
import org.opengis.spatialschema.geometry.Geometry;
/**
* Interface whose methods allow the caller to create instances of the various
* {@link Filter} and {@link Expression} subclasses.
*
* @version Implementation specification 1.0
* @author Chris Dillard (SYS Technologies)
* @since GeoAPI 2.0
*/
public interface FilterFactory {
////////////////////////////////////////////////////////////////////////////////
//
// FILTERS
//
////////////////////////////////////////////////////////////////////////////////
/** {@code AND} filter between two filters. */
And and(Filter f, Filter g);
/** {@code AND} filter between a list of filters. */
And and(List f);
/** {@code OR} filter between two filters. */
Or or(Filter f, Filter g);
/** {@code OR} filter between a list of filters. */
Or or (List f);
/** Reverses the logical value of a filter. */
Not not(Filter f);
/** Passes only for features that have one of the IDs given to this object. */
FeatureId featureId(Set ids);
/** Retrieves the value of a {@linkplain org.opengis.feature.Feature feature}'s property. */
PropertyName property(String name);
/** A compact way of encoding a range check. */
PropertyIsBetween between(Expression expr, Expression lower, Expression upper);
/** Compares that two sub-expressions are equal to each other.
* @todo should be equalTo (so equals can refer to geometry)
*/
PropertyIsEqualTo equals(Expression expr1, Expression expr2);
/** Checks that the first sub-expression is greater than the second subexpression. */
PropertyIsGreaterThan greater(Expression expr1, Expression expr2);
/** Checks that the first sub-expression is greater or equal to the second subexpression. */
PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1, Expression expr2);
/** Checks that its first sub-expression is less than its second subexpression. */
PropertyIsLessThan less(Expression expr1, Expression expr2);
/** Checks that its first sub-expression is less than or equal to its second subexpression. */
PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1, Expression expr2);
/** Character string comparison operator with pattern matching and default wildcards. */
PropertyIsLike like(Expression expr, String pattern);
/** Character string comparison operator with pattern matching and specified wildcards. */
PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape);
/** Checks if an expression's value is {@code null}. */
PropertyIsNull isNull(Expression expr);
////////////////////////////////////////////////////////////////////////////////
//
// SPATIAL FILTERS
//
////////////////////////////////////////////////////////////////////////////////
/** Checks if the bounding box of the feature's geometry overlaps the specified bounding box.
* @todo Redefine to agree with specification "geometry overlaps the specified bounding box"
*/
BBOX bbox(String propertyName, double minx, double miny, double maxx, double maxy, String srs);
/** Check if all of a feature's geometry is more distant than the given distance from this object's geometry. */
Beyond beyond(String propertyName, Geometry geometry, double distance, String units);
/** Checks if the the first geometric operand contains the second. */
Contains contains(String propertyName, Geometry geometry);
/** Checks if the first geometric operand crosses the second. */
Crosses crosses(String propertyName, Geometry geometry);
/** Checks if the first operand is disjoint from the second. */
Disjoint disjoint(String propertyName, Geometry geometry);
/** Checks if any part of the first geometry lies within the given distance of the second geometry. */
DWithin dwithin(String propertyName, Geometry geometry, double distance, String units);
/** Checks if the geometry of the two operands are equal. */
Equals equals(String propertyName, Geometry geometry);
/** Checks if the two geometric operands intersect. */
Intersects intersects(String propertyName, Geometry geometry);
/** Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry. */
Overlaps overlaps(String propertyName, Geometry geometry);
/** Checks if the feature's geometry touches, but does not overlap with the geometry held by this object. */
Touches touches(String propertyName, Geometry geometry);
/** Checks if the feature's geometry is completely contained by the specified constant geometry. */
Within within(String propertyName, Geometry geometry);
////////////////////////////////////////////////////////////////////////////////
//
// EXPRESSIONS
//
////////////////////////////////////////////////////////////////////////////////
/** Computes the numeric addition of the first and second operand. */
Add add(Expression expr1, Expression expr2);
/** Computes the numeric quotient resulting from dividing the first operand by the second. */
Divide divide(Expression expr1, Expression expr2);
/** Computes the numeric product of their first and second operand. */
Multiply multiply(Expression expr1, Expression expr2);
/** Computes the numeric difference between the first and second operand. */
Subtract subtract(Expression expr1, Expression expr2);
/** Call into some implementation-specific function. */
Function function(String name, Expression[] args);
/** Call into some implementation-specific function with one argument. */
Function function(String name, Expression arg1);
/** Call into some implementation-specific function with two arguments. */
Function function(String name, Expression arg1, Expression arg2);
/** Call into some implementation-specific function with three arguments. */
Function function(String name, Expression arg1, Expression arg2, Expression arg3);
/** A constant, literal value that can be used in expressions. */
Literal literal(Object obj);
/** A constant, literal {@link Byte} value that can be used in expressions. */
Literal literal(byte b);
/** A constant, literal {@link Short} value that can be used in expressions. */
Literal literal(short s);
/** A constant, literal {@link Integer} value that can be used in expressions. */
Literal literal(int i);
/** A constant, literal {@link Long} value that can be used in expressions. */
Literal literal(long l);
/** A constant, literal {@link Float} value that can be used in expressions. */
Literal literal(float f);
/** A constant, literal {@link Double} value that can be used in expressions. */
Literal literal(double d);
/** A constant, literal {@link Character} value that can be used in expressions. */
Literal literal(char c);
/** A constant, literal {@link Boolean} value that can be used in expressions. */
Literal literal(boolean b);
}
Ads help maintain this website.