Package org.apache.sis.filter
Interface Filter<R>
- All Superinterfaces:
- Predicate<R>
- All Known Subinterfaces:
- Optimization.OnFilter<R>
Identification of a subset of resources from a collection of resources
 whose property values satisfy a set of logically connected predicates.
 
Upcoming API change
This is a placeholder for a GeoAPI 3.1 interface not yet released. In a future version, all usages of this interface may be replaced by an interface of the same name but in the
This is a placeholder for a GeoAPI 3.1 interface not yet released. In a future version, all usages of this interface may be replaced by an interface of the same name but in the
org.opengis.filter package
 instead of org.apache.sis.filter.
 - 
Method SummaryModifier and TypeMethodDescriptionstatic <R> Filter<R>exclude()A filter that always evaluates tofalse.List<Expression<? super R,?>> Returns the expressions used as arguments for this filter.Enum<?>Returns the nature of the operator.static <R> Filter<R>include()A filter that always evaluates totrue.booleanGiven an object, determines if the test(s) represented by this filter are passed.
- 
Method Details- 
includeA filter that always evaluates totrue.- Type Parameters:
- R- the type of resources to filter.
- Returns:
- the "no filtering" filter.
 
- 
excludeA filter that always evaluates tofalse.- Type Parameters:
- R- the type of resources to filter.
- Returns:
- the "exclude all" filter.
 
- 
getOperatorTypeEnum<?> getOperatorType()Returns the nature of the operator.- Returns:
- the nature of this operator.
 
- 
getExpressionsList<Expression<? super R,?>> getExpressions()Returns the expressions used as arguments for this filter.- Returns:
- the expressions used as inputs, or an empty list if none.
 
- 
testGiven an object, determines if the test(s) represented by this filter are passed.- Specified by:
- testin interface- Predicate<R>
- Parameters:
- object- the object (often a- Featureinstance) to evaluate.
- Returns:
- trueif the test(s) are passed for the provided object.
- Throws:
- NullPointerException- if- objectis null.
- IllegalArgumentException- if the filter can not be applied on the given object.
 
 
-