org.apache.calcite.runtime

Class GeoFunctions

java.lang.Object

org.apache.calcite.runtime.GeoFunctions

public class GeoFunctions
extends Object

Helper methods to implement Geo-spatial functions in generated code.

Remaining tasks:

• Determine type code for ExtraSqlTypes.GEOMETRY
• Should we create aliases for functions in upper-case? Without ST_ prefix?
• Consider adding spatial literals, e.g. `GEOMETRY 'POINT (30 10)'`
• Integer arguments, e.g. SELECT ST_MakePoint(1, 2, 1.5), ST_MakePoint(1, 2)
• Are GEOMETRY values comparable? If so add ORDER BY test
• We have to add 'Z' to create 3D objects. This is inconsistent with PostGIS. Who is right? At least document the difference.
• Should add GeometryEngine.intersects; similar to disjoint etc.
• Make #ST_MakeLine(Geom, Geom) varargs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoFunctions.GridEnumerable Used at run time by the ST_MakeGrid(org.apache.calcite.runtime.Geometries.Geom, java.math.BigDecimal, java.math.BigDecimal) and ST_MakeGridPoints(org.apache.calcite.runtime.Geometries.Geom, java.math.BigDecimal, java.math.BigDecimal) functions.

Method Summary

Modifier and Type	Method and Description
static long	hilbert(BigDecimal x, BigDecimal y) Returns the position of a point on the Hilbert curve.
static Long	hilbert(Geometries.Geom geom) Returns the position of a point on the Hilbert curve, or null if it is not a 2-dimensional point.
static String	ST_AsText(Geometries.Geom g)
static String	ST_AsWKT(Geometries.Geom g)
static Geometries.Geom	ST_Boundary(Geometries.Geom geom) Returns the boundary of geom.
static Geometries.Geom	ST_Buffer(Geometries.Geom geom, double distance) Computes a buffer around geom.
static Geometries.Geom	ST_Buffer(Geometries.Geom geom, double distance, int quadSegs) Computes a buffer around geom with .
static Geometries.Geom	ST_Buffer(Geometries.Geom geom, double bufferSize, String style) Computes a buffer around geom.
static boolean	ST_Contains(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 contains geom2.
static boolean	ST_ContainsProperly(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 contains geom2 but does not intersect its boundary.
static boolean	ST_Crosses(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 crosses geom2.
static boolean	ST_Disjoint(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 and geom2 are disjoint.
static double	ST_Distance(Geometries.Geom geom1, Geometries.Geom geom2) Returns the distance between geom1 and geom2.
static boolean	ST_DWithin(Geometries.Geom geom1, Geometries.Geom geom2, double distance) Returns whether geom1 and geom2 are within distance of each other.
static Geometries.Geom	ST_Envelope(Geometries.Geom geom) Returns the minimum bounding box of geom (which may be a GEOMETRYCOLLECTION).
static boolean	ST_EnvelopesIntersect(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether the envelope of geom1 intersects the envelope of geom2.
static boolean	ST_Equals(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 equals geom2.
static String	ST_GeometryType(Geometries.Geom geom) Returns the type of geom.
static int	ST_GeometryTypeCode(Geometries.Geom geom) Returns the OGC SFS type code of geom.
static Geometries.Geom	ST_GeomFromText(String s)
static Geometries.Geom	ST_GeomFromText(String s, int srid)
static boolean	ST_Intersects(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 intersects geom2.
static boolean	ST_Is3D(Geometries.Geom geom) Returns whether geom has at least one z-coordinate.
static Geometries.Geom	ST_LineFromText(String s)
static Geometries.Geom	ST_LineFromText(String wkt, int srid)
static Geometries.Geom	ST_MakeEnvelope(BigDecimal xMin, BigDecimal yMin, BigDecimal xMax, BigDecimal yMax) Creates a rectangular Polygon.
static Geometries.Geom	ST_MakeEnvelope(BigDecimal xMin, BigDecimal yMin, BigDecimal xMax, BigDecimal yMax, int srid) Creates a rectangular Polygon.
static Geometries.Geom	ST_MakeLine(Geometries.Geom geom1, Geometries.Geom geom2) Creates a line-string from the given POINTs (or MULTIPOINTs).
static Geometries.Geom	ST_MakeLine(Geometries.Geom geom1, Geometries.Geom geom2, Geometries.Geom geom3)
static Geometries.Geom	ST_MakeLine(Geometries.Geom geom1, Geometries.Geom geom2, Geometries.Geom geom3, Geometries.Geom geom4)
static Geometries.Geom	ST_MakeLine(Geometries.Geom geom1, Geometries.Geom geom2, Geometries.Geom geom3, Geometries.Geom geom4, Geometries.Geom geom5)
static Geometries.Geom	ST_MakeLine(Geometries.Geom geom1, Geometries.Geom geom2, Geometries.Geom geom3, Geometries.Geom geom4, Geometries.Geom geom5, Geometries.Geom geom6)
static Geometries.Geom	ST_MakePoint(BigDecimal x, BigDecimal y) Alias for ST_Point(BigDecimal, BigDecimal).
static Geometries.Geom	ST_MakePoint(BigDecimal x, BigDecimal y, BigDecimal z) Alias for ST_Point(BigDecimal, BigDecimal, BigDecimal).
static Geometries.Geom	ST_MLineFromText(String s)
static Geometries.Geom	ST_MLineFromText(String wkt, int srid)
static Geometries.Geom	ST_MPointFromText(String s)
static Geometries.Geom	ST_MPointFromText(String wkt, int srid)
static Geometries.Geom	ST_MPolyFromText(String s)
static Geometries.Geom	ST_MPolyFromText(String wkt, int srid)
static boolean	ST_OrderingEquals(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 equals geom2 and their coordinates and component Geometries are listed in the same order.
static boolean	ST_Overlaps(Geometries.Geom geom1, Geometries.Geom geom2) Returns geom1 overlaps geom2.
static Geometries.Geom	ST_Point(BigDecimal x, BigDecimal y) Constructs a 2D point from coordinates.
static Geometries.Geom	ST_Point(BigDecimal x, BigDecimal y, BigDecimal z) Constructs a 3D point from coordinates.
static Geometries.Geom	ST_PointFromText(String s)
static Geometries.Geom	ST_PointFromText(String wkt, int srid)
static Geometries.Geom	ST_PolyFromText(String s)
static Geometries.Geom	ST_PolyFromText(String wkt, int srid)
static Geometries.Geom	ST_SetSRID(Geometries.Geom geom, int srid) Returns a copy of geom with a new SRID.
static boolean	ST_Touches(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 touches geom2.
static Geometries.Geom	ST_Transform(Geometries.Geom geom, int srid) Transforms geom from one coordinate reference system (CRS) to the CRS specified by srid.
static Geometries.Geom	ST_Union(Geometries.Geom geomCollection) Computes the union of the geometries in geomCollection.
static Geometries.Geom	ST_Union(Geometries.Geom geom1, Geometries.Geom geom2) Computes the union of geom1 and geom2.
static boolean	ST_Within(Geometries.Geom geom1, Geometries.Geom geom2) Returns whether geom1 is within geom2.
static Double	ST_X(Geometries.Geom geom) Returns the x-value of the first coordinate of geom.
static Double	ST_Y(Geometries.Geom geom) Returns the y-value of the first coordinate of geom.
static Double	ST_Z(Geometries.Geom geom) Returns the z-value of the first coordinate of geom.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ST_AsText

public static String ST_AsText(Geometries.Geom g)

ST_AsWKT

public static String ST_AsWKT(Geometries.Geom g)

ST_GeomFromText

public static Geometries.Geom ST_GeomFromText(String s)

ST_GeomFromText

public static Geometries.Geom ST_GeomFromText(String s,
                                              int srid)

ST_LineFromText

public static Geometries.Geom ST_LineFromText(String s)

ST_LineFromText

public static Geometries.Geom ST_LineFromText(String wkt,
                                              int srid)

ST_MPointFromText

public static Geometries.Geom ST_MPointFromText(String s)

ST_MPointFromText

public static Geometries.Geom ST_MPointFromText(String wkt,
                                                int srid)

ST_PointFromText

public static Geometries.Geom ST_PointFromText(String s)

ST_PointFromText

public static Geometries.Geom ST_PointFromText(String wkt,
                                               int srid)

ST_PolyFromText

public static Geometries.Geom ST_PolyFromText(String s)

ST_PolyFromText

public static Geometries.Geom ST_PolyFromText(String wkt,
                                              int srid)

ST_MLineFromText

public static Geometries.Geom ST_MLineFromText(String s)

ST_MLineFromText

public static Geometries.Geom ST_MLineFromText(String wkt,
                                               int srid)

ST_MPolyFromText

public static Geometries.Geom ST_MPolyFromText(String s)

ST_MPolyFromText

public static Geometries.Geom ST_MPolyFromText(String wkt,
                                               int srid)

ST_MakeEnvelope

public static Geometries.Geom ST_MakeEnvelope(BigDecimal xMin,
                                              BigDecimal yMin,
                                              BigDecimal xMax,
                                              BigDecimal yMax,
                                              int srid)

Creates a rectangular Polygon.

ST_MakeEnvelope

public static Geometries.Geom ST_MakeEnvelope(BigDecimal xMin,
                                              BigDecimal yMin,
                                              BigDecimal xMax,
                                              BigDecimal yMax)

Creates a rectangular Polygon.

ST_MakeLine

public static Geometries.Geom ST_MakeLine(Geometries.Geom geom1,
                                          Geometries.Geom geom2)

Creates a line-string from the given POINTs (or MULTIPOINTs).

ST_MakeLine

public static Geometries.Geom ST_MakeLine(Geometries.Geom geom1,
                                          Geometries.Geom geom2,
                                          Geometries.Geom geom3)

ST_MakeLine

public static Geometries.Geom ST_MakeLine(Geometries.Geom geom1,
                                          Geometries.Geom geom2,
                                          Geometries.Geom geom3,
                                          Geometries.Geom geom4)

ST_MakeLine

public static Geometries.Geom ST_MakeLine(Geometries.Geom geom1,
                                          Geometries.Geom geom2,
                                          Geometries.Geom geom3,
                                          Geometries.Geom geom4,
                                          Geometries.Geom geom5)

ST_MakeLine

public static Geometries.Geom ST_MakeLine(Geometries.Geom geom1,
                                          Geometries.Geom geom2,
                                          Geometries.Geom geom3,
                                          Geometries.Geom geom4,
                                          Geometries.Geom geom5,
                                          Geometries.Geom geom6)

ST_MakePoint

public static Geometries.Geom ST_MakePoint(BigDecimal x,
                                           BigDecimal y)

Alias for ST_Point(BigDecimal, BigDecimal).

ST_MakePoint

public static Geometries.Geom ST_MakePoint(BigDecimal x,
                                           BigDecimal y,
                                           BigDecimal z)

Alias for ST_Point(BigDecimal, BigDecimal, BigDecimal).

ST_Point

public static Geometries.Geom ST_Point(BigDecimal x,
                                       BigDecimal y)

Constructs a 2D point from coordinates.

ST_Point

public static Geometries.Geom ST_Point(BigDecimal x,
                                       BigDecimal y,
                                       BigDecimal z)

Constructs a 3D point from coordinates.

ST_Is3D

public static boolean ST_Is3D(Geometries.Geom geom)

Returns whether geom has at least one z-coordinate.

ST_X

public static Double ST_X(Geometries.Geom geom)

Returns the x-value of the first coordinate of geom.

ST_Y

public static Double ST_Y(Geometries.Geom geom)

Returns the y-value of the first coordinate of geom.

ST_Z

public static Double ST_Z(Geometries.Geom geom)

Returns the z-value of the first coordinate of geom.

ST_Boundary

public static Geometries.Geom ST_Boundary(Geometries.Geom geom)

Returns the boundary of geom.

ST_Distance

public static double ST_Distance(Geometries.Geom geom1,
                                 Geometries.Geom geom2)

Returns the distance between geom1 and geom2.

ST_GeometryType

public static String ST_GeometryType(Geometries.Geom geom)

Returns the type of geom.

ST_GeometryTypeCode

public static int ST_GeometryTypeCode(Geometries.Geom geom)

Returns the OGC SFS type code of geom.

ST_Envelope

public static Geometries.Geom ST_Envelope(Geometries.Geom geom)

Returns the minimum bounding box of geom (which may be a GEOMETRYCOLLECTION).

ST_Contains

public static boolean ST_Contains(Geometries.Geom geom1,
                                  Geometries.Geom geom2)

Returns whether geom1 contains geom2.

ST_ContainsProperly

public static boolean ST_ContainsProperly(Geometries.Geom geom1,
                                          Geometries.Geom geom2)

Returns whether geom1 contains geom2 but does not intersect its boundary.

ST_Crosses

public static boolean ST_Crosses(Geometries.Geom geom1,
                                 Geometries.Geom geom2)

Returns whether geom1 crosses geom2.

ST_Disjoint

public static boolean ST_Disjoint(Geometries.Geom geom1,
                                  Geometries.Geom geom2)

Returns whether geom1 and geom2 are disjoint.

ST_EnvelopesIntersect

public static boolean ST_EnvelopesIntersect(Geometries.Geom geom1,
                                            Geometries.Geom geom2)

Returns whether the envelope of geom1 intersects the envelope of geom2.

ST_Equals

public static boolean ST_Equals(Geometries.Geom geom1,
                                Geometries.Geom geom2)

Returns whether geom1 equals geom2.

ST_Intersects

public static boolean ST_Intersects(Geometries.Geom geom1,
                                    Geometries.Geom geom2)

Returns whether geom1 intersects geom2.

ST_OrderingEquals

public static boolean ST_OrderingEquals(Geometries.Geom geom1,
                                        Geometries.Geom geom2)

Returns whether geom1 equals geom2 and their coordinates and component Geometries are listed in the same order.

ST_Overlaps

public static boolean ST_Overlaps(Geometries.Geom geom1,
                                  Geometries.Geom geom2)

Returns geom1 overlaps geom2.

ST_Touches

public static boolean ST_Touches(Geometries.Geom geom1,
                                 Geometries.Geom geom2)

Returns whether geom1 touches geom2.

ST_Within

public static boolean ST_Within(Geometries.Geom geom1,
                                Geometries.Geom geom2)

Returns whether geom1 is within geom2.

ST_DWithin

public static boolean ST_DWithin(Geometries.Geom geom1,
                                 Geometries.Geom geom2,
                                 double distance)

Returns whether geom1 and geom2 are within distance of each other.

ST_Buffer

public static Geometries.Geom ST_Buffer(Geometries.Geom geom,
                                        double distance)

Computes a buffer around geom.

ST_Buffer

public static Geometries.Geom ST_Buffer(Geometries.Geom geom,
                                        double distance,
                                        int quadSegs)

Computes a buffer around geom with .

ST_Buffer

public static Geometries.Geom ST_Buffer(Geometries.Geom geom,
                                        double bufferSize,
                                        String style)

Computes a buffer around geom.

ST_Union

public static Geometries.Geom ST_Union(Geometries.Geom geom1,
                                       Geometries.Geom geom2)

Computes the union of geom1 and geom2.

ST_Union

public static Geometries.Geom ST_Union(Geometries.Geom geomCollection)

Computes the union of the geometries in geomCollection.

ST_Transform

public static Geometries.Geom ST_Transform(Geometries.Geom geom,
                                           int srid)

Transforms geom from one coordinate reference system (CRS) to the CRS specified by srid.

ST_SetSRID

public static Geometries.Geom ST_SetSRID(Geometries.Geom geom,
                                         int srid)

Returns a copy of geom with a new SRID.

hilbert

public static Long hilbert(Geometries.Geom geom)

Returns the position of a point on the Hilbert curve, or null if it is not a 2-dimensional point.

hilbert

public static long hilbert(BigDecimal x,
                           BigDecimal y)

Returns the position of a point on the Hilbert curve.