Merge pull request #2 from mjohns-databricks/jts-default

More adjustments to JTS default
a0x8o · Jun 16, 2023 · a0c5a28 · a0c5a28
2 parents d85515c + c42f263
commit a0c5a28
Show file tree

Hide file tree

Showing 19 changed files with 39 additions and 39 deletions.
diff --git a/R/sparkR-mosaic/enableMosaic.R b/R/sparkR-mosaic/enableMosaic.R
@@ -2,7 +2,7 @@
 #' 
 #' @description enableMosaic activates the context dependent Databricks Mosaic functions, giving control over the geometry API and index system used.
 #' See \url{https://databrickslabs.github.io/mosaic/} for full documentation
-#' @param geometryAPI character, default="ESRI"
+#' @param geometryAPI character, default="JTS"
 #' @param indexSystem character, default="H3"
 #' @param indexSystem boolean, default=F
 #' @name enableMosaic
@@ -12,10 +12,10 @@
 #' @examples
 #' \dontrun{
 #' enableMosaic()
-#' enableMosaic("ESRI", "H3")
-#' enableMosaic("ESRI", "BNG") }
+#' enableMosaic("JTS", "H3")
+#' enableMosaic("JTS", "BNG") }
 enableMosaic <- function(
-  geometryAPI="ESRI"
+  geometryAPI="JTS"
   ,indexSystem="H3"
   ,rasterAPI="GDAL"
 ){

diff --git a/R/sparklyr-mosaic/enableMosaic.R b/R/sparklyr-mosaic/enableMosaic.R
@@ -3,7 +3,7 @@
 #' @description enableMosaic activates the context dependent Databricks Mosaic functions, giving control over the geometry API and index system used.
 #' See \url{https://databrickslabs.github.io/mosaic/} for full documentation
 #' @param sc sparkContext
-#' @param geometryAPI character, default="ESRI"
+#' @param geometryAPI character, default="JTS"
 #' @param indexSystem character, default="H3"
 #' @name enableMosaic
 #' @rdname enableMosaic
@@ -12,12 +12,12 @@
 #' @examples
 #' \dontrun{
 #' enableMosaic()
-#' enableMosaic("ESRI", "H3")
-#' enableMosaic("ESRI", "BNG")}
+#' enableMosaic("JTS", "H3")
+#' enableMosaic("JTS", "BNG")}
 
 enableMosaic <- function(
     sc
-    ,geometryAPI="ESRI"
+    ,geometryAPI="JTS"
     ,indexSystem="H3"
     ,rasterAPI="GDAL"
 ){

diff --git a/docs/code-example-notebooks/setup/setup-scala.scala b/docs/code-example-notebooks/setup/setup-scala.scala
@@ -1,10 +1,10 @@
 // Databricks notebook source
 import org.apache.spark.sql.functions._
 import com.databricks.labs.mosaic.functions.MosaicContext
-import com.databricks.labs.mosaic.ESRI
+import com.databricks.labs.mosaic.JTS
 import com.databricks.labs.mosaic.H3
 
-val mosaicContext: MosaicContext = MosaicContext.build(H3, ESRI)
+val mosaicContext: MosaicContext = MosaicContext.build(H3, JTS)
 
 // COMMAND ----------
 

diff --git a/docs/source/api/spatial-functions.rst b/docs/source/api/spatial-functions.rst
@@ -949,7 +949,7 @@ st_isvalid
     +---------------+
 
 .. note:: Validity assertions will be dependent on the chosen geometry API.
-    The assertions used in the ESRI geometry API (the default) follow the definitions in the
+    The assertions used in the ESRI geometry API (JTS is the default) follow the definitions in the
     "Simple feature access - Part 1" document (OGC 06-103r4) for each geometry type.
 
 

diff --git a/docs/source/models/spatial-knn.rst b/docs/source/models/spatial-knn.rst
@@ -157,9 +157,9 @@ The transformer is called SpatialKNN and it is used as follows:
     import com.databricks.labs.mosaic.models.knn.SpatialKNN
     import com.databricks.labs.mosaic.functions.MosaicContext
     import com.databricks.labs.mosaic.H3
-    import com.databricks.labs.mosaic.ESRI
+    import com.databricks.labs.mosaic.JTS
     >>>
-    val mosaicContext = MosaicContext.build(H3, ESRI)
+    val mosaicContext = MosaicContext.build(H3, JTS)
     import mosaicContext.functions._
     mosaicContext.register(spark)
     >>>
@@ -328,9 +328,9 @@ These datasets are not serialised with the model, and neither are the model outp
     import com.databricks.labs.mosaic.models.knn.SpatialKNN
     import com.databricks.labs.mosaic.functions.MosaicContext
     import com.databricks.labs.mosaic.H3
-    import com.databricks.labs.mosaic.ESRI
+    import com.databricks.labs.mosaic.JTS
     >>>
-    val mosaicContext = MosaicContext.build(H3, ESRI)
+    val mosaicContext = MosaicContext.build(H3, JTS)
     import mosaicContext.functions._
     mosaicContext.register(spark)
     >>>

diff --git a/docs/source/usage/automatic-sql-registration.rst b/docs/source/usage/automatic-sql-registration.rst
@@ -60,7 +60,7 @@ To install Mosaic on your Databricks cluster, take the following steps:
         spark.databricks.labs.mosaic.index.system H3
         # JTS or ESRI
         spark.databricks.labs.mosaic.geometry.api JTS
-        # MosaicSQL or MosaicSQLDefault, MosaicSQLDefault corresponds to (H3, ESRI)
+        # MosaicSQL or MosaicSQLDefault, MosaicSQLDefault corresponds to (H3, JTS)
         spark.sql.extensions com.databricks.labs.mosaic.sql.extensions.MosaicSQL
 
 Testing

diff --git a/docs/source/usage/grid-indexes-bng.rst b/docs/source/usage/grid-indexes-bng.rst
@@ -34,15 +34,15 @@ configurations. Spark provides an easy way to supply configuration parameters us
    .. code-tab:: scala
 
     import com.databricks.labs.mosaic.functions.MosaicContext
-    import com.databricks.labs.mosaic.{BNG, ESRI}
+    import com.databricks.labs.mosaic.{BNG, JTS}
 
-    val mosaicContext = MosaicContext.build(BNG, ESRI)
+    val mosaicContext = MosaicContext.build(BNG, JTS)
     import mosaicContext.functions._
 
    .. code-tab:: r R
 
     library(sparkrMosaic)
-    enableMosaic("ESRI", "BNG")
+    enableMosaic("JTS", "BNG")
 
    .. code-tab:: sql
 

diff --git a/docs/source/usage/installation.rst b/docs/source/usage/installation.rst
@@ -70,9 +70,9 @@ The mechanism for enabling the Mosaic functions varies by language:
 
     import com.databricks.labs.mosaic.functions.MosaicContext
     import com.databricks.labs.mosaic.H3
-    import com.databricks.labs.mosaic.ESRI
+    import com.databricks.labs.mosaic.JTS
 
-    val mosaicContext = MosaicContext.build(H3, ESRI)
+    val mosaicContext = MosaicContext.build(H3, JTS)
     import mosaicContext.functions._
 
    .. code-tab:: r R
@@ -90,8 +90,8 @@ register the Mosaic SQL functions in your SparkSession from a Scala notebook cel
 
     import com.databricks.labs.mosaic.functions.MosaicContext
     import com.databricks.labs.mosaic.H3
-    import com.databricks.labs.mosaic.ESRI
+    import com.databricks.labs.mosaic.JTS
 
-    val mosaicContext = MosaicContext.build(H3, ESRI)
+    val mosaicContext = MosaicContext.build(H3, JTS)
     mosaicContext.register(spark)
 
diff --git a/notebooks/examples/python/Ship2ShipTransfers/01. Data Prep.py b/notebooks/examples/python/Ship2ShipTransfers/01. Data Prep.py
@@ -10,7 +10,7 @@
 from pyspark.sql.functions import *
 import mosaic as mos
 
-spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "ESRI")
+spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "JTS")
 spark.conf.set("spark.databricks.labs.mosaic.index.system", "H3")
 mos.enable_mosaic(spark, dbutils)
 

