Package org.geotools.styling

Enum UomOgcMapping

  • All Implemented Interfaces:
    Serializable, Comparable<UomOgcMapping>
    public enum UomOgcMapping
extends Enum<UomOgcMapping>
    Defines the Units of Measure (UOMs) specified by the OGC SE standard and their mappings to Java Units defined in javax.measure.unit. Each entry in this enum provides both the Java Unit for the given UOM and the corresponding String that is defined by the SE standard.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FOOT  
      METRE  
      PIXEL  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static UomOgcMapping get​(String seString)
      Returns the appropriate UOM mapping for a given OGC SE standard string.
      static UomOgcMapping get​(Unit<Length> unit)
      Returns the appropriate UOM mapping for a given Java Unit.
      String getSEString()
      Returns the String defined by the OGC SE specification for the unit of measure.
      Unit<Length> getUnit()
      Returns the Java Unit that corresponds to the unit of measure.
      String toString()  
      static UomOgcMapping valueOf​(String name)
      Returns the enum constant of this type with the specified name.
      static UomOgcMapping[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static UomOgcMapping[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (UomOgcMapping c : UomOgcMapping.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static UomOgcMapping valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • toString

        public String toString()
        Overrides:
        toString in class Enum<UomOgcMapping>

      • getSEString

        public String getSEString()
        Returns the String defined by the OGC SE specification for the unit of measure.
        Returns:
        a String that follows the OGC SE specification

      • getUnit

        public Unit<Length> getUnit()
        Returns the Java Unit that corresponds to the unit of measure.
        Returns:
        a Java Unit (e.g., SI.METRE).

      • get

        public static UomOgcMapping get​(String seString)
                         throws IllegalArgumentException
        Returns the appropriate UOM mapping for a given OGC SE standard string.
        Parameters:
        seString - a String that follows the OGC SE specification.
        Returns:
        the corresponding UnitOfMeasure.
        Throws:
        IllegalArgumentException - if the provided String is not a valid OGC SE value.

      • get

        public static UomOgcMapping get​(Unit<Length> unit)
                         throws IllegalArgumentException
        Returns the appropriate UOM mapping for a given Java Unit.
        Parameters:
        unit - a Java Unit (e.g., SI.METRE).
        Returns:
        the corresponding UnitOfMeasure.
        Throws:
        IllegalArgumentException - if the provided Unit is not part of the OGC SE specification.