- All Implemented Interfaces:
public class DefaultCoordinateSystemAxis extends AbstractIdentifiedObject implements CoordinateSystemAxis
Coordinate system axis name, direction, unit and range of values.
Axis namesIn some case, the axis name is constrained by ISO 19111 depending on the coordinate reference system type. This constraint works in two directions. For example the names "geodetic latitude" and "geodetic longitude" shall be used to designate the coordinate axis names associated with a
GeographicCRS. Conversely, these names shall not be used in any other context. See the GeoAPI
CoordinateSystemAxisjavadoc for more information.
Immutability and thread safetyThis class is immutable and thus thread-safe if the property values (not necessarily the map itself) given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.
Field SummaryModifier and TypeFieldDescriptionKey for the
"maximumValue"property to be given to the constructor.Key for the
"minimumValue"property to be given to the constructor.Key for the
"rangeMeaning"property to be given to the constructor.
(Map<String, ?> properties, String abbreviation, AxisDirection direction, Unit<?> unit)Constructs an axis from a set of properties.
protectedCreates a new coordinate system axis with the same values than the specified one.
Method SummaryModifier and TypeMethodDescriptionReturns a SIS axis implementation with the same values than the given arbitrary implementation.
protected longInvoked by
hashCode()for computing the hash code when first needed.
booleanCompares the specified object with this axis for equality.
protected StringFormats this axis as a Well Known Text
Axis[…]element.Returns the abbreviation used for this coordinate system axes.Returns the direction of this coordinate system axis.Returns the GeoAPI interface implemented by this class.
doubleReturns the maximum value normally allowed for this axis, in the unit of measure for the axis.
doubleReturns the minimum value normally allowed for this axis, in the unit of measure for the axis.
getUnit()Returns the unit of measure used for this coordinate system axis.
Methods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
MINIMUM_VALUE_KEYpublic static final String MINIMUM_VALUE_KEYKey for the
"minimumValue"property to be given to the constructor. This is used for setting the value to be returned by
- See Also:
MAXIMUM_VALUE_KEYpublic static final String MAXIMUM_VALUE_KEYKey for the
"maximumValue"property to be given to the constructor. This is used for setting the value to be returned by
- See Also:
RANGE_MEANING_KEYpublic static final String RANGE_MEANING_KEYKey for the
"rangeMeaning"property to be given to the constructor. This is used for setting the value to be returned by
- See Also:
(Map<String, ?> properties, String abbreviation, AxisDirection direction, Unit<?> unit)Constructs an axis from a set of properties. The properties given in argument follow the same rules than for the super-class constructor. Additionally, the following properties are understood by this constructor: Recognized properties (non exhaustive list) Property name Value type Returned by "minimumValue"
Defined in parent class (reminder) "name"
CharSequence(optionally as array)
ReferenceIdentifier(optionally as array)
propertiesmap are considered ignorable metadata (except the axis name) while information provided as explicit arguments may have an impact on coordinate transformation results. Exceptions to this rule are the
maximumValuein the particular case where
If no minimum, maximum and range meaning are specified, then this constructor will infer them from the axis unit and direction.
properties- the properties to be given to the identified object.
abbreviation- the abbreviation used for this coordinate system axis.
direction- the direction of this coordinate system axis.
unit- the unit of measure used for this coordinate system axis.
- See Also:
(CoordinateSystemAxis axis)Creates a new coordinate system axis with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API.
This constructor performs a shallow copy, i.e. the properties are not cloned.
axis- the coordinate system axis to copy.
- See Also:
castOrCopyReturns a SIS axis implementation with the same values than the given arbitrary implementation. If the given object is
null, then this method returns
null. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the values of the given object.
object- the object to get as a SIS implementation, or
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
getInterfaceReturns the GeoAPI interface implemented by this class. The SIS implementation returns
CoordinateSystemAxis.class.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not define
CoordinateSystemAxissub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.
getDirectionpublic AxisDirection getDirection()Returns the direction of this coordinate system axis. This direction is often approximate and intended to provide a human interpretable meaning to the axis. A coordinate system can not contain two axes having the same direction or opposite directions.
getAbbreviationpublic String getAbbreviation()Returns the abbreviation used for this coordinate system axes. Examples are "X" and "Y".
getUnitpublic Unit<?> getUnit()Returns the unit of measure used for this coordinate system axis. If this
CoordinateSystemAxiswas given by
, then all coordinate values at dimension i in a coordinate tuple shall be recorded using this unit of measure.
getMinimumValuepublic 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.
getMaximumValuepublic 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 negative infinity.
getRangeMeaningpublic RangeMeaning getRangeMeaning()Returns the meaning of axis value range specified by the minimum and maximum values. If there is no minimum and maximum values (i.e. if those values are negative infinity and positive infinity respectively), then this method returns
isHeuristicMatchForNamepublic boolean isHeuristicMatchForName
trueif either the primary name or at least one alias matches the given string according heuristic rules. This method performs the comparison documented in the
super-class, with an additional flexibility for latitudes and longitudes:
"Geodetic latitude"are considered equivalent.
"Geodetic longitude"are considered equivalent.
Future evolutionsThis method implements heuristic rules learned from experience while trying to provide inter-operability with different data producers. Those rules may be adjusted in any future SIS version according experience gained while working with more data producers.
name- the name to compare.
trueif the primary name of at least one alias matches the specified
- See Also:
equalsCompares the specified object with this axis for equality. The strictness level is controlled by the second argument. This method compares the following properties in every cases:
getMaximumValue()are considered non-ignorable metadata and will be compared for every modes. All other properties are compared only for modes stricter than
- Specified by:
object- the object to compare to
STRICTfor performing a strict comparison, or
IGNORE_METADATAfor comparing only properties relevant to coordinate transformations.
trueif both objects are equal.
- See Also:
computeHashCodeprotected long computeHashCode()Invoked by
hashCode()for computing the hash code when first needed. See
AbstractIdentifiedObject.computeHashCode()for more information.
formatToFormats this axis as a Well Known Text
Constraints for WKT validityThe ISO 19162 specification puts many constraints on axis names, abbreviations and directions allowed in WKT. Most of those constraints are inherited from ISO 19111 — see
CoordinateSystemAxisjavadoc for some of those. The current Apache SIS implementation does not verify whether this axis name and abbreviation are compliant; we assume that the user created a valid axis. The only actions (derived from ISO 19162 rules) taken by this method (by default) are:
- Replace “Geodetic latitude” and “Geodetic longitude” names (case insensitive) by “latitude” and “longitude” respectively.
- For latitude and longitude axes, replace “φ” and “λ” abbreviations by “B” and “L” respectively (from German “Breite” and “Länge”, used in academic texts worldwide). Note that “L” is also the transliteration of Greek letter “lambda” (λ).
SphericalCS, replace “φ” and “θ” abbreviations by “U” and “V” respectively.
PolarCS, replace “θ” abbreviation by “U”.