org.opengis.example.referencing
Class SimpleAxis

Show UML class diagram

Object
  SimpleIdentifiedObject
      SimpleAxis

All Implemented Interfaces:

Serializable, Identifier, CoordinateSystemAxis, IdentifiedObject, ReferenceIdentifier

public class SimpleAxis
extends SimpleIdentifiedObject
implements CoordinateSystemAxis

A CoordinateSystemAxis defined by conventional symbols. This implementation infers some axis properties from the abbreviation, as documented in the following table:

Symbol	Common name	Axis direction	Unit	Range	Meaning
λ	geodetic longitude	EAST	NonSI.DEGREE_ANGLE	±90°	EXACT
φ	geodetic latitude	NORTH	NonSI.DEGREE_ANGLE	±180°	WRAPAROUND
h	ellipsoidal height	UP	SI.METRE
H	gravity-related height	UP	SI.METRE
d	depth	DOWN	SI.METRE
r	geocentric radius	UP	SI.METRE	[0…∞]
Ω	spherical longitude	EAST	NonSI.DEGREE_ANGLE	±90°	EXACT
Θ	spherical latitude	NORTH	NonSI.DEGREE_ANGLE	±180°	WRAPAROUND
X	geocentric X	GEOCENTRIC_X	SI.METRE
Y	geocentric Y	GEOCENTRIC_Y	SI.METRE
Z	geocentric Z	GEOCENTRIC_Z	SI.METRE
E	easting	EAST	SI.METRE
W	westing	WEST	SI.METRE
N	northing	NORTH	SI.METRE
S	southing	SOUTH	SI.METRE
t	time	FUTURE	SI.SECOND
i	column	COLUMN_POSITIVE	Unit.ONE
j	row	ROW_POSITIVE	Unit.ONE

Since:

3.1

See Also:

Serialized Form

Field Summary

protected char	abbreviation The abbreviation used for this coordinate system axes.
protected AxisDirection	direction Direction of this coordinate system axis.
static CoordinateSystemAxis	LATITUDE The geodetic latitude axis.
static CoordinateSystemAxis	LONGITUDE The geodetic longitude axis.
protected Unit<?>	unit The unit of measure used for this coordinate system axis.

Fields inherited from class SimpleIdentifiedObject

authority, code

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface ReferenceIdentifier

CODESPACE_KEY, VERSION_KEY

Fields inherited from interface Identifier

AUTHORITY_KEY, CODE_KEY

Constructor Summary

SimpleAxis(Citation authority, String name, char abbreviation)
Creates a new axis for the given authority, name and abbreviation.

SimpleAxis(Citation authority, String name, char abbreviation, AxisDirection direction, Unit<?> unit)
Creates a new axis for the given authority, name, units and direction.

Method Summary

boolean	equals(Object object) Compares this axis with the given object for equality.
String	getAbbreviation() The abbreviation used for this coordinate system axes.
AxisDirection	getDirection() Direction of this coordinate system axis.
double	getMaximumValue() Returns the maximum value normally allowed for this axis, in the unit of measure for the axis.
double	getMinimumValue() Returns the minimum value normally allowed for this axis, in the unit of measure for the axis.
RangeMeaning	getRangeMeaning() Returns the meaning of axis value range specified by the minimum and maximum values.
Unit<?>	getUnit() The unit of measure used for this coordinate system axis.

Methods inherited from class SimpleIdentifiedObject

getAlias, getAuthority, getCode, getCodeSpace, getDomainOfValidity, getIdentifiers, getName, getRemarks, getScope, getVersion, hashCode, toString, toWKT

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

LATITUDE

public static final CoordinateSystemAxis LATITUDE

The geodetic latitude axis. Values are increasing toward East, in decimal degrees.

LONGITUDE

public static final CoordinateSystemAxis LONGITUDE

The geodetic longitude axis. Values are increasing toward North, in decimal degrees.

abbreviation

protected final char abbreviation

The abbreviation used for this coordinate system axes. This abbreviation is also used to identify the ordinates in coordinate tuple. Examples are "X" and "Y".

See Also:

getAbbreviation()

direction

protected final AxisDirection direction

Direction of this coordinate system axis.

See Also:

getDirection()

unit

protected final Unit<?> unit

The unit of measure used for this coordinate system axis.

See Also:

getUnit()

Constructor Detail

SimpleAxis

public SimpleAxis(Citation authority,
                  String name,
                  char abbreviation)
           throws IllegalArgumentException

Creates a new axis for the given authority, name and abbreviation. The axis direction and units are inferred from the abbreviation using the table documented in the class javadoc.

Parameters:

authority - Organization responsible for definition of the name, or null.

name - The name of the new axis.

abbreviation - The abbreviation used for this coordinate system axes.

Throws:

IllegalArgumentException - If the abbreviation is not one of the documented ones.

SimpleAxis

public SimpleAxis(Citation authority,
                  String name,
                  char abbreviation,
                  AxisDirection direction,
                  Unit<?> unit)

Creates a new axis for the given authority, name, units and direction. The following abbreviation are handled specially by this class:

• λ for geodetic longitude
• φ for geodetic latitude
• Ω for spherical longitude
• Θ for spherical latitude
• r for geocentric radius

Parameters:

authority - Organization responsible for definition of the name, or null.

name - The name of the new axis.

abbreviation - The abbreviation used for this coordinate system axes.

direction - Direction of this coordinate system axis.

unit - The unit of measure used for this coordinate system axis.

Method Detail

getAbbreviation

public String getAbbreviation()

The abbreviation used for this coordinate system axes. This abbreviation is also used to identify the ordinates in coordinate tuple. Examples are "X" and "Y".

Specified by:

getAbbreviation in interface CoordinateSystemAxis

getDirection

public AxisDirection getDirection()

Direction of this coordinate system axis.

Specified by:

getDirection in interface CoordinateSystemAxis

getMinimumValue

public double getMinimumValue()

Returns the minimum value normally allowed for this axis, in the unit of measure for the axis. The default implementation infers the value from the abbreviation symbol:

• 0 for r
• -90 for φ and Θ
• -180 for λ and Ω
• NEGATIVE_INFINITY for all other abbreviations

Specified by:

getMinimumValue in interface CoordinateSystemAxis

getMaximumValue

public double getMaximumValue()

Returns the maximum value normally allowed for this axis, in the unit of measure for the axis. The default implementation infers the value from the abbreviation symbol:

• 90 for φ and Θ
• 180 for λ and Ω
• POSITIVE_INFINITY for all other abbreviations

Specified by:

getMaximumValue in interface CoordinateSystemAxis

getRangeMeaning

public RangeMeaning getRangeMeaning()

Returns the meaning of axis value range specified by the minimum and maximum values. The default implementation infers the value from the abbreviation symbol:

• EXACT for φ and Θ
• WRAPAROUND for λ and Ω
• null for all other abbreviations

Specified by:

getRangeMeaning in interface CoordinateSystemAxis

getUnit

public Unit<?> getUnit()

The unit of measure used for this coordinate system axis.

Specified by:

getUnit in interface CoordinateSystemAxis

equals

public boolean equals(Object object)

Compares this axis with the given object for equality.

Overrides:

equals in class SimpleIdentifiedObject

Parameters:

object - The object to compare with this SimpleCRS.

Returns:

true if the given object is equals to this object.