[SEDONA-238] Implement OGC GeometryType

common/src/main/java/org/apache/sedona/common/Functions.java

@@ -594,6 +594,14 @@ public static String geometryType(Geometry geometry) {
         return "ST_" + geometry.getGeometryType();
     }
 
+    public static String geometryTypeWithMeasured(Geometry geometry) {
+        String geometryType = geometry.getGeometryType().toUpperCase();
+        if (GeomUtils.isMeasuredGeometry(geometry)) {
+            geometryType += "M";
+        }
+        return geometryType;
+    }
+
     public static Geometry startPoint(Geometry geometry) {
         if (geometry instanceof LineString) {
             LineString line = (LineString) geometry;

common/src/main/java/org/apache/sedona/common/utils/GeomUtils.java

@@ -489,4 +489,11 @@ public static Double getHausdorffDistance(Geometry g1, Geometry g2, double densi
         }
         return hausdorffDistanceObj.distance();
     }
+
+    public static Boolean isMeasuredGeometry(Geometry geom) {
+        Coordinate[] coordinates = geom.getCoordinates();
+        GeometryFactory geometryFactory = new GeometryFactory();
+        CoordinateSequence sequence = geometryFactory.getCoordinateSequenceFactory().create(coordinates);
+        return sequence.getDimension() > 2 && sequence.getMeasures() > 0;
+    }
 }

common/src/test/java/org/apache/sedona/common/FunctionsTest.java

@@ -1078,6 +1078,34 @@ public void affine2DHybridGeomCollection() {
         assertEquals(expectedPolygon2.toText(), actualGeomCollection.getGeometryN(0).getGeometryN(1).getGeometryN(1).toText());
     }
 
