Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SEDONA-635] Allow ST_AsGeoJSON to return feature and featureCollection format GeoJSON #1530

Merged
merged 7 commits into from
Jul 31, 2024
Merged

[SEDONA-635] Allow ST_AsGeoJSON to return feature and featureCollection format GeoJSON #1530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4f14354
feat: add type parameter
prantogg Jul 29, 2024
ffd0fe8
update docs
prantogg Jul 29, 2024
4c4eacb
update docs - add examples for features and featureCollections
prantogg Jul 30, 2024
1316296
fix typo
prantogg Jul 30, 2024
216bf51
fix snowflake spotless error
prantogg Jul 30, 2024
752a558
fix python dataframe api
prantogg Jul 31, 2024
21cd5d5
fix python dataframe api test
prantogg Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion common/src/main/java/org/apache/sedona/common/Functions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@
import org.locationtech.jts.simplify.VWSimplifier;
import org.locationtech.jts.triangulate.DelaunayTriangulationBuilder;
import org.locationtech.jts.triangulate.polygon.ConstrainedDelaunayTriangulator;
import org.wololo.geojson.Feature;
import org.wololo.geojson.FeatureCollection;
import org.wololo.jts2geojson.GeoJSONWriter;

public class Functions {
Expand Down Expand Up @@ -664,11 +666,39 @@ public static byte[] asWKB(Geometry geometry) {
}

public static String asGeoJson(Geometry geometry) {
return asGeoJson(geometry, "simple");
}

public static String asGeoJson(Geometry geometry, String type) {
if (geometry == null) {
return null;
}

GeoJSONWriter writer = new GeoJSONWriter();
return writer.write(geometry).toString();
org.wololo.geojson.Geometry geoJson = writer.write(geometry);

switch (type.toLowerCase()) {
case "simple":
return geoJson.toString();

case "feature":
Map<String, Object> properties = new HashMap<>();
Feature feature = new Feature(geoJson, properties);
return feature.toString();

case "featurecollection":
List<Feature> features = new ArrayList<>();
features.add(new Feature(geoJson, new HashMap<>()));
FeatureCollection featureCollection =
new FeatureCollection(features.toArray(new Feature[0]));
return featureCollection.toString();

default:
throw new IllegalArgumentException(
jiayuasu marked this conversation as resolved.
Show resolved Hide resolved
"Unknown type: "
+ type
+ ". Valid types are: 'simple', 'feature', 'featurecollection'.");
}
}

public static int nPoints(Geometry geometry) {
Expand Down
60 changes: 57 additions & 3 deletions docs/api/flink/Function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,13 +372,23 @@ POINT ZM(1 1 1 1)

## ST_AsGeoJSON

Introduction: Return the [GeoJSON](https://geojson.org/) string representation of a geometry
Introduction: Return the [GeoJSON](https://geojson.org/) string representation of a geometry.

Format: `ST_AsGeoJSON (A: Geometry)`
The type parameter (Since: `v1.6.1`) takes the following options -

- "Simple" (default): Returns a simple GeoJSON geometry.
- "Feature": Wraps the geometry in a GeoJSON Feature.
- "FeatureCollection": Wraps the Feature in a GeoJSON FeatureCollection.

Format:

`ST_AsGeoJSON (A: Geometry)`

`ST_AsGeoJSON (A: Geometry, type: String)`

Since: `v1.3.0`

Example:
SQL Example (Simple GeoJSON):

```sql
SELECT ST_AsGeoJSON(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
Expand All @@ -399,6 +409,50 @@ Output:
}
```

SQL Example (Feature GeoJSON):

Output:

```json
{
"type":"Feature",
"geometry": {
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
}
```

SQL Example (FeatureCollection GeoJSON):

Output:

```json
{
"type":"FeatureCollection",
"features": [{
"type":"Feature",
"geometry": {
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
}
]
}
```

## ST_AsGML

Introduction: Return the [GML](https://www.ogc.org/standards/gml) string representation of a geometry
Expand Down
78 changes: 73 additions & 5 deletions docs/api/snowflake/vector-data/Function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,81 @@ FROM polygondf

Introduction: Return the [GeoJSON](https://geojson.org/) string representation of a geometry

Format: `ST_AsGeoJSON (A:geometry)`
The type parameter takes the following options -

SQL example:
- "Simple" (default): Returns a simple GeoJSON geometry.
- "Feature": Wraps the geometry in a GeoJSON Feature.
- "FeatureCollection": Wraps the Feature in a GeoJSON FeatureCollection.

```SQL
SELECT ST_AsGeoJSON(polygondf.countyshape)
FROM polygondf
Format:

`ST_AsGeoJSON (A:geometry)`

`ST_AsGeoJSON (A:geometry, type: String)`

SQL Example (Simple GeoJSON):

```sql
SELECT ST_AsGeoJSON(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```

Output:

```json
{
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
```

SQL Example (Feature GeoJSON):

Output:

```json
{
"type":"Feature",
"geometry": {
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
}
```

SQL Example (FeatureCollection GeoJSON):

Output:

```json
{
"type":"FeatureCollection",
"features": [{
"type":"Feature",
"geometry": {
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
}
]
}
```

## ST_AsGML
Expand Down
58 changes: 56 additions & 2 deletions docs/api/sql/Function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,11 +371,21 @@ POINT ZM(1 1 1 1)

Introduction: Return the [GeoJSON](https://geojson.org/) string representation of a geometry

Format: `ST_AsGeoJSON (A: Geometry)`
The type parameter (Since: `v1.6.1`) takes the following options -

- "Simple" (default): Returns a simple GeoJSON geometry.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add an example below for the Feature and FeatureCollection

- "Feature": Wraps the geometry in a GeoJSON Feature.
- "FeatureCollection": Wraps the Feature in a GeoJSON FeatureCollection.

Format:

`ST_AsGeoJSON (A: Geometry)`

`ST_AsGeoJSON (A: Geometry, type: String)`

Since: `v1.0.0`

SQL Example
SQL Example (Simple GeoJSON):

```sql
SELECT ST_AsGeoJSON(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
Expand All @@ -396,6 +406,50 @@ Output:
}
```

SQL Example (Feature GeoJSON):

Output:

```json
{
"type":"Feature",
"geometry": {
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
}
```

SQL Example (FeatureCollection GeoJSON):

Output:

```json
{
"type":"FeatureCollection",
"features": [{
"type":"Feature",
"geometry": {
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
}
]
}
```

## ST_AsGML

Introduction: Return the [GML](https://www.ogc.org/standards/gml) string representation of a geometry
Expand Down
8 changes: 8 additions & 0 deletions flink/src/main/java/org/apache/sedona/flink/expressions/Functions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -744,6 +744,14 @@ public String eval(
Geometry geom = (Geometry) o;
return org.apache.sedona.common.Functions.asGeoJson(geom);
}

@DataTypeHint("String")
public String eval(
@DataTypeHint(value = "RAW", bridgedTo = org.locationtech.jts.geom.Geometry.class) Object o,
String type) {
Geometry geom = (Geometry) o;
return org.apache.sedona.common.Functions.asGeoJson(geom, type);
}
}

public static class ST_AsGML extends ScalarFunction {
Expand Down
21 changes: 21 additions & 0 deletions flink/src/test/java/org/apache/sedona/flink/FunctionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,6 +1004,27 @@ public void testGeoJSON() {
assertEquals(
"{\"type\":\"Polygon\",\"coordinates\":[[[-0.5,-0.5],[-0.5,0.5],[0.5,0.5],[0.5,-0.5],[-0.5,-0.5]]]}",
result);

polygonTable = createPolygonTable(testDataSize);
polygonTable =
polygonTable.select(
call(Functions.ST_AsGeoJSON.class.getSimpleName(), $(polygonColNames[0]), "Feature"));
result = (String) first(polygonTable).getField(0);
assertEquals(
"{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[-0.5,-0.5],[-0.5,0.5],[0.5,0.5],[0.5,-0.5],[-0.5,-0.5]]]},\"properties\":{}}",
result);

polygonTable = createPolygonTable(testDataSize);
polygonTable =
polygonTable.select(
call(
Functions.ST_AsGeoJSON.class.getSimpleName(),
$(polygonColNames[0]),
"FeatureCollection"));
result = (String) first(polygonTable).getField(0);
assertEquals(
"{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[-0.5,-0.5],[-0.5,0.5],[0.5,0.5],[0.5,-0.5],[-0.5,-0.5]]]},\"properties\":{}}]}",
result);
}

@Test
Expand Down
5 changes: 3 additions & 2 deletions python/sedona/sql/st_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,15 +160,16 @@ def ST_AsEWKT(geometry: ColumnOrName) -> Column:


@validate_argument_types
def ST_AsGeoJSON(geometry: ColumnOrName) -> Column:
def ST_AsGeoJSON(geometry: ColumnOrName, type: Optional[Union[ColumnOrName, str]] = None) -> Column:
"""Generate the GeoJSON style representation of a geometry column.

:param geometry: Geometry column to generate GeoJSON for.
:type geometry: ColumnOrName
:return: GeoJSON representation of geometry as a string column.
:rtype: Column
"""
return _call_st_function("ST_AsGeoJSON", geometry)
args = (geometry) if type is None else (geometry, type)
return _call_st_function("ST_AsGeoJSON", args)


@validate_argument_types
Expand Down
2 changes: 2 additions & 0 deletions python/tests/sql/test_dataframe_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@
(stf.ST_AsHEXEWKB, ("point",), "point_geom", "", "01010000000000000000000000000000000000F03F"),
(stf.ST_AsEWKT, (lambda: f.expr("ST_SetSRID(point, 4326)"),), "point_geom", "", "SRID=4326;POINT (0 1)"),
(stf.ST_AsGeoJSON, ("point",), "point_geom", "", "{\"type\":\"Point\",\"coordinates\":[0.0,1.0]}"),
(stf.ST_AsGeoJSON, ("point", lambda: f.lit("feature")), "point_geom", "", "{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[0.0,1.0]},\"properties\":{}}"),
(stf.ST_AsGeoJSON, ("point", lambda: f.lit("featurecollection")), "point_geom", "", "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[0.0,1.0]},\"properties\":{}}]}"),
(stf.ST_AsGML, ("point",), "point_geom", "", "<gml:Point>\n <gml:coordinates>\n 0.0,1.0 \n </gml:coordinates>\n</gml:Point>\n"),
(stf.ST_AsKML, ("point",), "point_geom", "", "<Point>\n <coordinates>0.0,1.0</coordinates>\n</Point>\n"),
(stf.ST_AsText, ("point",), "point_geom", "", "POINT (0 1)"),
Expand Down
10 changes: 10 additions & 0 deletions snowflake-tester/src/test/java/org/apache/sedona/snowflake/snowsql/TestFunctions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,16 @@ public void test_ST_AsGeoJSON() {
verifySqlSingleRes(
"select sedona.ST_AsGeoJSON(sedona.ST_GeomFromText('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))",
"{\"type\":\"Polygon\",\"coordinates\":[[[1.0,1.0],[8.0,1.0],[8.0,8.0],[1.0,8.0],[1.0,1.0]]]}");

registerUDF("ST_AsGeoJSON", byte[].class, String.class);
verifySqlSingleRes(
"select sedona.ST_AsGeoJSON(sedona.ST_GeomFromText('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'), 'feature')",
"{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[1.0,1.0],[8.0,1.0],[8.0,8.0],[1.0,8.0],[1.0,1.0]]]},\"properties\":{}}");

registerUDF("ST_AsGeoJSON", byte[].class, String.class);
verifySqlSingleRes(
"select sedona.ST_AsGeoJSON(sedona.ST_GeomFromText('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'), 'featurecollection')",
"{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[1.0,1.0],[8.0,1.0],[8.0,8.0],[1.0,8.0],[1.0,1.0]]]},\"properties\":{}}]}");
}

@Test
Expand Down
10 changes: 10 additions & 0 deletions snowflake-tester/src/test/java/org/apache/sedona/snowflake/snowsql/TestFunctionsV2.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,16 @@ public void test_ST_AsGeoJSON() {
verifySqlSingleRes(
"select sedona.ST_AsGeoJSON(ST_GeometryFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))",
"{\"type\":\"Polygon\",\"coordinates\":[[[1.0,1.0],[8.0,1.0],[8.0,8.0],[1.0,8.0],[1.0,1.0]]]}");

registerUDFV2("ST_AsGeoJSON", String.class, String.class);
verifySqlSingleRes(
"select sedona.ST_AsGeoJSON(ST_GeometryFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'), 'feature')",
"{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[1.0,1.0],[8.0,1.0],[8.0,8.0],[1.0,8.0],[1.0,1.0]]]},\"properties\":{}}");

registerUDFV2("ST_AsGeoJSON", String.class, String.class);
verifySqlSingleRes(
"select sedona.ST_AsGeoJSON(ST_GeometryFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'), 'featurecollection')",
"{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[1.0,1.0],[8.0,1.0],[8.0,8.0],[1.0,8.0],[1.0,1.0]]]},\"properties\":{}}]}");
}

@Test
Expand Down
Loading
Loading