diff --git a/notebooks/examples/python/Ship2ShipTransfers/02. Data Ingestion.py b/notebooks/examples/python/Ship2ShipTransfers/02. Data Ingestion.py
@@ -11,7 +11,7 @@
 from pyspark.sql.functions import *
 import mosaic as mos
 
-spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "ESRI")
+spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "JTS")
 spark.conf.set("spark.databricks.labs.mosaic.index.system", "H3")
 mos.enable_mosaic(spark, dbutils)
 

diff --git a/notebooks/examples/python/Ship2ShipTransfers/03.a Overlap Detection.py b/notebooks/examples/python/Ship2ShipTransfers/03.a Overlap Detection.py
@@ -12,7 +12,7 @@
 from pyspark.sql.functions import *
 import mosaic as mos
 
-spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "ESRI")
+spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "JTS")
 spark.conf.set("spark.databricks.labs.mosaic.index.system", "H3")
 mos.enable_mosaic(spark, dbutils)
 

diff --git a/notebooks/examples/python/Ship2ShipTransfers/03.b Advanced Overlap Detection.py b/notebooks/examples/python/Ship2ShipTransfers/03.b Advanced Overlap Detection.py
@@ -12,7 +12,7 @@
 from pyspark.sql.functions import *
 import mosaic as mos
 
-spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "ESRI")
+spark.conf.set("spark.databricks.labs.mosaic.geometry.api", "JTS")
 spark.conf.set("spark.databricks.labs.mosaic.index.system", "H3")
 mos.enable_mosaic(spark, dbutils)
 

diff --git a/notebooks/examples/scala/MosaicAndSedona.scala b/notebooks/examples/scala/MosaicAndSedona.scala
@@ -23,9 +23,9 @@ SedonaSQLRegistrator.registerAll(spark)
 // Import Mosaic functions
 import com.databricks.labs.mosaic.functions.MosaicContext
 import com.databricks.labs.mosaic.H3
