org.opengis.filter
Interface FilterFactory2

All Superinterfaces:
FilterFactory
All Known Subinterfaces:
FilterFactory
All Known Implementing Classes:
FilterFactoryImpl, FilterFactoryImplNamespaceAware, FilterFactoryImplReportInvalidProperty

public interface FilterFactory2
extends FilterFactory

Allows creation of additional Filter constructs.

Why do we need this? Because not all implementations are going to be using geoapi Geometry. This allows the creation of complient filters with SFSQL Geometry constructs. Consider this a bridge to existing projects allowing GeoAPI to be used.

Since:
GeoAPI 2.1
Author:
Jody Garnett, Refractions Research Inc.

Method Summary
 BBOX bbox(Expression geometry, BoundingBox bounds)
          Checks if the bounding box of the feature's geometry overlaps the indicated bounds.
 BBOX3D bbox(Expression geometry, BoundingBox3D env)
          Checks if the geometry expression overlaps the specified bounding box.
 BBOX3D bbox(Expression geometry, BoundingBox3D env, MultiValuedFilter.MatchAction matchAction)
          Checks if the geometry expression overlaps the specified bounding box.
 BBOX bbox(Expression geometry, BoundingBox bounds, MultiValuedFilter.MatchAction matchAction)
          Checks if the bounding box of the feature's geometry overlaps the indicated bounds.
 BBOX bbox(Expression geometry, double minx, double miny, double maxx, double maxy, String srs)
          Checks if the geometry expression overlaps the specified bounding box.
 BBOX bbox(Expression geometry, double minx, double miny, double maxx, double maxy, String srs, MultiValuedFilter.MatchAction matchAction)
          Checks if the geometry expression overlaps the specified bounding box.
 Beyond beyond(Expression geometry1, Expression geometry2, double distance, String units)
          Check if all of a geometry is more distant than the given distance from this object's geometry.
 Beyond beyond(Expression geometry1, Expression geometry2, double distance, String units, MultiValuedFilter.MatchAction matchAction)
          Check if all of a geometry is more distant than the given distance from this object's geometry.
 Contains contains(Expression geometry1, Expression geometry2)
          Checks if the the first geometric operand contains the second.
 Contains contains(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the the first geometric operand contains the second.
 Crosses crosses(Expression geometry1, Expression geometry2)
          Checks if the first geometric operand crosses the second.
 Crosses crosses(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the first geometric operand crosses the second.
 Disjoint disjoint(Expression geometry1, Expression geometry2)
          Checks if the first operand is disjoint from the second.
 Disjoint disjoint(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the first operand is disjoint from the second.
 DWithin dwithin(Expression geometry1, Expression geometry2, double distance, String units)
          Checks if any part of the first geometry lies within the given distance of the second geometry.
 DWithin dwithin(Expression geometry1, Expression geometry2, double distance, String units, MultiValuedFilter.MatchAction matchAction)
          Checks if any part of the first geometry lies within the given distance of the second geometry.
 Equals equal(Expression geometry1, Expression geometry2)
          Checks if the geometry of the two operands are equal.
 Equals equal(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the geometry of the two operands are equal.
 FunctionName functionName(Name name, int nargs, List<String> argNames)
          FunctionName used to describe an available function.
 FunctionName functionName(Name name, List<Parameter<?>> args, Parameter<?> ret)
          FunctionName used to describe an available function.
 FunctionName functionName(String name, int nargs, List<String> argNames)
          FunctionName used to describe an available function.
 FunctionName functionName(String name, List<Parameter<?>> args, Parameter<?> ret)
          FunctionName used to describe an available function.
 Id id(FeatureId... fids)
           
 Intersects intersects(Expression geometry1, Expression geometry2)
          Checks if the two geometric operands intersect.
 Intersects intersects(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the two geometric operands intersect.
 PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape, boolean matchCase)
          Character string comparison operator with pattern matching and specified wildcards.
 PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape, boolean matchCase, MultiValuedFilter.MatchAction matchAction)
          Character string comparison operator with pattern matching and specified wildcards.
 Overlaps overlaps(Expression geometry1, Expression geometry2)
          Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.
 Overlaps overlaps(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.
<T> Parameter<T>
parameter(String name, Class<T> type, InternationalString title, InternationalString description, boolean required, int minOccurs, int maxOccurs, T defaultValue)
          Creates a parameter of a function.
 PropertyName property(Name name)
          Retrieves the value of a feature's property.
 PropertyName property(String xpath, NamespaceSupport namespaceContext)
          Retrieves the value of a feature's property.
 Touches touches(Expression propertyName1, Expression geometry2)
          Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.
 Touches touches(Expression propertyName1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.
 Within within(Expression geometry1, Expression geometry2)
          Checks if the feature's geometry is completely contained by the specified constant geometry.
 Within within(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the feature's geometry is completely contained by the specified constant geometry.
 
Methods inherited from interface FilterFactory
add, after, after, and, and, anyInteracts, anyInteracts, arithmeticOperators, bbox, bbox, bbox, bbox, before, before, begins, begins, begunBy, begunBy, between, between, beyond, beyond, capabilities, capabilities, comparisonOperators, contains, contains, crosses, crosses, disjoint, disjoint, divide, during, during, dwithin, dwithin, endedBy, endedBy, ends, ends, equal, equal, equals, equals, equals, featureId, featureId, function, function, functionName, functionName, functions, gmlObjectId, greater, greater, greater, greaterOrEqual, greaterOrEqual, greaterOrEqual, id, idCapabilities, intersects, intersects, isNil, isNull, less, less, less, lessOrEqual, lessOrEqual, lessOrEqual, like, like, literal, literal, literal, literal, literal, literal, literal, literal, literal, meets, meets, metBy, metBy, multiply, not, notEqual, notEqual, notEqual, operator, or, or, overlappedBy, overlappedBy, overlaps, overlaps, property, resourceId, resourceId, scalarCapabilities, sort, spatialCapabilities, spatialOperator, spatialOperators, subtract, tcontains, tcontains, temporalCapabilities, temporalOperator, tequals, tequals, touches, touches, toverlaps, toverlaps, within, within
 

Method Detail

parameter

<T> Parameter<T> parameter(String name,
                           Class<T> type,
                           InternationalString title,
                           InternationalString description,
                           boolean required,
                           int minOccurs,
                           int maxOccurs,
                           T defaultValue)
Creates a parameter of a function.

Parameters:
name - Parameter name
type - Parameter type/class
title - Human readable title of the parameter
description - Extended description of the parameter
required - Flag indicating if the parameter is required or not
minOccurs - The minimum number of occurrences of the parameter
maxOccurs - The maximum number of occurrences of the parameter
defaultValue - Default value for the parameter

functionName

FunctionName functionName(String name,
                          int nargs,
                          List<String> argNames)
FunctionName used to describe an available function.

Parameters:
name - name of function
nargs - number of arguments, use a negative number to indicate a minimum if the function supports an open ended number of arguments
argNames - Optional list of argument names

functionName

FunctionName functionName(Name name,
                          int nargs,
                          List<String> argNames)
FunctionName used to describe an available function.

Parameters:
name - qualified name of function
nargs - number of arguments, use a negative number to indicate a minimum if the function supports an open ended number of arguments
argNames - Optional list of argument names

functionName

FunctionName functionName(String name,
                          List<Parameter<?>> args,
                          Parameter<?> ret)
FunctionName used to describe an available function.

Parameters:
name - name of function
args - Parameters describing function arguments.
ret - Parameter describing function return.

functionName

FunctionName functionName(Name name,
                          List<Parameter<?>> args,
                          Parameter<?> ret)
FunctionName used to describe an available function.

Parameters:
name - qualified name of function
args - Parameters describing function arguments.
ret - Parameter describing function return.

id

Id id(FeatureId... fids)

property

PropertyName property(Name name)
Retrieves the value of a feature's property.

Parameters:
name - Name of attribute referenced
Returns:
PropertyName

property

PropertyName property(String xpath,
                      NamespaceSupport namespaceContext)
Retrieves the value of a feature's property.

Parameters:
xpath - XPath expression (subject to the restrictions of filter specificaiton)
namespaceContext - Used to interpret any namespace prefixs in above xpath expression
Returns:
PropertyName

like

PropertyIsLike like(Expression expr,
                    String pattern,
                    String wildcard,
                    String singleChar,
                    String escape,
                    boolean matchCase)
Character string comparison operator with pattern matching and specified wildcards.

Specified by:
like in interface FilterFactory
Parameters:
expr -
pattern -
wildcard -
singleChar -
escape -
matchCase -
Returns:

like

PropertyIsLike like(Expression expr,
                    String pattern,
                    String wildcard,
                    String singleChar,
                    String escape,
                    boolean matchCase,
                    MultiValuedFilter.MatchAction matchAction)
Character string comparison operator with pattern matching and specified wildcards.

Specified by:
like in interface FilterFactory
Parameters:
expr -
pattern -
wildcard -
singleChar -
escape -
matchCase -
matchAction -
Returns:

bbox

BBOX bbox(Expression geometry,
          double minx,
          double miny,
          double maxx,
          double maxy,
          String srs)
Checks if the geometry expression overlaps the specified bounding box.


bbox

BBOX bbox(Expression geometry,
          double minx,
          double miny,
          double maxx,
          double maxy,
          String srs,
          MultiValuedFilter.MatchAction matchAction)
Checks if the geometry expression overlaps the specified bounding box.


bbox

BBOX3D bbox(Expression geometry,
            BoundingBox3D env)
Checks if the geometry expression overlaps the specified bounding box.


bbox

BBOX3D bbox(Expression geometry,
            BoundingBox3D env,
            MultiValuedFilter.MatchAction matchAction)
Checks if the geometry expression overlaps the specified bounding box.


bbox

BBOX bbox(Expression geometry,
          BoundingBox bounds)
Checks if the bounding box of the feature's geometry overlaps the indicated bounds.

This method does not strictly confirm to the the Filter 1.0 specification, you may use it to check expressions other than PropertyName.

Parameters:
geometry - Expression used to access a Geometry, in order to check for interaction with bounds
bounds - Indicates the bounds to check geometry against

bbox

BBOX bbox(Expression geometry,
          BoundingBox bounds,
          MultiValuedFilter.MatchAction matchAction)
Checks if the bounding box of the feature's geometry overlaps the indicated bounds.

This method does not strictly confirm to the the Filter 1.0 specification, you may use it to check expressions other than PropertyName.

Parameters:
geometry - Expression used to access a Geometry, in order to check for interaction with bounds
bounds - Indicates the bounds to check geometry against
matchAction - Match Action

beyond

Beyond beyond(Expression geometry1,
              Expression geometry2,
              double distance,
              String units)
Check if all of a geometry is more distant than the given distance from this object's geometry.


beyond

Beyond beyond(Expression geometry1,
              Expression geometry2,
              double distance,
              String units,
              MultiValuedFilter.MatchAction matchAction)
Check if all of a geometry is more distant than the given distance from this object's geometry.


contains

Contains contains(Expression geometry1,
                  Expression geometry2)
Checks if the the first geometric operand contains the second.


contains

Contains contains(Expression geometry1,
                  Expression geometry2,
                  MultiValuedFilter.MatchAction matchAction)
Checks if the the first geometric operand contains the second.


crosses

Crosses crosses(Expression geometry1,
                Expression geometry2)
Checks if the first geometric operand crosses the second.


crosses

Crosses crosses(Expression geometry1,
                Expression geometry2,
                MultiValuedFilter.MatchAction matchAction)
Checks if the first geometric operand crosses the second.


disjoint

Disjoint disjoint(Expression geometry1,
                  Expression geometry2)
Checks if the first operand is disjoint from the second.


disjoint

Disjoint disjoint(Expression geometry1,
                  Expression geometry2,
                  MultiValuedFilter.MatchAction matchAction)
Checks if the first operand is disjoint from the second.


dwithin

DWithin dwithin(Expression geometry1,
                Expression geometry2,
                double distance,
                String units)
Checks if any part of the first geometry lies within the given distance of the second geometry.


dwithin

DWithin dwithin(Expression geometry1,
                Expression geometry2,
                double distance,
                String units,
                MultiValuedFilter.MatchAction matchAction)
Checks if any part of the first geometry lies within the given distance of the second geometry.


equal

Equals equal(Expression geometry1,
             Expression geometry2)
Checks if the geometry of the two operands are equal.


equal

Equals equal(Expression geometry1,
             Expression geometry2,
             MultiValuedFilter.MatchAction matchAction)
Checks if the geometry of the two operands are equal.


intersects

Intersects intersects(Expression geometry1,
                      Expression geometry2)
Checks if the two geometric operands intersect.


intersects

Intersects intersects(Expression geometry1,
                      Expression geometry2,
                      MultiValuedFilter.MatchAction matchAction)
Checks if the two geometric operands intersect.


overlaps

Overlaps overlaps(Expression geometry1,
                  Expression geometry2)
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.


overlaps

Overlaps overlaps(Expression geometry1,
                  Expression geometry2,
                  MultiValuedFilter.MatchAction matchAction)
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.


touches

Touches touches(Expression propertyName1,
                Expression geometry2)
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.


touches

Touches touches(Expression propertyName1,
                Expression geometry2,
                MultiValuedFilter.MatchAction matchAction)
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.


within

Within within(Expression geometry1,
              Expression geometry2)
Checks if the feature's geometry is completely contained by the specified constant geometry.


within

Within within(Expression geometry1,
              Expression geometry2,
              MultiValuedFilter.MatchAction matchAction)
Checks if the feature's geometry is completely contained by the specified constant geometry.



Copyright © 1996-2014 Geotools. All Rights Reserved.