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>
,java.lang.constant.Constable
- 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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionMake both source and target CRS two-dimensional and search again in the database.If the source CRS is three-dimensional, make it two-dimensional and search again in database.If the target CRS is three-dimensional, make it two-dimensional and search again in database.Search for a coordinate operation with the CRS as specified, without any reduction. -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Decomposition
(boolean source, boolean target) Creates a new decomposition strategy. -
Method Summary
Modifier and TypeMethodDescription(package private) static org.opengis.referencing.crs.SingleCRS
horizontal
(org.opengis.referencing.crs.CoordinateReferenceSystem crs) Returns the horizontal component to search in the database, ornull
if no search should be done.Returns the enum constant of this type with the specified name.values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
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
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
Make both source and target CRS two-dimensional and search again in the database. This strategy should not be applied beforeHORIZONTAL_TARGET
because we want to use the z coordinate value to be used if possible. -
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 sourceWhether to extract the horizontal component of the source or target CRS. -
target
final boolean targetWhether 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
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
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 nameNullPointerException
- 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, ornull
if no search should be done. This method returnsnull
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 returnsnull
if the CRS is a compound CRS, in which case the the separation in single CRS should be done by theCoordinateOperationFinder
subclass.
-