org.opengis.temporal
Class RelativePosition

Show UML class diagram

Object
  CodeList<RelativePosition>
      RelativePosition

All Implemented Interfaces:

Serializable, Comparable<RelativePosition>

@UML(identifier="TM_RelativePosition",
     specification=ISO_19108)
public final class RelativePosition
extends CodeList<RelativePosition>

Values for relative temporal position based on the 13 temporal relationships identified by Allen (1993).

See Also:

Serialized Form

TODO:

Need javadoc for each enumeration.

Nested Class Summary

Nested classes/interfaces inherited from class CodeList

CodeList.Filter

Field Summary

static RelativePosition	AFTER
static RelativePosition	BEFORE
static RelativePosition	BEGINS
static RelativePosition	BEGUN_BY
static RelativePosition	CONTAINS
static RelativePosition	DURING
static RelativePosition	ENDED_BY
static RelativePosition	ENDS
static RelativePosition	EQUALS
static RelativePosition	MEETS
static RelativePosition	MET_BY
static RelativePosition	OVERLAPPED_BY
static RelativePosition	OVERLAPS

Method Summary

RelativePosition[]	family() Returns the list of enumerations of the same kind than this enum.
static RelativePosition	valueOf(String code) Returns the relative position that matches the given string, or returns a new one if none match it.
static RelativePosition[]	values() Returns the list of RelativePositions.

Methods inherited from class CodeList

compareTo, equals, identifier, name, names, ordinal, readResolve, toString, valueOf, valueOf

Methods inherited from class Object

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

Field Detail

BEFORE

public static final RelativePosition BEFORE

AFTER

public static final RelativePosition AFTER

BEGINS

public static final RelativePosition BEGINS

ENDS

public static final RelativePosition ENDS

DURING

public static final RelativePosition DURING

EQUALS

public static final RelativePosition EQUALS

CONTAINS

public static final RelativePosition CONTAINS

OVERLAPS

public static final RelativePosition OVERLAPS

MEETS

public static final RelativePosition MEETS

OVERLAPPED_BY

public static final RelativePosition OVERLAPPED_BY

MET_BY

public static final RelativePosition MET_BY

BEGUN_BY

public static final RelativePosition BEGUN_BY

ENDED_BY

public static final RelativePosition ENDED_BY

Method Detail

values

public static RelativePosition[] values()

Returns the list of RelativePositions.

Returns:

The list of codes declared in the current JVM.

family

public RelativePosition[] family()

Returns the list of enumerations of the same kind than this enum.

Specified by:

family in class CodeList<RelativePosition>

Returns:

The codes of the same kind than this code.

valueOf

public static RelativePosition valueOf(String code)

Returns the relative position that matches the given string, or returns a new one if none match it. More specifically, this methods returns the first instance for which name().equals(code) returns true. 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.