Package org.h2gis.functions.spatial.convert

Class ST_Force3DM

java.lang.Object

org.h2gis.api.AbstractFunction

org.h2gis.api.DeterministicScalarFunction

org.h2gis.functions.spatial.convert.ST_Force3DM

All Implemented Interfaces:

org.h2gis.api.Function, org.h2gis.api.ScalarFunction

public class ST_Force3DM
extends org.h2gis.api.DeterministicScalarFunction

Forces a Geometry into 3DM mode by returning a copy with If a geometry has no M component, then a 0 M coordinate is tacked on. Z value is removed

Author:

Erwan Bocher, CNRS, 2020

Field Summary

Fields inherited from interface org.h2gis.api.Function

PROP_NAME, PROP_REMARKS

Fields inherited from interface org.h2gis.api.ScalarFunction

PROP_DETERMINISTIC

Constructor Summary

Constructors

Constructor	Description
ST_Force3DM()

Method Summary

Modifier and Type	Method	Description
static org.locationtech.jts.geom.GeometryCollection	convert(org.locationtech.jts.geom.GeometryCollection gc, double mValue)	Force the dimension of the GeometryCollection and update correctly the coordinate dimension
static org.locationtech.jts.geom.LinearRing	convert(org.locationtech.jts.geom.LinearRing linearRing, double mValue)	Force the dimension of the LinearRing and update correctly the coordinate dimension
static org.locationtech.jts.geom.LineString	convert(org.locationtech.jts.geom.LineString lineString, double mValue)	Force the dimension of the LineString and update correctly the coordinate dimension
static org.locationtech.jts.geom.MultiLineString	convert(org.locationtech.jts.geom.MultiLineString multiLineString, double mValue)	Force the dimension of the MultiLineString and update correctly the coordinate dimension
static org.locationtech.jts.geom.MultiPoint	convert(org.locationtech.jts.geom.MultiPoint mp, double mValue)	Force the dimension of the MultiPoint and update correctly the coordinate dimension
static org.locationtech.jts.geom.MultiPolygon	convert(org.locationtech.jts.geom.MultiPolygon multiPolygon, double mValue)	Force the dimension of the MultiPolygon and update correctly the coordinate dimension
static org.locationtech.jts.geom.Point	convert(org.locationtech.jts.geom.Point p, double mValue)	Force the dimension of the Point and update correctly the coordinate dimension
static org.locationtech.jts.geom.Polygon	convert(org.locationtech.jts.geom.Polygon polygon, double mValue)	Force the dimension of the Polygon and update correctly the coordinate dimension
static org.locationtech.jts.geom.Geometry	force3DM(org.locationtech.jts.geom.Geometry geom)	Converts a XY, XYZ geometry to XYM.
static org.locationtech.jts.geom.Geometry	force3DM(org.locationtech.jts.geom.Geometry geom, double mValue)	Converts a XY, XYZ geometry to XYM.
static org.locationtech.jts.geom.Geometry	forceXYM(org.locationtech.jts.geom.Geometry geom, double mValue)	Force the dimension of the geometry and update correctly the coordinate dimension
String	getJavaStaticMethod()

Methods inherited from class org.h2gis.api.AbstractFunction

addProperty, getProperty, removeProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.h2gis.api.Function

getProperty

Constructor Detail

ST_Force3DM

public ST_Force3DM()

Method Detail

getJavaStaticMethod

public String getJavaStaticMethod()

force3DM

public static org.locationtech.jts.geom.Geometry force3DM(org.locationtech.jts.geom.Geometry geom)

Converts a XY, XYZ geometry to XYM.

Parameters:

geom - Geometry

Returns:

Geometry

force3DM

public static org.locationtech.jts.geom.Geometry force3DM(org.locationtech.jts.geom.Geometry geom,
                                                          double mValue)

Converts a XY, XYZ geometry to XYM.

Parameters:

geom - Geometry

mValue - m value

Returns:

M Geometry

forceXYM

public static org.locationtech.jts.geom.Geometry forceXYM(org.locationtech.jts.geom.Geometry geom,
                                                          double mValue)

Force the dimension of the geometry and update correctly the coordinate dimension

Parameters:

geom - the input geometry

mValue - m value

Returns:

M Geometry

convert

public static org.locationtech.jts.geom.Point convert(org.locationtech.jts.geom.Point p,
                                                      double mValue)

Force the dimension of the Point and update correctly the coordinate dimension

Parameters:

p - Point

mValue - m value

Returns:

Point

convert

public static org.locationtech.jts.geom.MultiPoint convert(org.locationtech.jts.geom.MultiPoint mp,
                                                           double mValue)

Force the dimension of the MultiPoint and update correctly the coordinate dimension

Parameters:

mp - MultiPoint

mValue - m value

Returns:

MultiPoint

convert

public static org.locationtech.jts.geom.GeometryCollection convert(org.locationtech.jts.geom.GeometryCollection gc,
                                                                   double mValue)

Force the dimension of the GeometryCollection and update correctly the coordinate dimension

Parameters:

gc - GeometryCollection

mValue - m value

Returns:

GeometryCollection

convert

public static org.locationtech.jts.geom.MultiPolygon convert(org.locationtech.jts.geom.MultiPolygon multiPolygon,
                                                             double mValue)

Force the dimension of the MultiPolygon and update correctly the coordinate dimension

Parameters:

multiPolygon - MultiPolygon

mValue - m value

Returns:

M MultiPolygon

convert

public static org.locationtech.jts.geom.MultiLineString convert(org.locationtech.jts.geom.MultiLineString multiLineString,
                                                                double mValue)

Force the dimension of the MultiLineString and update correctly the coordinate dimension

Parameters:

multiLineString - MultiLineString

mValue - m value

Returns:

M MultiLineString

convert

public static org.locationtech.jts.geom.Polygon convert(org.locationtech.jts.geom.Polygon polygon,
                                                        double mValue)

Force the dimension of the Polygon and update correctly the coordinate dimension

Parameters:

polygon - Polygon

mValue - M value

Returns:

M Polygon

convert

public static org.locationtech.jts.geom.LineString convert(org.locationtech.jts.geom.LineString lineString,
                                                           double mValue)

Force the dimension of the LineString and update correctly the coordinate dimension

Parameters:

lineString - LineString

mValue - M value

Returns:

M LineString

convert

public static org.locationtech.jts.geom.LinearRing convert(org.locationtech.jts.geom.LinearRing linearRing,
                                                           double mValue)

Force the dimension of the LinearRing and update correctly the coordinate dimension

Parameters:

linearRing - LinearRing

mValue - M value

Returns:

M LinearRing