Package org.apache.sis.filter

Class TemporalFilter<T>

java.lang.Object

org.apache.sis.internal.filter.Node

org.apache.sis.filter.BinaryFunction<T,Object,Object>

org.apache.sis.filter.TemporalFilter<T>

Type Parameters:

T - the type of resources (e.g. Feature) used as inputs.

All Implemented Interfaces:

Serializable, Predicate<T>, Filter<T>, Optimization.OnFilter<T>

Direct Known Subclasses:

TemporalFilter.After, TemporalFilter.AnyInteracts, TemporalFilter.Before, TemporalFilter.Begins, TemporalFilter.BegunBy, TemporalFilter.Contains, TemporalFilter.During, TemporalFilter.EndedBy, TemporalFilter.Ends, TemporalFilter.Equals, TemporalFilter.Meets, TemporalFilter.MetBy, TemporalFilter.OverlappedBy, TemporalFilter.Overlaps

abstract class TemporalFilter<T>
extends BinaryFunction<T,Object,Object>
implements Filter<T>, Optimization.OnFilter<T>

Temporal operations between a period and an instant. The nature of the operation depends on the subclass. Subclasses shall override at least one of following methods:

• evaluate(Instant, Instant)
• evaluate(Period, Instant)
• evaluate(Period, Period)

Since:

1.1

Version:

1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	TemporalFilter.After<T>	The "After" (>) filter.
(package private) static final class	TemporalFilter.AnyInteracts<T>	The "AnyInteracts" filter.
(package private) static final class	TemporalFilter.Before<T>	The "Before" (<) filter.
(package private) static final class	TemporalFilter.Begins<T>	The "Begins" filter.
(package private) static final class	TemporalFilter.BegunBy<T>	The "BegunBy" filter.
(package private) static final class	TemporalFilter.Contains<T>	The "TContains" filter.
(package private) static final class	TemporalFilter.During<T>	The "During" filter.
(package private) static final class	TemporalFilter.EndedBy<T>	The "EndedBy" filter.
(package private) static final class	TemporalFilter.Ends<T>	The "Ends" filter.
(package private) static final class	TemporalFilter.Equals<T>	The "TEquals" (=) filter.
(package private) static final class	TemporalFilter.Meets<T>	The "Meets" filter.
(package private) static final class	TemporalFilter.MetBy<T>	The "MetBy" filter.
(package private) static final class	TemporalFilter.OverlappedBy<T>	The "OverlappedBy" filter.
(package private) static final class	TemporalFilter.Overlaps<T>	The "TOverlaps" filter.

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID	For cross-version compatibility.

Fields inherited from class org.apache.sis.filter.BinaryFunction

expression1, expression2

Constructor Summary

Constructors

Constructor	Description
TemporalFilter(Expression<? super T,?> expression1, Expression<? super T,?> expression2)	Creates a new temporal function.

Method Summary

Modifier and Type	Method	Description
protected boolean	evaluate(Instant self, Instant other)	Evaluates the filter between two instants.
protected boolean	evaluate(Period self, Instant other)	Evaluates the filter between a period and an instant.
protected boolean	evaluate(Period self, Period other)	Evaluates the filter between two periods.
private static boolean	isAfter(Instant self, Instant other)	Returns true if self is non null and after other.
private static boolean	isAfter(Instant self, Instant other)	Returns true if self is non null and after other.
private static boolean	isBefore(Instant self, Instant other)	Returns true if self is non null and before other.
private static boolean	isBefore(Instant self, Instant other)	Returns true if self is non null and before other.
private static boolean	isEqual(Instant self, Instant other)	Returns true if self is non null and equal to other.
private static boolean	isEqual(Instant self, Instant other)	Returns true if self is non null and equal to other.
final boolean	test(T candidate)	Determines if the test(s) represented by this filter passes with the given operands.
private static Instant	toInstant(Instant instant)	Converts a GeoAPI instant to a Java instant.

Methods inherited from class org.apache.sis.filter.BinaryFunction

apply, applyAsDecimal, applyAsDouble, applyAsFraction, applyAsInteger, applyAsLong, getChildren, getExpressions, getParameters

Methods inherited from class org.apache.sis.internal.filter.Node

createName, createType, equals, getGeometryLibrary, hashCode, symbol, toGeometryWrapper, toString, unwrap, warning

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sis.filter.Filter

getExpressions, getOperatorType

Methods inherited from interface org.apache.sis.filter.Optimization.OnFilter

and, negate, optimize, or, recreate

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

Constructor Details

TemporalFilter

TemporalFilter(Expression<? super T,?> expression1,
 Expression<? super T,?> expression2)

Creates a new temporal function.

Parameters:

expression1 - the first of the two expressions to be used by this function.

expression2 - the second of the two expressions to be used by this function.

Method Details

toInstant

private static Instant toInstant(Instant instant)

Converts a GeoAPI instant to a Java instant. This is a temporary method to be removed after we revisited org.apache.sis.internal.geoapi.temporal package.

Parameters:

instant - the GeoAPI instant, or null.

Returns:

the Java instant, or null.

isBefore

private static boolean isBefore(Instant self,
 Instant other)

Returns true if self is non null and before other. This is an helper function for evaluate(…) methods implementations.

isAfter

private static boolean isAfter(Instant self,
 Instant other)

Returns true if self is non null and after other. This is an helper function for evaluate(…) methods implementations.

isEqual

private static boolean isEqual(Instant self,
 Instant other)

Returns true if self is non null and equal to other. This is an helper function for evaluate(…) methods implementations.

isBefore

private static boolean isBefore(Instant self,
 Instant other)

Returns true if self is non null and before other. This is an helper function for evaluate(…) methods implementations.

isAfter

private static boolean isAfter(Instant self,
 Instant other)

Returns true if self is non null and after other. This is an helper function for evaluate(…) methods implementations.

isEqual

private static boolean isEqual(Instant self,
 Instant other)

Returns true if self is non null and equal to other. This is an helper function for evaluate(…) methods implementations.

test

public final boolean test(T candidate)

Determines if the test(s) represented by this filter passes with the given operands. Values of BinaryFunction.expression1 and BinaryFunction.expression2 shall be two single values.

Specified by:

test in interface Filter<T>

Specified by:

test in interface Predicate<T>

Parameters:

candidate - the object (often a Feature instance) to evaluate.

Returns:

true if the test(s) are passed for the provided object.

evaluate

protected boolean evaluate(Instant self,
 Instant other)

Evaluates the filter between two instants. Both arguments given to this method are non-null. The self and other argument names are chosen to match ISO 19108 tables.

evaluate

protected boolean evaluate(Period self,
 Instant other)

Evaluates the filter between a period and an instant. Both arguments given to this method are non-null, but period begin or end instant may be null. The self and other argument names are chosen to match ISO 19108 tables.

evaluate

protected boolean evaluate(Period self,
 Period other)

Evaluates the filter between two periods. Both arguments given to this method are non-null, but period begin or end instant may be null. The self and other argument names are chosen to match ISO 19108 tables.