Package org.geotools.api.referencing.cs

Interface CoordinateSystemAxis

All Superinterfaces:

IdentifiedObject

All Known Implementing Classes:

DefaultCoordinateSystemAxis

public interface CoordinateSystemAxis
extends IdentifiedObject

Definition of a coordinate system axis. See axis name constraints.

Since:

GeoAPI 1.0

Author:

Martin Desruisseaux (IRD)

See Also:

CoordinateSystem, Unit

Field Summary

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

Modifier and Type	Method	Description
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 interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Method Detail

getAbbreviation

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".

Returns:

The coordinate system axis abbreviation.

getDirection

AxisDirection getDirection()

Direction of this coordinate system axis. In the case of Cartesian projected coordinates, this is the direction of this coordinate system axis locally. Examples: north or south, east or west, up or down. Within any set of coordinate system axes, only one of each pair of terms can be used. For earth-fixed coordinate reference systems, this direction is often approximate and intended to provide a human interpretable meaning to the axis. When a geodetic datum is used, the precise directions of the axes may therefore vary slightly from this approximate direction.

Note that an EngineeringCRS often requires specific descriptions of the directions of its coordinate system axes.

Returns:

The coordinate system axis direction.

getMinimumValue

double getMinimumValue()

Returns the minimum value normally allowed for this axis, in the unit of measure for the axis. If there is no minimum value, then this method returns negative infinity.

Returns:

The minimum value, or Double.NEGATIVE_INFINITY if none.

getMaximumValue

double getMaximumValue()

Returns the maximum value normally allowed for this axis, in the unit of measure for the axis. If there is no maximum value, then this method returns positive infinity.

Returns:

The maximum value, or Double.POSITIVE_INFINITY if none.

getRangeMeaning

RangeMeaning getRangeMeaning()

Returns the meaning of axis value range specified by the minimum and maximum values. This element shall be omitted when both minimum and maximum values are omitted. It may be included when minimum and/or maximum values are included. If this element is omitted when minimum or maximum values are included, the meaning is unspecified.

Returns:

The range meaning, or null in none.

getUnit

Unit<?> getUnit()

The unit of measure used for this coordinate system axis. The value of this coordinate in a coordinate tuple shall be recorded using this unit of measure, whenever those coordinates use a coordinate reference system that uses a coordinate system that uses this axis.

Returns:

The coordinate system axis unit.