org.deegree.filter
Interface Filter

All Known Implementing Classes:

IdFilter, OperatorFilter

public interface Filter

A Filter is a boolean expression (often containing spatial predicates) that can be tested against objects, such as Features.

deegree's filter subsystem is an implementation of the OpenGIS Filter Encoding Implementation Specification 1.0.0/1.1.0/2.0.0 (=ISO 19143).

Version:

$Revision:$, $Date:$

Author:

Markus Schneider , last edited by: $Author:$

See Also:

IdFilter, OperatorFilter

Nested Class Summary

static class

Filter.Type Convenience enum type for discriminating the different filter types.

Method Summary

<T> boolean	evaluate(T obj, XPathEvaluator<T> xpathEvaluator) Determines if the given object matches this Filter.
Filter.Type	getType() Returns the type of filter.

Method Detail

getType

Filter.Type getType()

Returns the type of filter. Use this to safely determine the subtype of Filter.

Returns:

type of filter (id or expression based)

evaluate

<T> boolean evaluate(T obj,
                     XPathEvaluator<T> xpathEvaluator)
                 throws FilterEvaluationException

Determines if the given object matches this Filter.

Type Parameters:

T - type of the context object

Parameters:

obj - object that the operator is evaluated upon, must not be null

xpathEvaluator - used for evaluation of XPath expressions, must not be null

Returns:

true, if the operator evaluates to true, false otherwise

Throws:

FilterEvaluationException - if the evaluation fails