Uses of Interface
org.apache.sis.filter.Filter
Packages that use Filter
Package
Description
Filters features according their properties.
Base implementation shared by the main
filter
package and the SQLMM extension.Placeholder for GeoAPI 3.1 interfaces (not yet released).
Build
DefaultFeatureType
s by inspection of database schemas.Data store base types for retrieving and saving geospatial data
in various storage formats.
-
Uses of Filter in org.apache.sis.filter
Subinterfaces of Filter in org.apache.sis.filterModifier and TypeInterfaceDescriptionstatic interface
Filter that can be optimized.Classes in org.apache.sis.filter that implement FilterModifier and TypeClassDescription(package private) class
BinaryGeometryFilter<R,
G> Base class for filters having two expressions evaluating to geometries.(package private) final class
BinarySpatialFilter<R,
G> Spatial operations between two geometries.(package private) class
Comparison operators between two values.(package private) static final class
The"PropertyIsBetween"
filter.(package private) static final class
The"PropertyIsEqualTo"
(=) filter.(package private) static final class
The"PropertyIsGreaterThan"
(>) filter.(package private) static final class
The"PropertyIsGreaterThanOrEqualTo"
(≥) filter.(package private) static final class
The"PropertyIsLessThan"
(<) filter.(package private) static final class
The"PropertyIsLessThanOrEqualTo"
(≤) filter.(package private) static final class
The"PropertyIsNotEqualTo"
(≠) filter.(package private) final class
DistanceFilter<R,
G> Spatial operations between two geometries and using a distance.(package private) final class
Placeholder for GeoAPI 3.1 interfaces (not yet released).(package private) class
FilterNode<R>
Base class of some (not all) nodes that are filters.(package private) final class
IdentifierFilter<R extends AbstractFeature>
Filter features using a set of predefined identifiers and discarding features whose identifier is not in the set.(package private) final class
LikeFilter<R>
A character string comparison operator with pattern matching.(package private) class
Logical filter (AND, OR) using an arbitrary number of operands.(package private) static final class
The "And" operation (⋀).(package private) static final class
The negation filter (¬).(package private) static final class
The "Or" operation (⋁).(package private) class
Temporal operations between a period and an instant.(package private) static final class
The"After"
(>) filter.(package private) static final class
The"AnyInteracts"
filter.(package private) static final class
The"Before"
(<) filter.(package private) static final class
The"Begins"
filter.(package private) static final class
The"BegunBy"
filter.(package private) static final class
The"TContains"
filter.(package private) static final class
The"During"
filter.(package private) static final class
The"EndedBy"
filter.(package private) static final class
The"Ends"
filter.(package private) static final class
The"TEquals"
(=) filter.(package private) static final class
The"Meets"
filter.(package private) static final class
The"MetBy"
filter.(package private) static final class
The"OverlappedBy"
filter.(package private) static final class
The"TOverlaps"
filter.(package private) static final class
Filter operator that checks if an expression's value is nil.(package private) static final class
Filter operator that checks if an expression's value isnull
.Fields in org.apache.sis.filter declared as FilterModifier and TypeFieldDescriptionstatic final Filter
FilterLiteral.EXCLUDE
static final Filter
FilterLiteral.INCLUDE
LogicalFilter.Not.operand
The filter to negate.LogicalFilter.operands
The filter on which to apply the logical operator.Methods in org.apache.sis.filter that return FilterModifier and TypeMethodDescriptionDefaultFilterFactory.after
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is after the second.DefaultFilterFactory.and
(Collection<? extends Filter<? super R>> operands) Creates aAND
filter between two or more filters.Creates aAND
filter between two filters.DefaultFilterFactory.anyInteracts
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates a shortcut operator semantically equivalent to NOT (Before OR Meets OR MetBy OR After).<R> Filter
<? super R> Optimizes or simplifies the given filter.DefaultFilterFactory.bbox
(Expression<? super R, ? extends G> geometry, org.opengis.geometry.Envelope bounds) Creates an operator that checks if the bounding box of the feature's geometry interacts with the bounding box provided in the filter properties.DefaultFilterFactory.before
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is before the second.DefaultFilterFactory.begins
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand begins at the second.DefaultFilterFactory.begunBy
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand begun by the second.DefaultFilterFactory.between
(Expression<? super R, ?> expression, Expression<? super R, ?> lowerBoundary, Expression<? super R, ?> upperBoundary) Filter operation for a range check.DefaultFilterFactory.beyond
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2, javax.measure.Quantity<javax.measure.quantity.Length> distance) Creates an operator that checks if all of a feature's geometry is more distant than the given distance from the given geometry.DefaultFilterFactory.contains
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the first geometric operand contains the second.DefaultFilterFactory.crosses
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the first geometric operand crosses the second.DefaultFilterFactory.disjoint
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the first operand is disjoint from the second.DefaultFilterFactory.during
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is during the second.DefaultFilterFactory.endedBy
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is ended by the second.DefaultFilterFactory.ends
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand ends at the second.DefaultFilterFactory.equal
(Expression<? super R, ?> expression1, Expression<? super R, ?> expression2) Filter operator that compares that two sub-expressions are equal to each other.DefaultFilterFactory.equals
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the geometry of the two operands are equal.static <R> Filter
<R> Filter.exclude()
A filter that always evaluates tofalse
.private static <R> Filter
<? super R> Optimization.getNotOperand
(Filter<R> filter) Returns the singleton operand of the givenNOT
filter.DefaultFilterFactory.greater
(Expression<? super R, ?> expression1, Expression<? super R, ?> expression2) Filter operator that checks that its first sub-expression is greater than its second sub-expression.DefaultFilterFactory.greaterOrEqual
(Expression<? super R, ?> expression1, Expression<? super R, ?> expression2) Filter operator that checks that its first sub-expression is greater than its second sub-expression.static <R> Filter
<R> Filter.include()
A filter that always evaluates totrue
.DefaultFilterFactory.intersects
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the two geometric operands intersect.DefaultFilterFactory.isNil
(Expression<? super R, ?> expression, String nilReason) An operator that tests if an expression's value is nil.DefaultFilterFactory.isNull
(Expression<? super R, ?> expression) An operator that tests if an expression's value isnull
.DefaultFilterFactory.less
(Expression<? super R, ?> expression1, Expression<? super R, ?> expression2) Filter operator that checks that its first sub-expression is less than its second sub-expression.DefaultFilterFactory.lessOrEqual
(Expression<? super R, ?> expression1, Expression<? super R, ?> expression2) Filter operator that checks that its first sub-expression is less than or equal to its second sub-expression.DefaultFilterFactory.like
(Expression<? super R, ?> expression, String pattern) Character string comparison operator with pattern matching and default wildcards.DefaultFilterFactory.like
(Expression<? super R, ?> expression, String pattern, char wildcard, char singleChar, char escape, boolean isMatchingCase) Character string comparison operator with pattern matching and specified wildcards.DefaultFilterFactory.meets
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand meets the second.DefaultFilterFactory.metBy
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is met by the second.Creates aNOT
filter for the given filter.DefaultFilterFactory.notEqual
(Expression<? super R, ?> expression1, Expression<? super R, ?> expression2) Filter operator that compares that its two sub-expressions are not equal to each other.BinaryGeometryFilter.optimize
(Optimization optimization) Tries to optimize this filter.LogicalFilter.And.optimize
(Optimization optimization) Tries to optimize this filter.LogicalFilter.Not.optimize
(Optimization optimization) Tries to optimize this filter.Returns the filter to use with duplicated operands removed, nested operations of the same type inlined, and literal values processed immediately.LogicalFilter.Or.optimize
(Optimization optimization) Tries to optimize this filter.Optimization.OnFilter.optimize
(Optimization optimization) Tries to optimize this filter.DefaultFilterFactory.or
(Collection<? extends Filter<? super R>> operands) Creates aOR
filter between two or more filters.Creates aOR
filter between two filters.DefaultFilterFactory.overlappedBy
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is overlapped by the second.DefaultFilterFactory.overlaps
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the interior of the first geometric operand somewhere overlaps the interior of the second geometric operand.ComparisonFilter.EqualTo.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.ComparisonFilter.GreaterThan.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.ComparisonFilter.GreaterThanOrEqualTo.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.ComparisonFilter.LessThan.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.ComparisonFilter.LessThanOrEqualTo.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.ComparisonFilter.NotEqualTo.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.LikeFilter.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.Optimization.OnFilter.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type and parameters than this filter, except for the expressions.TemporalFilter.After.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.AnyInteracts.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.Before.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.Begins.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.BegunBy.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.Contains.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.During.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.EndedBy.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.Ends.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.Equals.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.Meets.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.MetBy.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.OverlappedBy.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.TemporalFilter.Overlaps.recreate
(Expression<? super T, ?>[] effective) Creates a new filter of the same type but different parameters.UnaryFunction.IsNil.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.UnaryFunction.IsNull.recreate
(Expression<? super R, ?>[] effective) Creates a new filter of the same type but different parameters.DefaultFilterFactory.Features.resourceId
(String identifier) Creates a new predicate to identify an identifiable resource within a filter expression.DefaultFilterFactory.resourceId
(String rid) Creates a predicate to identify an identifiable resource within a filter expression.DefaultFilterFactory.tcontains
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is contained by the second.DefaultFilterFactory.tequals
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand is equal to the second.DefaultFilterFactory.touches
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the two geometric operands touch each other, but do not overlap.DefaultFilterFactory.toverlaps
(Expression<? super R, ? extends T> time1, Expression<? super R, ? extends T> time2) Creates an operator that checks if first temporal operand overlaps the second.DefaultFilterFactory.within
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2) Creates an operator that checks if the first geometric operand is completely contained by the constant geometric operand.DefaultFilterFactory.within
(Expression<? super R, ? extends G> geometry1, Expression<? super R, ? extends G> geometry2, javax.measure.Quantity<javax.measure.quantity.Length> distance) Creates an operator that checks if any part of the first geometry lies within the given distance of the second geometry.Methods in org.apache.sis.filter that return types with arguments of type FilterModifier and TypeMethodDescriptionOptimization.applyAndDecompose
(Filter<R> filter) Optimizes or simplifies the given filter and returns it as a list ofAND
operands.LogicalFilter.getOperands()
Returns a list containing all of the child filters of this object.LogicalFilter.Not.getOperands()
Returns the singleton filter used by this operation.Optimization.toAndOperands
(Filter<R> filter) Returns the given filter as a list ofAND
operands.Methods in org.apache.sis.filter with parameters of type FilterModifier and TypeMethodDescriptionCreates aAND
filter between two filters.<R> Filter
<? super R> Optimizes or simplifies the given filter.Optimization.applyAndDecompose
(Filter<R> filter) Optimizes or simplifies the given filter and returns it as a list ofAND
operands.private static <R> Filter
<? super R> Optimization.getNotOperand
(Filter<R> filter) Returns the singleton operand of the givenNOT
filter.Creates aNOT
filter for the given filter.Returns the filter to use with duplicated operands removed, nested operations of the same type inlined, and literal values processed immediately.Creates aOR
filter between two filters.Optimization.toAndOperands
(Filter<R> filter) Returns the given filter as a list ofAND
operands.Method parameters in org.apache.sis.filter with type arguments of type FilterModifier and TypeMethodDescriptionDefaultFilterFactory.and
(Collection<? extends Filter<? super R>> operands) Creates aAND
filter between two or more filters.protected LogicalFilter
<R> LogicalFilter.And.createSameType
(Collection<? extends Filter<? super R>> op) Creates a new logical operator of the same kind than this operator.protected abstract LogicalFilter
<R> LogicalFilter.createSameType
(Collection<? extends Filter<? super R>> op) Creates a new logical operator of the same kind than this operator.protected LogicalFilter
<R> LogicalFilter.Or.createSameType
(Collection<? extends Filter<? super R>> op) Creates a new logical operator of the same kind than this operator.DefaultFilterFactory.or
(Collection<? extends Filter<? super R>> operands) Creates aOR
filter between two or more filters.Constructors in org.apache.sis.filter with parameters of type FilterModifierConstructorDescription(package private)
Creates a new operator for the two given operands.(package private)
LogicalFilter
(Filter<? super R> operand1, Filter<? super R> operand2) Creates a new logical operator with the two given operands.(package private)
Creates a new operator.(package private)
Creates a new operator for the two given operands.Constructor parameters in org.apache.sis.filter with type arguments of type FilterModifierConstructorDescription(package private)
And
(Collection<? extends Filter<? super R>> op) Creates a new operator for the given operands.(package private)
LogicalFilter
(Collection<? extends Filter<? super R>> op) Creates a new logical operator applied on the given operands.(package private)
Or
(Collection<? extends Filter<? super R>> op) Creates a new operator for the given operands. -
Uses of Filter in org.apache.sis.internal.filter
Fields in org.apache.sis.internal.filter with type parameters of type FilterMethods in org.apache.sis.internal.filter that return types with arguments of type FilterModifier and TypeMethodDescriptionprotected final BiConsumer
<Filter<R>, A> Visitor.getFilterHandler
(Enum<?> type) Returns the action to execute for the given type of filter.Methods in org.apache.sis.internal.filter with parameters of type FilterModifier and TypeMethodDescriptionprotected void
Visitor.typeNotFound
(Enum<?> type, Filter<R> filter, A accumulator) Adds the value to use or throws an exception when there is no action registered for a given filter type.void
Executes the registered action for the given filter.Method parameters in org.apache.sis.internal.filter with type arguments of type FilterModifier and TypeMethodDescriptionprotected final void
Visitor.setBinaryComparisonHandlers
(BiConsumer<Filter<R>, A> action) Sets the same action to execute for the <, >, ≤, ≥, = and ≠ types of filter.protected final void
Visitor.setBinaryTemporalHandlers
(BiConsumer<Filter<R>, A> action) Sets the same action to execute for the temporal comparison operators.private void
Visitor.setFamilyHandlers
(Enum<?> lastType, BiConsumer<Filter<R>, A> action) Sets the same action for all member of the same family of filters.protected final void
Visitor.setFilterHandler
(Enum<?> type, BiConsumer<Filter<R>, A> action) Sets the action to execute for the given type of filter.protected final void
Visitor.setLogicalHandlers
(BiConsumer<Filter<R>, A> action) Sets the same action to execute for theAND
,OR
andNOT
types filter.protected final void
Visitor.setNullAndNilHandlers
(BiConsumer<Filter<R>, A> action) Sets the same action for both theIsNull
andIsNil
types of filter.protected final void
Visitor.setSpatialHandlers
(BiConsumer<Filter<R>, A> action) Sets the same action to execute for the spatial comparison operators, including the ones with a distance parameter. -
Uses of Filter in org.apache.sis.internal.geoapi.filter
Subinterfaces of Filter in org.apache.sis.internal.geoapi.filterModifier and TypeInterfaceDescriptioninterface
Placeholder for GeoAPI 3.1 interfaces (not yet released).interface
Placeholder for GeoAPI 3.1 interfaces (not yet released).interface
Placeholder for GeoAPI 3.1 interfaces (not yet released).Fields in org.apache.sis.internal.geoapi.filter declared as FilterFields in org.apache.sis.internal.geoapi.filter with type parameters of type FilterMethods in org.apache.sis.internal.geoapi.filter that return types with arguments of type FilterConstructors in org.apache.sis.internal.geoapi.filter with parameters of type FilterConstructor parameters in org.apache.sis.internal.geoapi.filter with type arguments of type FilterModifierConstructorDescription(package private)
FilterExpressions
(List<Filter<? super R>> filters) -
Uses of Filter in org.apache.sis.internal.sql.feature
Methods in org.apache.sis.internal.sql.feature with parameters of type FilterModifier and TypeMethodDescriptionvoid
SelectionClauseWriter.Comparison.accept
(Filter<AbstractFeature> f, SelectionClause sql) Invoked when a comparison needs to be converted to SQL clause.void
SelectionClauseWriter.Function.accept
(Filter<AbstractFeature> filter, SelectionClause sql) Writes the function as an SQL statement.void
SelectionClauseWriter.Logic.accept
(Filter<AbstractFeature> f, SelectionClause sql) Invoked when a logical filter needs to be converted to SQL clause.(package private) final boolean
SelectionClause.tryAppend
(SelectionClauseWriter writer, Filter<? super AbstractFeature> filter) Tries to append a SQL statement for the given filter.protected final void
SelectionClauseWriter.typeNotFound
(Enum<?> type, Filter<AbstractFeature> filter, SelectionClause sql) Invoked when an unsupported filter is found.(package private) final boolean
SelectionClauseWriter.write
(SelectionClause sql, Filter<? super AbstractFeature> filter) Executes the registered action for the given filter.protected final void
SelectionClauseWriter.writeBinaryOperator
(SelectionClause sql, Filter<AbstractFeature> filter, String operator) Writes the expressions of a filter as a binary operator. -
Uses of Filter in org.apache.sis.storage
Fields in org.apache.sis.storage declared as FilterModifier and TypeFieldDescriptionprivate Filter
<? super AbstractFeature> FeatureQuery.selection
The filter for trimming feature instances.Methods in org.apache.sis.storage that return FilterModifier and TypeMethodDescriptionFilter
<? super AbstractFeature> FeatureQuery.getSelection()
Returns the filter for trimming feature instances.Methods in org.apache.sis.storage with parameters of type FilterModifier and TypeMethodDescriptionvoid
FeatureQuery.setSelection
(Filter<? super AbstractFeature> selection) Sets a filter for trimming feature instances.