Class AxisName

java.lang.Object
org.apache.sis.referencing.cs.AxisName

final class AxisName extends Object
Pattern of CoordinateSystemAxis together with resource to use for localized axis name.
Since:
1.3
Version:
1.3
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final AxisName[]
    Regular expressions for matching axis names.
    private final Pattern
    The pattern to compare with an axis name.
    private final short
    Key of localized word for the axis.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    AxisName(String regex, short word)
    Creates a new pattern for axis name.
  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) static String
    find(org.opengis.referencing.cs.CoordinateSystemAxis axis, Locale locale)
    Returns a short (if possible) localized name for the given axis.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • KEYWORDS

      private static final AxisName[] KEYWORDS
      Regular expressions for matching axis names.
    • pattern

      private final Pattern pattern
      The pattern to compare with an axis name.
    • word

      private final short word
      Key of localized word for the axis.
  • Constructor Details

    • AxisName

      private AxisName(String regex, short word)
      Creates a new pattern for axis name.
  • Method Details

    • find

      static String find(org.opengis.referencing.cs.CoordinateSystemAxis axis, Locale locale)
      Returns a short (if possible) localized name for the given axis. This method replaces names such as "Geodetic latitude" or "Geocentric latitude" by a simple "Latitude" word. This method can be used for example in column or row headers when the context is known and the space is rare.
      Parameters:
      axis - the axis for which to get a short label.
      locale - desired locale for the label.
      Returns:
      a relatively short axis label, in the desired locale if possible.