org.geolatte.geom.crs

Class CoordinateSystemAxis

java.lang.Object

org.geolatte.geom.crs.CoordinateSystemAxis

Direct Known Subclasses:

EllipsoidalAxis, StraightLineAxis

public abstract class CoordinateSystemAxis
extends java.lang.Object

An axis of a CoordinateSystem.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	axisName
private CoordinateSystemAxisDirection	coordinateSystemAxisDirection
private int	normalOrder
private Unit	unit

Constructor Summary

Constructors

Constructor and Description
CoordinateSystemAxis(java.lang.String axisName, CoordinateSystemAxisDirection coordinateSystemAxisDirection, int normalOrder, Unit unit) Creates an instance with
CoordinateSystemAxis(java.lang.String axisName, CoordinateSystemAxisDirection coordinateSystemAxisDirection, Unit unit) Creates an instance

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
CoordinateSystemAxisDirection	getAxisDirection()
java.lang.String	getAxisName() Returns the name of this axis.
int	getNormalOrder() Indicates the position for the Axis in the normalized order of axes.
Unit	getUnit()
int	hashCode()
static GeodeticLatitudeCSAxis	mkLatAxis()
static GeodeticLongitudeCSAxis	mkLonAxis()
static StraightLineAxis	mkXAxis()
static StraightLineAxis	mkYAxis()
static StraightLineAxis	mkZAxis()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

axisName

private final java.lang.String axisName

coordinateSystemAxisDirection

private final CoordinateSystemAxisDirection coordinateSystemAxisDirection

unit

private final Unit unit

normalOrder

private final int normalOrder

Constructor Detail

CoordinateSystemAxis

CoordinateSystemAxis(java.lang.String axisName,
                     CoordinateSystemAxisDirection coordinateSystemAxisDirection,
                     Unit unit)

Creates an instance

Parameters:

axisName - the name for this axis

coordinateSystemAxisDirection - the direction for this axis

unit - the unit of this axis

CoordinateSystemAxis

CoordinateSystemAxis(java.lang.String axisName,
                     CoordinateSystemAxisDirection coordinateSystemAxisDirection,
                     int normalOrder,
                     Unit unit)

Creates an instance with

Parameters:

axisName - the name for this axis

coordinateSystemAxisDirection - the direction for this axis

unit - the unit of this axis

Method Detail

mkLonAxis

public static GeodeticLongitudeCSAxis mkLonAxis()

mkLatAxis

public static GeodeticLatitudeCSAxis mkLatAxis()

mkXAxis

public static StraightLineAxis mkXAxis()

mkYAxis

public static StraightLineAxis mkYAxis()

mkZAxis

public static StraightLineAxis mkZAxis()

getAxisName

public java.lang.String getAxisName()

Returns the name of this axis.

Returns:

getAxisDirection

public CoordinateSystemAxisDirection getAxisDirection()

getUnit

public Unit getUnit()

getNormalOrder

public int getNormalOrder()

Indicates the position for the Axis in the normalized order of axes.

The coordinates of Positions in a specific CoordinateSystem needs to respect this invariant: if the axes are sorted according to their normalOrder property, then this gives the order in which the corresponding coordinate elements are stored in the position.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object