Enum SQLMM
- All Implemented Interfaces:
Serializable
,Comparable<SQLMM>
,java.lang.constant.Constable
Identification of SQLMM operations. The names or enumeration values are the names
defined by SQLMM standard; they do not obey to the usual Java naming conventions.
Enumeration values order is the approximated declaration order in SQLMM standard.
- Since:
- 1.1
- Version:
- 1.1
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe area measurement of a surface, ignoring z and m coordinates.The Well-Known Binary (WKB) representation of a geometry.The Well-Known Text (WKT) representation of a geometry.Constructor for a multi-polygon which is transformed from a Well-Known Text (WKT) representation of multi line string.Constructor for a multi-polygon which is transformed from a Well-Known Binary (WKB) representation of multi line string.Constructor for a polygon which is transformed from a Well-Known Text (WKT) representation of polylines.Constructor for a polygon which is transformed from a Well-Known Binary (WKB) representation of polylines.The boundary of a geometry, ignoring z and m coordinate values.The geometry that represents all points whose distance from any point of a geometry is less than or equal to a specified distance.The 2D point value that is the mathematical centroid of the surface, ignoring z and m coordinates.Test if a geometry value spatially contains another geometry value, ignoring z and m coordinate values.The convex hull of a geometry, ignoring z and m coordinate values.The number of dimensions of coordinate tuples.Test if a geometry value spatially crosses another geometry value, ignoring z and m coordinate values.Geometry that represents the difference of two geometries, ignoring z and m coordinate values.The number of dimensions in the geometry.Test if a geometry value is spatially disjoint from another geometry value, ignoring z and m coordinate values.Distance between two geometries, ignoring z and m coordinate values.The point value that is the end point of a curve, including existing z and m coordinates.The boundary rectangle of a geometry, ignoring z and m coordinate values.Test if a geometry is spatially equal to another geometry value, ignoring z and m coordinate values.The coordinate values as aDOUBLE PRECISION ARRAY
value.The exterior ring of a polygon.Collection of geometries constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of geometry components.Constructor for a geometry collection which is transformed from a Well-Known Text (WKT) representation.Constructor for a geometry collection which is transformed from a Well-Known Binary (WKB) representation.The specified element in a geometry collection.The SQLMM name of the geometry type.Constructor for a geometry which is transformed from a Well-Known Text (WKT) representation.Constructor for a geometry which is transformed from a Well-Known Binary (WKB) representation.The specified element in the interior rings of a polygon.Geometry that represents the intersection of two geometries, ignoring z and m coordinate values.Test if a geometry value spatially intersects another geometry value, ignoring z and m coordinate values.Test if a geometry has z coordinate values.Test if a curve is closed, ignoring z and m coordinates.Test if a geometry is empty.Test if a geometry has m coordinate values.Test if a curve is a ring, ignoring z and m coordinates.Test if a geometry has no anomalous points such as self intersection.Test if a geometry is well formed.The length measurement of a curve, ignoring z and m coordinate values in the calculations.Constructor for aLineString
which is transformed from a Well-Known Text (WKT) representation.Constructor for aLineString
which is transformed from a Well-Known Binary (WKB) representation.LineString
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.Constructor for a multi-line string which is transformed from a Well-Known Text (WKT) representation.Constructor for a multi-line string which is transformed from a Well-Known Binary (WKB) representation.Constructor for a multi-point which is transformed from a Well-Known Text (WKT) representation.Constructor for a multi-point which is transformed from a Well-Known Binary (WKB) representation.Constructor for a multi-polygon which is transformed from a Well-Known Text (WKT) representation.Constructor for a multi-polygon which is transformed from a Well-Known Binary (WKB) representation.MultiLineString
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.MultiPoint
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.MultiPolygon
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.The cardinality of the geometries of a geometry collection.The cardinality of the interior rings a polygon.The cardinality of the points of aLineString
.Test if a geometry value spatially overlaps another geometry value, ignoring z and m coordinate values.The length measurement of the boundary of a surface, ignoring z and m coordinates.Point geometry created from coordinate values.Constructor for a point which is transformed from a Well-Known Text (WKT) representation.Constructor for a point which is transformed from a Well-Known Binary (WKB) representation.The specified element in the points of aLineString
.A point guaranteed to spatially intersect the surface, ignoring z and m coordinates.Constructor for a polygon which is transformed from a Well-Known Text (WKT) representation.Constructor for a polygon which is transformed from a Well-Known Binary (WKB) representation.Polygon constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.Test if a geometry is spatially related to another geometry value, ignoring z and m coordinate values.Computes a geometry simplification.Computes a geometry simplification preserving topology.The spatial reference system identifier (SRID) of the geometry.The point value that is the start point of a curve, including existing z and m coordinates.Geometry that represents the symmetric difference of two geometries, ignoring z and m coordinate values.Cast a geometry to a specific instantiable subtype of geometry.Line-string representation of a curve, including the z values.Cast a geometry to a specific instantiable subtype of geometry.Cast a geometry to a specific instantiable subtype of geometry.Cast a geometry to a specific instantiable subtype of geometry.Cast a geometry to a specific instantiable subtype of geometry.Cast a geometry to a specific instantiable subtype of geometry.Test if a geometry value spatially touches another geometry value, ignoring z and m coordinate values.Transform a geometry to the specified spatial reference system.Geometry that represents the union of two geometries, ignoring z and m coordinate values.Test if a geometry value is spatially within another geometry value, ignoring z and m coordinate values.The x coordinate value of a point.The y coordinate value of a point.The z coordinate value of a point. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) final GeometryType
The geometry type of the two first parameters, ornull
if the parameter is not a geometry.(package private) final GeometryType
The geometry type of the two first parameters, ornull
if the parameter is not a geometry.final byte
The maximum number of parameters that the function expects.final byte
The minimum number of parameters that the function expects.private final Object
Type of value returned by the method as aClass
ofinvalid reference
Geometries#TYPE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
SQLMM
(int minParamCount, int maxParamCount, GeometryType geometryType1, GeometryType geometryType2, Object returnType) Creates a new enumeration value.private
Creates a new enumeration value for an operation expecting exactly two geometry objects and no other argument.private
SQLMM
(GeometryType geometryType1, Object returnType) Creates a new enumeration value for an operation expecting exactly one geometry object and no other argument. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of parameters that are geometry objects.final Optional
<GeometryType> Returns the type of geometry returned by the SQLMM function.final Class
<?> getReturnType
(Geometries<?> library) Returns the type of value returned by the SQLMM function.(package private) final boolean
Returnstrue
if the operation has at least one geometry argument and the return type is also a geometry.static SQLMM
Returns the enum constant of this type with the specified name.static SQLMM[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ST_Dimension
The number of dimensions in the geometry. -
ST_CoordDim
The number of dimensions of coordinate tuples. It depends on whether there is z values.- See Also:
-
ST_GeometryType
The SQLMM name of the geometry type. -
ST_SRID
The spatial reference system identifier (SRID) of the geometry. -
ST_Transform
Transform a geometry to the specified spatial reference system. The operation should take in account the z and m coordinate values.Limitation
- Current implementation ignores the z and m values.
- If the SRID is an integer, it is interpreted as an EPSG code.
It should be a primary key in the
"spatial_ref_sys"
table instead.
-
ST_IsEmpty
Test if a geometry is empty. -
ST_IsSimple
Test if a geometry has no anomalous points such as self intersection. This test ignores the z coordinate values. -
ST_IsValid
Test if a geometry is well formed. -
ST_Is3D
Test if a geometry has z coordinate values.- See Also:
-
ST_IsMeasured
Test if a geometry has m coordinate values.- See Also:
-
ST_Boundary
The boundary of a geometry, ignoring z and m coordinate values. -
ST_Envelope
The boundary rectangle of a geometry, ignoring z and m coordinate values. -
ST_ConvexHull
The convex hull of a geometry, ignoring z and m coordinate values. -
ST_Buffer
The geometry that represents all points whose distance from any point of a geometry is less than or equal to a specified distance. This operation ignores z and m coordinate values. This expression expects two arguments: the geometry and the distance. This distance shall be expressed in units of the geometry Coordinate Reference System. -
ST_Intersection
Geometry that represents the intersection of two geometries, ignoring z and m coordinate values. -
ST_Union
Geometry that represents the union of two geometries, ignoring z and m coordinate values. -
ST_Difference
Geometry that represents the difference of two geometries, ignoring z and m coordinate values. -
ST_SymDifference
Geometry that represents the symmetric difference of two geometries, ignoring z and m coordinate values. -
ST_Distance
Distance between two geometries, ignoring z and m coordinate values. -
ST_Equals
Test if a geometry is spatially equal to another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Equals" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_Relate
Test if a geometry is spatially related to another geometry value, ignoring z and m coordinate values. -
ST_Disjoint
Test if a geometry value is spatially disjoint from another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Disjoint" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_Intersects
Test if a geometry value spatially intersects another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Intersects" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_Touches
Test if a geometry value spatially touches another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Touches" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_Crosses
Test if a geometry value spatially crosses another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Crosses" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_Within
Test if a geometry value is spatially within another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Within" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_Contains
Test if a geometry value spatially contains another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Contains" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_Overlaps
Test if a geometry value spatially overlaps another geometry value, ignoring z and m coordinate values. This operation is similar to Filter Encoding "Overlaps" operation except in the way the CRS is selected (the SQLMM standard requires that we use the CRS of the first geometry) and in the return value when an error occurred (this implementation returnsnull
).- See Also:
-
ST_AsText
The Well-Known Text (WKT) representation of a geometry. -
ST_AsBinary
The Well-Known Binary (WKB) representation of a geometry. -
ST_GeomFromText
Constructor for a geometry which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_GeomFromWKB
Constructor for a geometry which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_Point
Point geometry created from coordinate values. In current implementation, the parameters can be:- WKT|WKB
- WKT|WKB, CoordinateReferenceSystem
- X, Y
- X, Y, CoordinateReferenceSystem
- X, Y, Z
- X, Y, Z, CoordinateReferenceSystem
-
ST_X
The x coordinate value of a point. -
ST_Y
The y coordinate value of a point. -
ST_Z
The z coordinate value of a point. -
ST_ExplicitPoint
The coordinate values as aDOUBLE PRECISION ARRAY
value. -
ST_PointFromText
Constructor for a point which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_PointFromWKB
Constructor for a point which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_Length
The length measurement of a curve, ignoring z and m coordinate values in the calculations.- See Also:
-
ST_StartPoint
The point value that is the start point of a curve, including existing z and m coordinates. -
ST_EndPoint
The point value that is the end point of a curve, including existing z and m coordinates. -
ST_IsClosed
Test if a curve is closed, ignoring z and m coordinates. -
ST_IsRing
Test if a curve is a ring, ignoring z and m coordinates. -
ST_ToLineString
Line-string representation of a curve, including the z values. -
ST_LineString
LineString
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.- See Also:
-
ST_NumPoints
The cardinality of the points of aLineString
. -
ST_PointN
The specified element in the points of aLineString
. -
ST_LineFromText
Constructor for aLineString
which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_LineFromWKB
Constructor for aLineString
which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_Area
The area measurement of a surface, ignoring z and m coordinates.Limitation
The SQLMM standard allows an optionalCHARACTER VARYING
argument for specifying the desired unit of measurement, which must be linear. This is not yet implemented. -
ST_Perimeter
The length measurement of the boundary of a surface, ignoring z and m coordinates.- See Also:
-
ST_Centroid
The 2D point value that is the mathematical centroid of the surface, ignoring z and m coordinates. -
ST_PointOnSurface
A point guaranteed to spatially intersect the surface, ignoring z and m coordinates. -
ST_Polygon
Polygon constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.- See Also:
-
ST_ExteriorRing
The exterior ring of a polygon. -
ST_NumInteriorRings
The cardinality of the interior rings a polygon. -
ST_InteriorRingN
The specified element in the interior rings of a polygon. -
ST_PolyFromText
Constructor for a polygon which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_PolyFromWKB
Constructor for a polygon which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_BdPolyFromText
Constructor for a polygon which is transformed from a Well-Known Text (WKT) representation of polylines. The first polyline defines the exterior ring and all additional polylines define interior rings. If the WKT defines directly a polygon, then it is used as-is (this is an Apache SIS extension).- See Also:
-
ST_BdPolyFromWKB
Constructor for a polygon which is transformed from a Well-Known Binary (WKB) representation of polylines. The first polyline defines the exterior ring and all additional polylines define interior rings. If the WKB defines directly a polygon, then it is used as-is (this is an Apache SIS extension).- See Also:
-
ST_GeomCollection
Collection of geometries constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of geometry components.- See Also:
-
ST_NumGeometries
The cardinality of the geometries of a geometry collection. -
ST_GeometryN
The specified element in a geometry collection. -
ST_GeomCollFromText
Constructor for a geometry collection which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_GeomCollFromWKB
Constructor for a geometry collection which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_MultiPoint
MultiPoint
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.- See Also:
-
ST_MPointFromText
Constructor for a multi-point which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_MPointFromWKB
Constructor for a multi-point which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_MultiLineString
MultiLineString
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.- See Also:
-
ST_MLineFromText
Constructor for a multi-line string which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_MLineFromWKB
Constructor for a multi-line string which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_MultiPolygon
MultiPolygon
constructed from either a Well-Known Text (WKT) representation, a Well-Known Binary (WKB) representation, or an array of points.- See Also:
-
ST_MPolyFromText
Constructor for a multi-polygon which is transformed from a Well-Known Text (WKT) representation.- See Also:
-
ST_MPolyFromWKB
Constructor for a multi-polygon which is transformed from a Well-Known Binary (WKB) representation.- See Also:
-
ST_BdMPolyFromText
Constructor for a multi-polygon which is transformed from a Well-Known Text (WKT) representation of multi line string. There is one polygon for each line-string.- See Also:
-
ST_BdMPolyFromWKB
Constructor for a multi-polygon which is transformed from a Well-Known Binary (WKB) representation of multi line string. There is one polygon for each line-string. -
ST_ToPoint
Cast a geometry to a specific instantiable subtype of geometry. -
ST_ToPolygon
Cast a geometry to a specific instantiable subtype of geometry. -
ST_ToMultiPoint
Cast a geometry to a specific instantiable subtype of geometry. -
ST_ToMultiLine
Cast a geometry to a specific instantiable subtype of geometry. -
ST_ToMultiPolygon
Cast a geometry to a specific instantiable subtype of geometry. -
ST_ToGeomColl
Cast a geometry to a specific instantiable subtype of geometry. -
ST_Simplify
Computes a geometry simplification. This function expects a geometry and a distance tolerance. The distance shall be in units of the geometry Coordinate Reference SystemNote: this function is defined in PostGIS and H2GIS but not in SQL/MM 13249-3 2011.
-
ST_SimplifyPreserveTopology
Computes a geometry simplification preserving topology. This function expects a geometry and a distance tolerance. The distance shall be in units of the geometry Coordinate Reference SystemNote: this function is defined in PostGIS and H2GIS but not in SQL/MM 13249-3 2011.
-
-
Field Details
-
minParamCount
public final byte minParamCountThe minimum number of parameters that the function expects. -
maxParamCount
public final byte maxParamCountThe maximum number of parameters that the function expects. -
geometryType1
The geometry type of the two first parameters, ornull
if the parameter is not a geometry. -
geometryType2
The geometry type of the two first parameters, ornull
if the parameter is not a geometry. -
returnType
Type of value returned by the method as aClass
ofinvalid reference
Geometries#TYPE
- See Also:
-
-
Constructor Details
-
SQLMM
Creates a new enumeration value for an operation expecting exactly one geometry object and no other argument. -
SQLMM
Creates a new enumeration value for an operation expecting exactly two geometry objects and no other argument. -
SQLMM
private SQLMM(int minParamCount, int maxParamCount, GeometryType geometryType1, GeometryType geometryType2, Object returnType) Creates a new enumeration value.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
geometryCount
public int geometryCount()Returns the number of parameters that are geometry objects. Those parameters shall be first. This value shall be betweenminParamCount
andmaxParamCount
.- Returns:
- number of parameters that are geometry objects.
-
isGeometryInOut
final boolean isGeometryInOut()Returnstrue
if the operation has at least one geometry argument and the return type is also a geometry. -
getGeometryType
Returns the type of geometry returned by the SQLMM function.- Returns:
- the type of geometry returned by the SQLMM function.
-
getReturnType
Returns the type of value returned by the SQLMM function.- Parameters:
library
- the handler used for wrapping geometry implementations.- Returns:
- type of value returned the SQLMM function.
-