org.opengis.referencing.cs
Class AxisDirection

Object
  CodeList
      AxisDirection

All Implemented Interfaces:

Serializable

public final class AxisDirection

extends CodeList

Orientation of axis. Some coordinate systems use non-standard orientations. For example, the first axis in South African grids usually points West, instead of East. This information is obviously relevant for algorithms converting South African grid coordinates into Lat/Long.

Version:

Implementation specification 1.0

Author:

OpenGIS® consortium

See Also:

Serialized Form

UML identifier (code list): CS_AxisOrientationEnum

Field Summary

static AxisDirection	BOTTOM Increasing ordinates values go bottom, usually on a horizontal plane.
static AxisDirection	DOWN Increasing ordinates values go down, usually on a vertical axe.
static AxisDirection	EAST Increasing ordinates values go East.
static AxisDirection	FUTURE Increasing ordinates values go future.
static AxisDirection	LEFT Increasing ordinates values go left, usually on a horizontal plane.
static AxisDirection	NORTH Increasing ordinates values go North.
static AxisDirection	OTHER Unknown or unspecified axis orientation.
static AxisDirection	PAST Increasing ordinates values go past.
static AxisDirection	RIGHT Increasing ordinates values go right, usually on a horizontal plane.
static AxisDirection	SOUTH Increasing ordinates values go South.
static AxisDirection	TOP Increasing ordinates values go top, usually on a horizontal plane.
static AxisDirection	UP Increasing ordinates values go up, usually on a vertical axe.
static AxisDirection	WEST Increasing ordinates values go West.

Constructor Summary

AxisDirection(String name)
Constructs an enum with the given name.

Method Summary

AxisDirection	absolute() Returns the "absolute" direction of this axis.
AxisDirection[]	family() Returns the list of enumerations of the same kind than this enum.
AxisDirection	inverse() Returns the opposite direction of this axis.
static AxisDirection[]	values() Returns the list of AxisDirections.

Methods inherited from class CodeList

name, ordinal, readResolve, toString

Methods inherited from class Object

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

Field Detail

OTHER

public static final AxisDirection OTHER

Unknown or unspecified axis orientation. This can be used for engineering or derived coordinate reference systems.

UML identifier (conditional attribute): CS_AO_OTHER

NORTH

public static final AxisDirection NORTH

Increasing ordinates values go North. This is usually used for Grid Y coordinates and Latitude.

UML identifier (conditional attribute): CS_AO_NORTH

SOUTH

public static final AxisDirection SOUTH

Increasing ordinates values go South. This is rarely used.

UML identifier (conditional attribute): CS_AO_SOUTH

EAST

public static final AxisDirection EAST

Increasing ordinates values go East. This is usually used for Grid X coordinates and Longitude.

UML identifier (conditional attribute): CS_AO_EAST

WEST

public static final AxisDirection WEST

Increasing ordinates values go West. This is usually used for Grid X coordinates and Longitude.

UML identifier (conditional attribute): CS_AO_WEST

UP

public static final AxisDirection UP

Increasing ordinates values go up, usually on a vertical axe. This is used for vertical coordinate reference systems.

UML identifier (conditional attribute): CS_AO_UP

DOWN

public static final AxisDirection DOWN

Increasing ordinates values go down, usually on a vertical axe. This is used for vertical coordinate reference systems.

UML identifier (conditional attribute): CS_AO_DOWN

RIGHT

public static final AxisDirection RIGHT

Increasing ordinates values go right, usually on a horizontal plane. This is used for rendering coordinate reference systems.

LEFT

public static final AxisDirection LEFT

Increasing ordinates values go left, usually on a horizontal plane. This is used for rendering coordinate reference systems.

TOP

public static final AxisDirection TOP

Increasing ordinates values go top, usually on a horizontal plane. This is used for rendering coordinate reference systems.

BOTTOM

public static final AxisDirection BOTTOM

Increasing ordinates values go bottom, usually on a horizontal plane. This is used for rendering coordinate reference systems.

FUTURE

public static final AxisDirection FUTURE

Increasing ordinates values go future. This is used for temporal coordinate reference systems.

PAST

public static final AxisDirection PAST

Increasing ordinates values go past. This is used for temporal coordinate reference systems.

Constructor Detail

AxisDirection

public AxisDirection(String name)

Constructs an enum with the given name. The new enum is automatically added to the list returned by values().

Parameters:

name - The enum name. This name must not be in use by an other enum of this type.

Method Detail

values

public static AxisDirection[] values()

Returns the list of AxisDirections.

family

public AxisDirection[] family()

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

Specified by:

family in class CodeList

inverse

public AxisDirection inverse()

Returns the opposite direction of this axis. The opposite direction of North is South, and the opposite direction of South is North. The same applies to East-West, Up-Down and Future-Past. Other axis directions are returned unchanged.

absolute

public AxisDirection absolute()

Returns the "absolute" direction of this axis. This "absolute" operation is similar to the Math.abs(int) method in that "negative" directions (SOUTH, WEST, DOWN, PAST are changed for their "positive" counterparts (NORTH, EAST, UP, FUTURE) More specifically, the following conversion table is applied.

Direction	Absolute value
NORTH	NORTH
SOUTH	NORTH
EAST	EAST
WEST	EAST
UP	UP
DOWN	UP
RIGHT	RIGHT
LEFT	RIGHT
TOP	TOP
BOTTOM	TOP
FUTURE	FUTURE
PAST	FUTURE
OTHER	OTHER