org.geolatte.geom.crs

Class CoordinateSystem<P extends Position>

java.lang.Object

org.geolatte.geom.crs.CoordinateSystem<P>

Type Parameters:

P - the Position type for the system

Direct Known Subclasses:

CartesianCoordinateSystem2D, CartesianCoordinateSystem2DM, CartesianCoordinateSystem3D, CartesianCoordinateSystem3DM, EllipsoidalCoordinateSystem2D, EllipsoidalCoordinateSystem2DM, EllipsoidalCoordinateSystem3D, EllipsoidalCoordinateSystem3DM, OneDimensionCoordinateSystem

public abstract class CoordinateSystem<P extends Position>
extends java.lang.Object

A coordinate system.

A coordinate system is characterized by its CoordinateSystemAxes (in order).

Field Summary

Fields

Modifier and Type	Field and Description
private CoordinateSystemAxis[]	axes

Constructor Summary

Constructors

Constructor and Description
CoordinateSystem(CoordinateSystemAxis... axes) Constructs a CoordinateSystem.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
abstract CoordinateSystem<?>	extend(CoordinateSystemAxis axis) Create a new coordinate system with the axes of this system plus the specified axis
CoordinateSystemAxis[]	getAxes() Returns the CoordinateSystemAxes of this CoordinateSystem (in order).
CoordinateSystemAxis	getAxis(int index) Returns the CoordinateSystemAxis at the specified position.
java.util.List<CoordinateSystemAxisDirection>	getAxisDirections() Returns a list of all the directions of this systems
CoordinateSystemAxis	getAxisForComponentIndex(int i) Return the axis that corresponds to the i-th element in the coordinates for a Position in this CoordinateSystem.
int	getAxisIndex(CoordinateSystemAxis axis) Returns the position of the specified CoordinateSystemAxis in this CoordinateSystem, or -1 if it is not an axis of this instance.
java.util.List<java.lang.Integer>	getAxisNormalOrder() Returns the normal order value for the axes of this systems in the order that the axes have been defined for this system.
Unit	getAxisUnit(int index) Returns the Unit of the axis at the specified position.
int	getCoordinateDimension() Returns the coordinate dimension, i.e.
abstract java.lang.Class<P>	getPositionClass()
int	hashCode()
abstract CoordinateSystem<?>	merge(OneDimensionCoordinateSystem<?> coordinateSystem) Create a coordinate system that merges this instance with the specified system

Methods inherited from class java.lang.Object

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

Field Detail

axes

private final CoordinateSystemAxis[] axes

Constructor Detail

CoordinateSystem

public CoordinateSystem(CoordinateSystemAxis... axes)

Constructs a CoordinateSystem.

CoordinateSystems are characterized by their CoordinateSystemAxes.

Parameters:

axes - the sequence (at least two) of its CoordinateSystems.

Throws:

java.lang.IllegalArgumentException - when less than two axes are specified, or when an argument is null.

Method Detail

getPositionClass

public abstract java.lang.Class<P> getPositionClass()

getAxes

public CoordinateSystemAxis[] getAxes()

Returns the CoordinateSystemAxes of this CoordinateSystem (in order).

Returns:

getAxisDirections

public java.util.List<CoordinateSystemAxisDirection> getAxisDirections()

Returns a list of all the directions of this systems

Returns:

a List of Coordinate system axis directions.

getAxisNormalOrder

public java.util.List<java.lang.Integer> getAxisNormalOrder()

Returns the normal order value for the axes of this systems in the order that the axes have been defined for this system.

Returns:

a List of Coordinate system axis directions.

getCoordinateDimension

public int getCoordinateDimension()

Returns the coordinate dimension, i.e. the number of axes in this coordinate system.

Returns:

getAxisIndex

public int getAxisIndex(CoordinateSystemAxis axis)

Returns the position of the specified CoordinateSystemAxis in this CoordinateSystem, or -1 if it is not an axis of this instance.

Parameters:

axis -

Returns:

getAxisForComponentIndex

public CoordinateSystemAxis getAxisForComponentIndex(int i)

Return the axis that corresponds to the i-th element in the coordinates for a Position in this CoordinateSystem.

Parameters:

i - the 0-base index for a coordinate

Returns:

the axis

Throws:

java.lang.IndexOutOfBoundsException - if i > getCoordinateDimension() - 1

getAxis

public CoordinateSystemAxis getAxis(int index)

Returns the CoordinateSystemAxis at the specified position.

Parameters:

index -

Returns:

getAxisUnit

public Unit getAxisUnit(int index)

Returns the Unit of the axis at the specified position.

Parameters:

index -

Returns:

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

merge

public abstract CoordinateSystem<?> merge(OneDimensionCoordinateSystem<?> coordinateSystem)

Create a coordinate system that merges this instance with the specified system

Parameters:

coordinateSystem - the system to merge with

Returns:

a new CoordinateSystem

Throws:

java.lang.UnsupportedOperationException - if no supported coordinate system can represent the merge

extend

public abstract CoordinateSystem<?> extend(CoordinateSystemAxis axis)

Create a new coordinate system with the axes of this system plus the specified axis

Parameters:

axis - the additional axis

Returns:

a new CoordinateSystem

Throws:

java.lang.UnsupportedOperationException - if no supported coordinate system can contain the axes.