Package org.apache.sis.referencing.operation

Enum CoordinateOperationRegistry.Decomposition

java.lang.Object
java.lang.Enum<CoordinateOperationRegistry.Decomposition>
org.apache.sis.referencing.operation.CoordinateOperationRegistry.Decomposition
All Implemented Interfaces:
Serializable, Comparable<CoordinateOperationRegistry.Decomposition>
Enclosing class:
CoordinateOperationRegistry
private static enum CoordinateOperationRegistry.Decomposition extends Enum<CoordinateOperationRegistry.Decomposition>
Strategies for decomposing a three-dimensional CRS into components that may be present in EPSG database. The database may have no entries for a coordinate operation between a pair of 3D CRS with (x,y,z) axes, while entries for the horizontal components (2D CRS with (x,y) axes) may exist. This class enumerates which decompositions to apply on the 3D CRS before searching in EPSG database. Those decompositions will be applied in the order they are enumerated.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    HORIZONTAL
    Make both source and target CRS two-dimensional and search again in the database.
    HORIZONTAL_SOURCE
    If the source CRS is three-dimensional, make it two-dimensional and search again in database.
    HORIZONTAL_TARGET
    If the target CRS is three-dimensional, make it two-dimensional and search again in database.
    NONE
    Search for a coordinate operation with the CRS as specified, without any reduction.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) final boolean
    source
    Whether to extract the horizontal component of the source or target CRS.
    (package private) final boolean
    target
    Whether to extract the horizontal component of the source or target CRS.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Decomposition(boolean source, boolean target)
    Creates a new decomposition strategy.

  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) static org.opengis.referencing.crs.SingleCRS
    horizontal(org.opengis.referencing.crs.CoordinateReferenceSystem crs)
    Returns the horizontal component to search in the database, or null if no search should be done.
    static CoordinateOperationRegistry.Decomposition
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static CoordinateOperationRegistry.Decomposition[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final CoordinateOperationRegistry.Decomposition NONE
      Search for a coordinate operation with the CRS as specified, without any reduction. It should be the first strategy to try before anything else.

    • HORIZONTAL_TARGET

      public static final CoordinateOperationRegistry.Decomposition HORIZONTAL_TARGET
      If the target CRS is three-dimensional, make it two-dimensional and search again in database. The source CRS is left as-is; it may be two- or three-dimensional. This strategy avoid the last of source coordinates since they may be used in calculation.

    • HORIZONTAL

      public static final CoordinateOperationRegistry.Decomposition HORIZONTAL
      Make both source and target CRS two-dimensional and search again in the database. This strategy should not be applied before HORIZONTAL_TARGET because we want to use the z coordinate value to be used if possible.

    • HORIZONTAL_SOURCE

      public static final CoordinateOperationRegistry.Decomposition HORIZONTAL_SOURCE
      If the source CRS is three-dimensional, make it two-dimensional and search again in database. The target CRS is left as-is; it may be two- or three-dimensional. This strategy is rarely applicable because it would cause the z coordinate value to appear from nowhere, but we nevertheless test it as a matter of principle.

  • Field Details

    • source

      final boolean source
      Whether to extract the horizontal component of the source or target CRS.

    • target

      final boolean target
      Whether to extract the horizontal component of the source or target CRS.

  • Constructor Details

    • Decomposition

      private Decomposition(boolean source, boolean target)
      Creates a new decomposition strategy.

  • Method Details

    • values

      public static CoordinateOperationRegistry.Decomposition[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static CoordinateOperationRegistry.Decomposition 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

    • horizontal

      static org.opengis.referencing.crs.SingleCRS horizontal(org.opengis.referencing.crs.CoordinateReferenceSystem crs)
      Returns the horizontal component to search in the database, or null if no search should be done. This method returns null if the horizontal component is not different then the given CRS, in which case searching that CRS in the database would be redundant with previous searches. It also returns null if the CRS is a compound CRS, in which case the the separation in single CRS should be done by the CoordinateOperationFinder subclass.