1 /***********************************************************************
2  * Copyright (c) 2019-2025 The MITRE Corporation
3  * This program and the accompanying materials are made available under
4  * the Apache License, Version 2.0 which is available at
5  * https://www.apache.org/licenses/LICENSE-2.0
6  * This software was produced for the U. S. Government under Basic
7  * Contract No. W56KGU-18-D-0004, and is subject to the Rights in
8  * Noncommercial Computer Software and Noncommercial Computer Software
9  * Documentation Clause 252.227-7014 (FEB 2012)
10  ***********************************************************************/
11 
12 package org.locationtech.geomesa.spark.sql
13 
14 import org.apache.spark.sql.{Column, Encoder, Encoders, TypedColumn}
15 import org.locationtech.geomesa.spark.jts.encoders.SpatialEncoders
16 import org.locationtech.geomesa.spark.jts.util.SQLFunctionHelper._
17 import org.locationtech.geomesa.spark.sql.GeometricDistanceFunctions.{ST_Transform, distanceNames}
18 import org.locationtech.jts.geom.Geometry
19 
20 import java.lang
21 
22 
23 /**
24  * DataFrame DSL functions for working with GeoTools
25  */
26 object DataFrameFunctions extends SpatialEncoders {
27 
28   implicit def integerEncoder: Encoder[Integer] = Encoders.INT
29   implicit def doubleEncoder: Encoder[Double] = Encoders.scalaDouble
30   implicit def jDoubleEncoder: Encoder[lang.Double] = Encoders.DOUBLE
31 
32   /**
33    * Group of DataFrame DSL functions associated with determining the relationship
34    * between geometries using GeoTools.
35    */
36   trait SpatialRelations {
37 
38     import org.locationtech.geomesa.spark.jts.udf.SpatialRelationFunctions._
39 
40     def st_distanceSpheroid(left: Column, right: Column): TypedColumn[Any, lang.Double] =
41       udfToColumn(ST_DistanceSphere, relationNames, left, right)
42 
43     def st_lengthSphere(line: Column): TypedColumn[Any, lang.Double] =
44       udfToColumn(ST_LengthSphere, relationNames, line)
45 
46     def st_transform(geom: Column, fromCRS: Column, toCRS: Column): TypedColumn[Any, Geometry] =
47       udfToColumn(ST_Transform, distanceNames, geom, fromCRS, toCRS)
48   }
49 
50   /** Stack of all DataFrame DSL functions. */
51   trait Library extends SpatialRelations
52 }