1 /***********************************************************************
2  * Copyright (c) 2013-2024 Commonwealth Computer Research, Inc.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Apache License, Version 2.0
5  * which accompanies this distribution and is available at
6  * http://www.opensource.org/licenses/apache2.0.php.
7  ***********************************************************************/
8 
9 package org.locationtech.geomesa.index.utils
10 
11 import org.geotools.api.data.Query
12 import org.geotools.api.feature.simple.{SimpleFeature, SimpleFeatureType}
13 import org.geotools.api.referencing.crs.CoordinateReferenceSystem
14 import org.geotools.feature.FeatureTypes
15 import org.geotools.geometry.jts.GeometryCoordinateSequenceTransformer
16 import org.geotools.referencing.CRS
17 import org.locationtech.geomesa.features.ScalaSimpleFeature
18 import org.locationtech.geomesa.utils.geotools.SimpleFeatureTypes
19 import org.locationtech.jts.geom.Geometry
20 
21 /**
22   * Reproject the geometries in a simple feature to a different CRS
23   */
24 trait Reprojection {
25   def apply(feature: SimpleFeature): SimpleFeature
26 }
27 
28 object Reprojection {
29 
30   import org.locationtech.geomesa.index.conf.QueryHints.RichHints
31 
32   /**
33     * Create a reprojection function
34     *
35     * @param returnSft simple feature type being returned
36     * @param crs crs information from a query
37     * @return
38     */
39   def apply(returnSft: SimpleFeatureType, crs: QueryReferenceSystems): Reprojection = {
40     if (crs.target != crs.user) {
41       val transformer = new GeometryCoordinateSequenceTransformer
42       transformer.setMathTransform(CRS.findMathTransform(crs.user, crs.target, true))
43       val transformed = FeatureTypes.transform(returnSft, crs.target) // note: drops user data
44       new TransformReprojection(SimpleFeatureTypes.immutable(transformed, returnSft.getUserData), transformer)
45     } else if (crs.user != crs.native) {
46       val transformed = FeatureTypes.transform(returnSft, crs.user) // note: drops user data
47       new UserReprojection(SimpleFeatureTypes.immutable(transformed, returnSft.getUserData))
48     } else {
49       throw new IllegalArgumentException(s"Trying to reproject to the same CRS: $crs")
50     }
51   }
52 
53   /**
54     * Holds query projection info
55     *
56     * @param native native crs of the data
57     * @param user user crs for the query (data will be treated as this crs but without any transform)
58     * @param target target crs for the query (data will be transformed to this crs)
59     */
60   case class QueryReferenceSystems(
61       native: CoordinateReferenceSystem,
62       user: CoordinateReferenceSystem,
63       target: CoordinateReferenceSystem)
64 
65   object QueryReferenceSystems {
66     def apply(query: Query): Option[QueryReferenceSystems] = {
67       Option(query.getHints.getReturnSft.getGeometryDescriptor).flatMap { descriptor =>
68         val native = descriptor.getCoordinateReferenceSystem
69         val source = Option(query.getCoordinateSystem).getOrElse(native)
70         val target = Option(query.getCoordinateSystemReproject).getOrElse(native)
71         if (target == source && source == native) { None } else {
72           Some(QueryReferenceSystems(native, source, target))
73         }
74       }
75     }
76   }
77 
78   /**
79     * Applies a geometric transform to any geometry attributes
80     *
81     * @param sft simple feature type being projected to
82     * @param transformer transformer
83     */
84   private class TransformReprojection(sft: SimpleFeatureType, transformer: GeometryCoordinateSequenceTransformer)
85       extends Reprojection {
86     override def apply(feature: SimpleFeature): SimpleFeature = {
87       val values = Array.tabulate(sft.getAttributeCount) { i =>
88         feature.getAttribute(i) match {
89           case g: Geometry => transformer.transform(g)
90           case a => a
91         }
92       }
93       new ScalaSimpleFeature(sft, feature.getID, values, feature.getUserData)
94     }
95   }
96 
97   /**
98     * Changes the defined crs but does not do any actual geometric transforms
99     *
100     * @param sft simple feature type being projected to
101     */
102   private class UserReprojection(sft: SimpleFeatureType) extends Reprojection {
103     override def apply(feature: SimpleFeature): SimpleFeature = ScalaSimpleFeature.copy(sft, feature)
104   }
105 }