Module org.opengis.geoapi

Package org.opengis.filter

Class TemporalOperatorName

Object

CodeList<TemporalOperatorName>

TemporalOperatorName

All Implemented Interfaces:

Serializable, Comparable<TemporalOperatorName>, ControlledVocabulary

@UML(identifier="TemporalOperatorName",
     specification=ISO_19143)
public final class TemporalOperatorName
extends CodeList<TemporalOperatorName>

Nature of the temporal operation between two geometries. Values are based on the 13 temporal relationships identified by Allen (1993), with the addition of ANY_INTERACTS.

Since:

3.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final TemporalOperatorName	AFTER	Operator evaluates to true if the first expression is after the second.
static final TemporalOperatorName	ANY_INTERACTS	Shortcut operator semantically equivalent to NOT (Before OR Meets OR MetBy OR After).
static final TemporalOperatorName	BEFORE	Operator evaluates to true if the first expression is before the second.
static final TemporalOperatorName	BEGINS	Operator evaluates to true if the first expression begins at the second.
static final TemporalOperatorName	BEGUN_BY	Operator evaluates to true if the first expression begun by the second.
static final TemporalOperatorName	CONTAINS	Operator evaluates to true if the first expression is contained by the second.
static final TemporalOperatorName	DURING	Operator evaluates to true if the first expression is during the second.
static final TemporalOperatorName	ENDED_BY	Operator evaluates to true if the first expression is ended by the second.
static final TemporalOperatorName	ENDS	Operator evaluates to true if the first expression ends at the second.
static final TemporalOperatorName	EQUALS	Operator evaluates to true if the first expression is equal to the second.
static final TemporalOperatorName	MEETS	Operator evaluates to true if the first expression meets the second.
static final TemporalOperatorName	MET_BY	Operator evaluates to true if the first expression is met by the second.
static final TemporalOperatorName	OVERLAPPED_BY	Operator evaluates to true if the first expression is overlapped by the second.
static final TemporalOperatorName	OVERLAPS	Operator evaluates to true if the first expression overlaps the second.

Method Summary

Modifier and Type	Method	Description
TemporalOperatorName[]	family()	Returns the list of codes of the same kind as this code list element.
Optional<TemporalOperatorName>	reversed()	Returns the operator which produces the same results than this operator when the argument order is reversed.
static TemporalOperatorName	valueOf(String code)	Returns the temporal operator that matches the given string, or returns a new one if none match it.
static TemporalOperatorName[]	values()	Returns the list of TemporalOperatorNames.

Methods inherited from class org.opengis.util.CodeList

compareTo, identifier, name, ordinal, readResolve, toString, valueOf, valueOf, valueOf, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

AFTER

@UML(identifier="After",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName AFTER

Operator evaluates to true if the first expression is after the second. In pseudo-code:

• When comparing two instants: self > other
• When comparing a period with an instant: self.begin > other
• When comparing two periods: self.begin > other.end

BEFORE

@UML(identifier="Before",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName BEFORE

Operator evaluates to true if the first expression is before the second. In pseudo-code:

• When comparing two instants: self < other
• When comparing a period with an instant: self.end < other
• When comparing two periods: self.end < other.begin

BEGINS

@UML(identifier="Begins",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName BEGINS

Operator evaluates to true if the first expression begins at the second. In pseudo-code:

• When comparing two periods: self.begin = other.begin AND self.end < other.end

BEGUN_BY

@UML(identifier="BegunBy",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName BEGUN_BY

Operator evaluates to true if the first expression begun by the second. In pseudo-code:

• When comparing a period with an instant: self.begin = other
• When comparing two periods: self.begin = other.begin AND self.end > other.end

CONTAINS

@UML(identifier="TContains",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName CONTAINS

Operator evaluates to true if the first expression is contained by the second. In pseudo-code:

• When comparing a period with an instant: self.begin < other AND self.end > other
• When comparing two periods: self.begin < other.begin AND self.end > other.end

DURING

@UML(identifier="During",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName DURING

Operator evaluates to true if the first expression is during the second. In pseudo-code:

• When comparing two periods: self.begin > other.begin AND self.end < other.end

EQUALS

@UML(identifier="TEquals",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName EQUALS

Operator evaluates to true if the first expression is equal to the second. In pseudo-code:

• When comparing two instants: self = other
• When comparing two periods: self.begin = other.begin AND self.end = other.end

OVERLAPS

@UML(identifier="TOverlaps",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName OVERLAPS

Operator evaluates to true if the first expression overlaps the second. In pseudo-code:

• When comparing two periods: self.begin < other.begin AND self.end > other.begin AND self.end < other.end

MEETS

@UML(identifier="Meets",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName MEETS

Operator evaluates to true if the first expression meets the second. In pseudo-code:

• When comparing two periods: self.end = other.begin

OVERLAPPED_BY

@UML(identifier="OverlappedBy",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName OVERLAPPED_BY

Operator evaluates to true if the first expression is overlapped by the second. In pseudo-code:

• When comparing two periods: self.begin > other.begin AND self.begin < other.end AND self.end > other.end

MET_BY

@UML(identifier="MetBy",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName MET_BY

Operator evaluates to true if the first expression is met by the second. In pseudo-code:

• When comparing two periods: self.begin = other.end

ENDS

@UML(identifier="Ends",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName ENDS

Operator evaluates to true if the first expression ends at the second. In pseudo-code:

• When comparing two periods: self.begin > other.begin AND self.end = other.end

ENDED_BY

@UML(identifier="EndedBy",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName ENDED_BY

Operator evaluates to true if the first expression is ended by the second. In pseudo-code:

• When comparing a period with an instant: self.end = other
• When comparing two periods: self.begin < other.begin AND self.end = other.end

ANY_INTERACTS

@UML(identifier="AnyInteracts",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final TemporalOperatorName ANY_INTERACTS

Shortcut operator semantically equivalent to NOT (Before OR Meets OR MetBy OR After). This is applicable to periods only.

Method Details

reversed

public Optional<TemporalOperatorName> reversed()

Returns the operator which produces the same results than this operator when the argument order is reversed. For example, the reverse of BEFORE is AFTER and the reverse of CONTAINS is DURING. The reverse of the reverse (if present) is always this.

Returns:

the operator when argument order is reversed.

values

public static TemporalOperatorName[] values()

Returns the list of TemporalOperatorNames.

Returns:

the list of codes declared in the current JVM.

family

public TemporalOperatorName[] family()

Returns the list of codes of the same kind as this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<TemporalOperatorName>

Returns:

all code values for this code list.

valueOf

public static TemporalOperatorName valueOf(String code)

Returns the temporal operator that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

Returns:

a code matching the given name.