+    @Test
+    public void geometryTypeWithMeasured() {
+        String expected = "POINT";
+        String actual = Functions.geometryTypeWithMeasured(GEOMETRY_FACTORY.createPoint(new Coordinate(10, 5)));
+        assertEquals(expected, actual);
+
+        // Create a point with measure value
+        CoordinateXYM coords = new CoordinateXYM(2, 3, 4);
+        Point measuredPoint = new GeometryFactory().createPoint(coords);
+        String expected2 = "POINTM";
+        String actual2 = Functions.geometryTypeWithMeasured(measuredPoint);
+        assertEquals(expected2, actual2);
+
+        // Create a linestring with measure value
+        CoordinateXYM[] coordsLineString = new CoordinateXYM[] {new CoordinateXYM(1, 2, 3), new CoordinateXYM(4, 5, 6)};
+        LineString measuredLineString = new GeometryFactory().createLineString(coordsLineString);
+        String expected3 = "LINESTRINGM";
+        String actual3 = Functions.geometryTypeWithMeasured(measuredLineString);
+        assertEquals(expected3, actual3);
+
+        // Create a polygon with measure value
+        CoordinateXYM[] coordsPolygon = new CoordinateXYM[] {new CoordinateXYM(0, 0, 0), new CoordinateXYM(1, 1, 0), new CoordinateXYM(0, 1, 0), new CoordinateXYM(0, 0, 0)};
+        Polygon measuredPolygon = new GeometryFactory().createPolygon(coordsPolygon);
+        String expected4 = "POLYGONM";
+        String actual4 = Functions.geometryTypeWithMeasured(measuredPolygon);
+        assertEquals(expected4, actual4);
+    }
+
     @Test
     public void hausdorffDistanceDefaultGeom2D() throws Exception {
         Polygon polygon1 = GEOMETRY_FACTORY.createPolygon(coordArray3d(1, 0, 1, 1, 1, 2, 2, 1, 5, 2, 0, 1, 1, 0, 1));

docs/api/flink/Function.md

@@ -1,3 +1,25 @@
+## GeometryType
+
+Introduction: Returns the type of the geometry as a string. Eg: 'LINESTRING', 'POLYGON', 'MULTIPOINT', etc.
+
+Format: `GeometryType (A:geometry)`
+
+Since: `v1.5.0`
+
+Example:
+
+```sql
+SELECT GeometryType(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'));
+```
+
+Result:
+
+```
+ geometrytype
+--------------
+ LINESTRING
+```
+
 ## ST_3DDistance
 
 Introduction: Return the 3-dimensional minimum cartesian distance between A and B

docs/api/sql/Function.md

@@ -1,3 +1,25 @@
+## GeometryType
+
+Introduction: Returns the type of the geometry as a string. Eg: 'LINESTRING', 'POLYGON', 'MULTIPOINT', etc.
+
+Format: `GeometryType (A:geometry)`
+
+Since: `v1.5.0`
+
+Example:
+
+```sql
+SELECT GeometryType(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'));
+```
+
+Result:
+
+```
+ geometrytype
+--------------
+ LINESTRING
+```
+
 ## ST_3DDistance
 
 Introduction: Return the 3-dimensional minimum cartesian distance between A and B

flink/src/main/java/org/apache/sedona/flink/Catalog.java

@@ -36,6 +36,7 @@ public static UserDefinedFunction[] getFuncs() {
                 new Constructors.ST_GeomFromKML(),
                 new Constructors.ST_MPolyFromText(),
                 new Constructors.ST_MLineFromText(),
+                new Functions.GeometryType(),
                 new Functions.ST_Area(),
                 new Functions.ST_AreaSpheroid(),
                 new Functions.ST_Azimuth(),

flink/src/main/java/org/apache/sedona/flink/expressions/Functions.java

@@ -21,6 +21,14 @@
 import org.opengis.referencing.operation.TransformException;
 
 public class Functions {
+    public static class GeometryType extends ScalarFunction {
+        @DataTypeHint("String")
+        public String eval(@DataTypeHint(value = "RAW", bridgedTo = org.locationtech.jts.geom.Geometry.class) Object o) {
+            Geometry geom = (Geometry) o;
+            return org.apache.sedona.common.Functions.geometryTypeWithMeasured(geom);
+        }
+    }
+
     public static class ST_Area extends ScalarFunction {
         @DataTypeHint("Double")
         public Double eval(@DataTypeHint(value = "RAW", bridgedTo = org.locationtech.jts.geom.Geometry.class) Object o) {

flink/src/test/java/org/apache/sedona/flink/FunctionTest.java

@@ -153,7 +153,6 @@ public void testTransformWKT() throws FactoryException {
 
     }
 
-
     @Test
     public void testDimension(){
         Table pointTable = tableEnv.sqlQuery(
@@ -164,6 +163,7 @@ public void testDimension(){
                 "SELECT ST_Dimension(ST_GeomFromWKT('GEOMETRYCOLLECTION(MULTIPOLYGON(((0 0, 0 1, 1 1, 1 0, 0 0)), ((2 2, 2 3, 3 3, 3 2, 2 2))), MULTIPOINT(6 6, 7 7, 8 8))'))");
         assertEquals(2, first(pointTable).getField(0));
     }
+
     @Test
     public void testDistance() {
         Table pointTable = createPointTable(testDataSize);
@@ -250,6 +250,17 @@ public void testGeomToGeoHash() {
         assertEquals(first(pointTable).getField(0), "s0000");
     }
 
+    @Test
+    public void testGeometryType() {
+        Table pointTable = tableEnv.sqlQuery(
+                        "SELECT GeometryType(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'))");
+        assertEquals("LINESTRING", first(pointTable).getField(0));
+
+        pointTable = tableEnv.sqlQuery(
+                "SELECT GeometryType(ST_GeomFromText('POINTM(2.0 3.5 10.2)'))");
+        assertEquals("POINTM", first(pointTable).getField(0));
+    }
+
     @Test
     public void testPointOnSurface() {
         Table pointTable = createPointTable_real(testDataSize);

python/sedona/sql/st_functions.py

@@ -24,6 +24,7 @@
 
 
 __all__ = [
+    "GeometryType",
     "ST_3DDistance",
     "ST_AddPoint",
     "ST_Area",
@@ -120,6 +121,16 @@
 
 _call_st_function = partial(call_sedona_function, "st_functions")
 
+@validate_argument_types
+def GeometryType(geometry: ColumnOrName):
+    """Return the type of the geometry as a string.
+
+    :param geometry: Geometry column to calculate the dimension for.
+    :type geometry: ColumnOrName
+    :return: Type of geometry as a string column.
+    :rtype: Column
+    """
+    return _call_st_function("GeometryType", geometry)
 
 @validate_argument_types
 def ST_3DDistance(a: ColumnOrName, b: ColumnOrName) -> Column:

python/tests/sql/test_dataframe_api.py

@@ -49,6 +49,7 @@
     (stc.ST_PolygonFromText, ("multiple_point", lambda: f.lit(',')), "constructor", "", "POLYGON ((0 0, 1 0, 1 1, 0 0))"),
 
     # functions
+    (stf.GeometryType, ("line",), "linestring_geom", "", "LINESTRING"),
     (stf.ST_3DDistance, ("a", "b"), "two_points", "", 5.0),
     (stf.ST_Affine, ("geom", 1.0, 2.0, 1.0, 2.0, 1.0, 2.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0), "square_geom", "", "POLYGON ((2 3, 4 5, 5 6, 3 4, 2 3))"),
     (stf.ST_AddPoint, ("line", lambda: f.expr("ST_Point(1.0, 1.0)")), "linestring_geom", "", "LINESTRING (0 0, 1 0, 2 0, 3 0, 4 0, 5 0, 1 1)"),

sql/common/src/main/scala/org/apache/sedona/sql/UDF/Catalog.scala

@@ -36,6 +36,7 @@ object Catalog {
 
   val expressions: Seq[FunctionDescription] = Seq(
     // Expression for vectors
+    function[GeometryType](),
     function[ST_PointFromText](),
     function[ST_PolygonFromText](),
     function[ST_LineStringFromText](),

sql/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/Functions.scala

@@ -1018,6 +1018,7 @@ case class ST_Dimension(inputExpressions: Seq[Expression])
     copy(inputExpressions = newChildren)
   }
 }
+
 case class ST_BoundingDiagonal(inputExpressions: Seq[Expression])
   extends InferredExpression(Functions.boundingDiagonal _) {
   protected def withNewChildrenInternal(newChildren: IndexedSeq[Expression]) = {
@@ -1031,3 +1032,10 @@ case class ST_HausdorffDistance(inputExpressions: Seq[Expression])
     copy(inputExpressions = newChildren)
   }
 }
+
+case class GeometryType(inputExpressions: Seq[Expression])
+  extends InferredExpression(Functions.geometryTypeWithMeasured _) with FoldableExpression {
+  protected def withNewChildrenInternal(newChildren: IndexedSeq[Expression]) = {
+    copy(inputExpressions = newChildren)
+  }
+}

sql/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/st_functions.scala

@@ -23,6 +23,9 @@ import org.apache.spark.sql.sedona_sql.expressions.collect.{ST_Collect}
 import org.locationtech.jts.operation.buffer.BufferParameters
 
 object st_functions extends DataFrameAPI {
+  def GeometryType(a: Column, b: Column): Column = wrapExpression[GeometryType](a, b)
+  def GeometryType(a: String, b: String): Column = wrapExpression[GeometryType](a, b)
+
   def ST_3DDistance(a: Column, b: Column): Column = wrapExpression[ST_3DDistance](a, b)
   def ST_3DDistance(a: String, b: String): Column = wrapExpression[ST_3DDistance](a, b)
 

sql/common/src/test/scala/org/apache/sedona/sql/dataFrameAPITestScala.scala

@@ -1038,5 +1038,13 @@ class dataFrameAPITestScala extends TestBaseScala {
       assert(expected == actual)
       assert(expected == actualDefaultValue)
     }
+
+    it("Passed GeometryType") {
+      val polyDf = sparkSession.sql("SELECT ST_GeomFromWKT('POLYGON ((1 2, 2 1, 2 0, 4 1, 1 2))') AS geom")
+      val df = polyDf.select(ST_GeometryType("geom"))
+      val expected = "POLYGON"
+      val actual = df.take(1)(0).get(0).asInstanceOf[String]
+      assert(expected == actual)
+    }
   }
 }

sql/common/src/test/scala/org/apache/sedona/sql/functionTestScala.scala

@@ -2062,4 +2062,23 @@ class functionTestScala extends TestBaseScala with Matchers with GeometrySample
     }
   }
 
+  it ("should pass GeometryType") {
+    val geomTestCases = Map (
+      ("'POINT (51.3168 -0.56)'") -> "POINT",
+      ("'POINT (0 0 1)'") -> "POINT",
+      ("'LINESTRING (0 0, 0 90)'") -> "LINESTRING",
+      ("'POLYGON ((0 0,0 5,5 0,0 0))'") -> "POLYGON",
+      ("'POINTM (1, 2, 3)'") -> "POINTM",
+      ("'LINESTRINGM (0 0 1, 0 90 1)'") -> "LINESTRINGM",
+      ("'POLYGONM ((0 0 1,0 5 1,5 0 1,0 0 1))'") -> "POLYGONM"
+    )
+    for ((geom, expectedResult) <- geomTestCases) {
+        val df = sparkSession.sql(s"SELECT GeometryType(ST_GeomFromWKT($geom)), " +
+          s"$expectedResult")
+        val actual = df.take(1)(0).get(0).asInstanceOf[String]
+        val expected = df.take(1)(0).get(1).asInstanceOf[String]
+        assertEquals(expected, actual)
+    }
+  }
+
 }