org.opengis.referencing.cs.AxisDirection Maven / Gradle / Ivy
Show all versions of gt-opengis Show documentation
/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2003-2005, Open Geospatial Consortium Inc.
*
* All Rights Reserved. http://www.opengis.org/legal/
*/
package org.opengis.referencing.cs;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
import java.util.ArrayList;
import java.util.List;
import org.opengis.annotation.Extension;
import org.opengis.annotation.UML;
import org.opengis.util.CodeList;
/**
* The direction of positive increments in the coordinate value for a coordinate system axis. This
* direction is exact in some cases, and is approximate in other cases.
*
* 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 Abstract
* specification 2.0
* @author Martin Desruisseaux (IRD)
* @since GeoAPI 1.0
*/
@UML(identifier = "CS_AxisDirection", specification = ISO_19111)
public final class AxisDirection extends CodeList {
/** Serial number for compatibility with different versions. */
private static final long serialVersionUID = -4405275475770755714L;
/** List of all enumerations of this type. Must be declared before any enum declaration. */
private static final List VALUES = new ArrayList(32);
/** Unknown or unspecified axis orientation. */
@UML(identifier = "CS_AxisOrientationEnum.CS_AO_Other", specification = OGC_01009)
public static final AxisDirection OTHER = new AxisDirection("OTHER");
static {
OTHER.opposite = OTHER;
}
/**
* Axis positive direction is north. In a geographic or projected CRS, north is defined through
* the geodetic datum. In an engineering CRS, north may be defined with respect to an
* engineering object rather than a geographical direction.
*/
@UML(identifier = "north", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection NORTH = new AxisDirection("NORTH");
/**
* Axis positive direction is approximately north-north-east.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "northNorthEast", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection NORTH_NORTH_EAST = new AxisDirection("NORTH_NORTH_EAST");
/**
* Axis positive direction is approximately north-east.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "northEast", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection NORTH_EAST = new AxisDirection("NORTH_EAST");
/**
* Axis positive direction is approximately east-north-east.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "eastNorthEast", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection EAST_NORTH_EAST = new AxisDirection("EAST_NORTH_EAST");
/**
* Axis positive direction is π/2 radians clockwise from north. This is usually used for Grid
* X coordinates and Longitude.
*/
@UML(identifier = "east", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection EAST = new AxisDirection("EAST");
/**
* Axis positive direction is approximately east-south-east.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "eastSouthEast", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection EAST_SOUTH_EAST = new AxisDirection("EAST_SOUTH_EAST");
/**
* Axis positive direction is approximately south-east.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "southEast", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection SOUTH_EAST = new AxisDirection("SOUTH_EAST");
/**
* Axis positive direction is approximately south-south-east.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "southSouthEast", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection SOUTH_SOUTH_EAST = new AxisDirection("SOUTH_SOUTH_EAST");
/** Axis positive direction is π radians clockwise from north. */
@UML(identifier = "south", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection SOUTH = new AxisDirection("SOUTH", NORTH);
/**
* Axis positive direction is approximately south-south-west.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "southSouthWest", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection SOUTH_SOUTH_WEST =
new AxisDirection("SOUTH_SOUTH_WEST", NORTH_NORTH_EAST);
/**
* Axis positive direction is approximately south-west.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "southWest", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection SOUTH_WEST = new AxisDirection("SOUTH_WEST", NORTH_EAST);
/**
* Axis positive direction is approximately west-south-west.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "westSouthWest", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection WEST_SOUTH_WEST =
new AxisDirection("WEST_SOUTH_WEST", EAST_NORTH_EAST);
/**
* Axis positive direction is 3π/2 radians clockwise from north. This is usually used for
* Grid X coordinates and Longitude.
*/
@UML(identifier = "west", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection WEST = new AxisDirection("WEST", EAST);
/**
* Axis positive direction is approximately west-north-west.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "westNorthWest", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection WEST_NORTH_WEST =
new AxisDirection("WEST_NORTH_WEST", EAST_SOUTH_EAST);
/**
* Axis positive direction is approximately north-west.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "northWest", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection NORTH_WEST = new AxisDirection("NORTH_WEST", SOUTH_EAST);
/**
* Axis positive direction is approximately north-north-west.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "northNorthWest", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection NORTH_NORTH_WEST =
new AxisDirection("NORTH_NORTH_WEST", SOUTH_SOUTH_EAST);
/**
* Axis positive direction is up relative to gravity. This is used for {@linkplain
* org.opengis.referencing.crs.VerticalCRS vertical} coordinate reference systems.
*/
@UML(identifier = "up", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection UP = new AxisDirection("UP");
/**
* Axis positive direction is down relative to gravity. This is used for {@linkplain
* org.opengis.referencing.crs.VerticalCRS vertical} coordinate reference systems.
*/
@UML(identifier = "down", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection DOWN = new AxisDirection("DOWN", UP);
/**
* Axis positive direction is in the equatorial plane from the centre of the modelled earth
* towards the intersection of the equator with the prime meridian.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "geocentricX", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection GEOCENTRIC_X = new AxisDirection("GEOCENTRIC_X");
/**
* Axis positive direction is in the equatorial plane from the centre of the modelled earth
* towards the intersection of the equator and the meridian π/2 radians eastwards from the
* prime meridian.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "geocentricY", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection GEOCENTRIC_Y = new AxisDirection("GEOCENTRIC_Y");
/**
* Axis positive direction is from the centre of the modelled earth parallel to its rotation
* axis and towards its north pole.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "geocentricZ", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection GEOCENTRIC_Z = new AxisDirection("GEOCENTRIC_Z");
/**
* Axis positive direction is towards the future. This is used for {@linkplain
* org.opengis.referencing.crs.TemporalCRS temporal} coordinate reference systems.
*/
@UML(identifier = "future", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection FUTURE = new AxisDirection("FUTURE");
/**
* Axis positive direction is towards the past. This is used for {@linkplain
* org.opengis.referencing.crs.TemporalCRS temporal} coordinate reference systems.
*/
@UML(identifier = "past", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection PAST = new AxisDirection("PAST", FUTURE);
/**
* Axis positive direction is towards higher pixel column.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "columnPositive", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection COLUMN_POSITIVE = new AxisDirection("COLUMN_POSITIVE");
/**
* Axis positive direction is towards lower pixel column.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "columnNegative", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection COLUMN_NEGATIVE =
new AxisDirection("COLUMN_NEGATIVE", COLUMN_POSITIVE);
/**
* Axis positive direction is towards higher pixel row.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "rowPositive", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection ROW_POSITIVE = new AxisDirection("ROW_POSITIVE");
/**
* Axis positive direction is towards lower pixel row.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "rowNegative", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection ROW_NEGATIVE =
new AxisDirection("ROW_NEGATIVE", ROW_POSITIVE);
/**
* Axis positive direction is right in display.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "displayRight", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection DISPLAY_RIGHT = new AxisDirection("DISPLAY_RIGHT");
/**
* Axis positive direction is left in display.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "displayLeft", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection DISPLAY_LEFT =
new AxisDirection("DISPLAY_LEFT", DISPLAY_RIGHT);
/**
* Axis positive direction is towards top of approximately vertical display surface.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "displayUp", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection DISPLAY_UP = new AxisDirection("DISPLAY_UP");
/**
* Axis positive direction is towards bottom of approximately vertical display surface.
*
* @since GeoAPI 2.0
*/
@UML(identifier = "displayDown", obligation = CONDITIONAL, specification = ISO_19111)
public static final AxisDirection DISPLAY_DOWN = new AxisDirection("DISPLAY_DOWN", DISPLAY_UP);
/**
* The opposite direction for this axis, or {@code null} if the opposite direction has not yet
* been specified.
*/
private transient AxisDirection opposite;
/**
* Constructs an enum with the given name. The new enum is automatically added to the list
* returned by {@link #values}.
*
* @param name The enum name. This name must not be in use by an other enum of this type.
*/
private AxisDirection(final String name) {
super(name, VALUES);
}
/** Constructs an axis direction which is the opposite of the specified direction. */
private AxisDirection(final String name, final AxisDirection opposite) {
this(name);
if (opposite.opposite != null) {
throw new IllegalArgumentException(String.valueOf(opposite));
}
this.opposite = opposite;
opposite.opposite = this;
}
/**
* Returns the list of {@code AxisDirection}s.
*
* @return The list of codes declared in the current JVM.
*/
public static AxisDirection[] values() {
synchronized (VALUES) {
return VALUES.toArray(new AxisDirection[VALUES.size()]);
}
}
/** Returns the list of enumerations of the same kind than this enum. */
public AxisDirection[] family() {
return values();
}
/**
* Returns the opposite direction of this axis. The opposite direction of {@linkplain #NORTH
* North} is {@linkplain #SOUTH South}, and the opposite direction of {@linkplain #SOUTH South}
* is {@linkplain #NORTH North}. The same applies to {@linkplain #EAST East}-{@linkplain #WEST
* West}, {@linkplain #UP Up}-{@linkplain #DOWN Down} and {@linkplain #FUTURE
* Future}-{@linkplain #PAST Past}, etc. If this axis direction has no opposite,
* then this method returns {@code null}.
*
* @return The opposite direction, or {@code null} if none or unknown.
*/
@Extension
public AxisDirection opposite() {
return opposite;
}
/**
* Returns the "absolute" direction of this axis. This "absolute" operation is similar to the
* {@code Math.abs(int)} method in that "negative" directions like ({@link #SOUTH}, {@link
* #WEST}, {@link #DOWN}, {@link #PAST}) are changed for their "positive" counterparts ({@link
* #NORTH}, {@link #EAST}, {@link #UP}, {@link #FUTURE}). More specifically, the following
* conversion table is applied:
*
*
*
*
*
* Direction
* Absolute value
*
* {@link #NORTH} {@link #NORTH} {@link #SOUTH} {@link #NORTH} {@link #EAST} {@link #EAST} {@link #WEST} {@link #EAST} {@link #UP} {@link #UP} {@link #DOWN} {@link #UP}
*
* Direction
* Absolute value
*
* {@link #DISPLAY_RIGHT} {@link #DISPLAY_RIGHT} {@link #DISPLAY_LEFT} {@link #DISPLAY_RIGHT} {@link #DISPLAY_UP} {@link #DISPLAY_UP} {@link #DISPLAY_DOWN} {@link #DISPLAY_UP} {@link #FUTURE} {@link #FUTURE} {@link #PAST} {@link #FUTURE}
* {@link #OTHER} {@link #OTHER}
*
* @return The direction from the above table.
*/
@Extension
public AxisDirection absolute() {
final AxisDirection opposite = this.opposite;
if (opposite != null) {
if (opposite.ordinal() < ordinal()) {
return opposite;
}
}
return this;
}
/**
* Returns the axis direction that matches the given string, or returns a new one if none match
* it.
*
* @param code The name of the code to fetch or to create.
* @return A code matching the given name.
*/
public static AxisDirection valueOf(String code) {
return valueOf(AxisDirection.class, code);
}
}