Package org.h2gis.functions.spatial.others

Class ST_Clip

java.lang.Object

org.h2gis.api.AbstractFunction

org.h2gis.api.DeterministicScalarFunction

org.h2gis.functions.spatial.others.ST_Clip

All Implemented Interfaces:

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

public class ST_Clip
extends org.h2gis.api.DeterministicScalarFunction

Function to clip a [Multi]Polygon or [Multi]LineString geometry with another [Multi]Polygon or [Multi]LineString geometry.

Author:

Erwan Bocher, CNRS, 2023

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_Clip()

Method Summary

Modifier and Type	Method	Description
static org.locationtech.jts.geom.Geometry	execute(org.locationtech.jts.geom.Geometry geomToClip, org.locationtech.jts.geom.Geometry geomForClip)	Clip a [Multi]Polygon or [Multi]LineString geometry with another [Multi]Polygon or [Multi]LineString geometry
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_Clip

public ST_Clip()

Method Detail

getJavaStaticMethod

public String getJavaStaticMethod()

execute

public static org.locationtech.jts.geom.Geometry execute(org.locationtech.jts.geom.Geometry geomToClip,
                                                         org.locationtech.jts.geom.Geometry geomForClip)
                                                  throws SQLException,
                                                         org.locationtech.jts.io.ParseException

Clip a [Multi]Polygon or [Multi]LineString geometry with another [Multi]Polygon or [Multi]LineString geometry

Parameters:

geomToClip - [Multi]Polygon or [Multi]LineString

geomForClip - [Multi]Polygon or [Multi]LineString

Returns:

Throws:

SQLException

org.locationtech.jts.io.ParseException