Module org.opengis.geoapi

Package org.opengis.temporal

Interface TemporalPrimitive

All Known Subinterfaces:

Instant, Period

@UML(identifier="TM_Primitive",
     specification=ISO_19108)
public interface TemporalPrimitive

A non-decomposed element of temporal object or topology of time. The two primitives in the temporal dimension are the instant and the period.

Since:

2.3

Method Summary

Modifier and Type	Method	Description
default TemporalOperatorName	findRelativePosition(TemporalPrimitive other)	Determines the position of this primitive relative to another temporal primitive.

Method Details

findRelativePosition

@UML(identifier="TM_Order.relativePosition",
     obligation=OPTIONAL,
     specification=ISO_19108)
default TemporalOperatorName findRelativePosition(TemporalPrimitive other)

Determines the position of this primitive relative to another temporal primitive. The relative position is identified by an operator which evaluates to true when the two operands are this and other.

Valid return values

If the two primitives are Instant instances, then this method can return one of the following values: before, equals or after.

If the first primitive is a Period and the second primitive is an Instant, then this method can return one of the following values: before, ended by, contains, begun by or after.

If the first primitive is an Instant and the second primitive is a Period, then this method can return one of the following values: before, begins, during, ends or after.

If the two primitives are Period instances, then this method can return any of the 13 values except any interacts.

Exceptions

This method may throw an IndeterminatePositionException if an input value is indeterminate. A DateTimeException can also be thrown if the temporal objects used by the primitives do not support the temporal fields that this method can compare.

Parameters:

other - the other primitive for which to determine the relative position.

Returns:

a temporal operator which is true when evaluated between this primitive and the other primitive.

Throws:

UnsupportedOperationException - if this operation is not supported.

IndeterminatePositionException - if a temporal position is indeterminate.

DateTimeException - if the two temporal primitives cannot be compared.

Since:

3.1

Departure from OGC/ISO standard for harmonization between different specifications

ISO 19108 defines a TM_RelativePosition code list which is identical to the ISO 19143 TemporalOperatorName code list, except that the latter has one more value for "any interacts". GeoAPI uses the latter for avoiding duplication.