-import com.databricks.labs.mosaic.ESRI
+import com.databricks.labs.mosaic.JTS
 
-val mosaicContext = MosaicContext.build(H3, ESRI)
+val mosaicContext = MosaicContext.build(H3, JTS)
 import mosaicContext.functions._
 import org.apache.spark.sql.functions._
 

diff --git a/notebooks/examples/scala/QuickstartNotebook.scala b/notebooks/examples/scala/QuickstartNotebook.scala
@@ -24,9 +24,9 @@ print(s"The raw data is stored in $raw_path")
 
 import com.databricks.labs.mosaic.functions.MosaicContext
 import com.databricks.labs.mosaic.H3
-import com.databricks.labs.mosaic.ESRI
+import com.databricks.labs.mosaic.JTS
 
-val mosaicContext = MosaicContext.build(H3, ESRI)
+val mosaicContext = MosaicContext.build(H3, JTS)
 import mosaicContext.functions._
 import org.apache.spark.sql.functions._
 

diff --git a/notebooks/examples/sql/MosaicAndSedona.sql b/notebooks/examples/sql/MosaicAndSedona.sql
@@ -34,9 +34,9 @@
 -- MAGIC // Import Mosaic functions
 -- MAGIC import com.databricks.labs.mosaic.functions.MosaicContext
 -- MAGIC import com.databricks.labs.mosaic.H3
--- MAGIC import com.databricks.labs.mosaic.ESRI
+-- MAGIC import com.databricks.labs.mosaic.JTS
 -- MAGIC 
--- MAGIC val mosaicContext = MosaicContext.build(H3, ESRI)
+-- MAGIC val mosaicContext = MosaicContext.build(H3, JTS)
 -- MAGIC import mosaicContext.functions._
 -- MAGIC import org.apache.spark.sql.functions._
 

diff --git a/python/mosaic/api/functions.py b/python/mosaic/api/functions.py
@@ -487,7 +487,7 @@ def st_isvalid(geom: ColumnOrName) -> Column:
     Notes
     -----
     Validity assertions will be dependent on the chosen geometry API.
-    The assertions used in the ESRI geometry API (the default) follow the definitions in
+    The assertions used in the ESRI geometry API (JTS is the default) follow the definitions in
     the “Simple feature access - Part 1” document (OGC 06-103r4) for each geometry type.
 
     """

diff --git a/python/mosaic/core/mosaic_context.py b/python/mosaic/core/mosaic_context.py
@@ -31,7 +31,7 @@ def __init__(self, spark: SparkSession):
                 "spark.databricks.labs.mosaic.geometry.api"
             )
         except Py4JJavaError as e:
-            self._geometry_api = "ESRI"
+            self._geometry_api = "JTS"
 
         try:
             self._index_system = spark.conf.get(

diff --git a/src/main/scala/com/databricks/labs/mosaic/sql/extensions/MosaicSQLDefault.scala b/src/main/scala/com/databricks/labs/mosaic/sql/extensions/MosaicSQLDefault.scala
@@ -1,6 +1,6 @@
 package com.databricks.labs.mosaic.sql.extensions
 
-import com.databricks.labs.mosaic.core.geometry.api.ESRI
+import com.databricks.labs.mosaic.core.geometry.api.JTS
 import com.databricks.labs.mosaic.core.index.H3IndexSystem
 import com.databricks.labs.mosaic.core.raster.api.RasterAPI.GDAL
 import com.databricks.labs.mosaic.functions.MosaicContext
@@ -24,8 +24,8 @@ class MosaicSQLDefault extends (SparkSessionExtensions => Unit) with Logging {
       */
     override def apply(ext: SparkSessionExtensions): Unit = {
         ext.injectCheckRule(spark => {
-            val mosaicContext = MosaicContext.build(H3IndexSystem, ESRI, GDAL)
-            logInfo(s"Registering Mosaic SQL Extensions (H3, ESRI, GDAL).")
+            val mosaicContext = MosaicContext.build(H3IndexSystem, JTS, GDAL)
+            logInfo(s"Registering Mosaic SQL Extensions (H3, JTS, GDAL).")
             mosaicContext.register(spark)
             // NOP rule. This rule is specified only to respect syntax.
             _ => ()

diff --git a/src/test/scala/com/databricks/labs/mosaic/codegen/ConvertToCodegenMockTest.scala b/src/test/scala/com/databricks/labs/mosaic/codegen/ConvertToCodegenMockTest.scala
@@ -11,7 +11,7 @@ class ConvertToCodegenMockTest extends AnyFunSuite with MockFactory {
     test("ConvertTo Expression from GEOJSON to Unsupported format should throw an exception") {
         val ctx = stub[CodegenContext]
         val api = stub[GeometryAPI]
-        api.name _ when () returns "ESRI"
+        api.name _ when () returns "JTS"
 
         assertThrows[Error] {
             ConvertToCodeGen writeGeometryCode (ctx, "", "unsupported", api)