Package types.collections.geo

Class GeoSet

java.lang.Object

types.collections.base.Set<org.locationtech.jts.geom.Geometry>

types.collections.geo.GeoSet

All Implemented Interfaces:

Base, Collection, TemporalObject

Direct Known Subclasses:

GeographySet, GeometrySet

public abstract class GeoSet
extends Set<org.locationtech.jts.geom.Geometry>

Abstract class representing a set of geo object inheriting from set type.

Since:

10/09/2023

Author:

Nidhal Mareghni

Field Summary

Fields

Modifier and Type	Field	Description
protected jnr.ffi.Pointer	_inner

Constructor Summary

Constructors

Constructor	Description
GeoSet()
GeoSet(String value)	The string constructor
GeoSet(jnr.ffi.Pointer inner)	Pointer constructor

Method Summary

Modifier and Type	Method	Description
byte[]	as_ewkb()	Returns the EWKB representation of "this", in the byte order of the machine and with its SRID, as MobilityDB's asEWKB writes it.
String	as_ewkt()	Returns the EWKT representation of "this", its WKT preceded by its SRID.
String	as_ewkt(int max_decimals)	Returns the EWKT representation of "this", its WKT preceded by its SRID.
String	as_hexewkb()	Returns the EWKB representation of "this" in hex-encoded ASCII, in the byte order of the machine and with its SRID, as MobilityDB's asHexEWKB writes it.
String	as_text()	Returns the WKT representation of "this".
String	as_text(int max_decimals)	Returns the WKT representation of "this".
boolean	contains(GeoSet other)
abstract jnr.ffi.Pointer	createInner(jnr.ffi.Pointer inner)
abstract jnr.ffi.Pointer	createStringInner(String str)
org.locationtech.jts.geom.Geometry	end_element()	Returns the last element in "this".
static GeoSet	factory(String type, jnr.ffi.Pointer inner)
abstract jnr.ffi.Pointer	get_inner()
org.locationtech.jts.geom.Geometry	intersection_geom(org.locationtech.jts.geom.Geometry geom)	Returns the intersection of "this" and "other".
GeoSet	intersection_geoset(GeoSet geo, String type)	Returns the intersection of "this" and "other".
GeoSet	minus(Object geo, String type)	Returns the difference of "this" and "other".
GeoSet	round(int decimals, String type)	Rounds the coordinate values to a number of decimal places.
int	srid()	Returns the SRID of "this".
org.locationtech.jts.geom.Geometry	start_element()	Returns the first element in "this".
org.locationtech.jts.geom.Geometry	subtract_from(Object geo, String type)
String	toString()	Return the string representation of the content of "this", its WKT.
GeoSet	union(Object geo, String type)	Returns the union of "this" and "other".

Methods inherited from class types.collections.base.Set

add, as_hexwkb, as_wkb, contains, copy, element_n, elements, eq, from_hexwkb, from_wkb, greaterThan, greaterThanOrEqual, hash, is_adjacent, is_contained_in, is_left, is_over_or_left, is_over_or_right, is_right, length, lessThan, lessThanOrEqual, mul, notEquals, num_elements, overlaps, rsub, sub, subtract_from, to_span, to_spanset

Methods inherited from class java.lang.Object

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

Field Details

_inner

protected jnr.ffi.Pointer _inner

Constructor Details

GeoSet

public GeoSet()

GeoSet

public GeoSet(jnr.ffi.Pointer inner)

Pointer constructor

Parameters:

inner - Pointer

GeoSet

public GeoSet(String value)

The string constructor

Parameters:

value - - the string with the TBoolInst value

Method Details

createInner

public abstract jnr.ffi.Pointer createInner(jnr.ffi.Pointer inner)

Specified by:

createInner in class Set<org.locationtech.jts.geom.Geometry>

createStringInner

public abstract jnr.ffi.Pointer createStringInner(String str)

Specified by:

createStringInner in class Set<org.locationtech.jts.geom.Geometry>

factory

public static GeoSet factory(String type,
 jnr.ffi.Pointer inner)

toString

public String toString()

Return the string representation of the content of "this", its WKT.

MEOS Functions:

spatialset_as_text

Overrides:

toString in class Object

Returns:

A new String instance

as_ewkb

public byte[] as_ewkb()

Returns the EWKB representation of "this", in the byte order of the machine and with its SRID, as MobilityDB's asEWKB writes it.

MEOS Functions:

spatialset_as_ewkb

Returns:

The EWKB bytes

as_hexewkb

public String as_hexewkb()

Returns the EWKB representation of "this" in hex-encoded ASCII, in the byte order of the machine and with its SRID, as MobilityDB's asHexEWKB writes it.

MEOS Functions:

spatialset_as_hexewkb

Returns:

The hex-encoded EWKB string

as_ewkt

public String as_ewkt()

Returns the EWKT representation of "this", its WKT preceded by its SRID. MEOS Functions:

spatialset_as_ewkt

Returns:

A String instance.

as_ewkt

public String as_ewkt(int max_decimals)

Returns the EWKT representation of "this", its WKT preceded by its SRID. MEOS Functions:

spatialset_as_ewkt

Parameters:

max_decimals - The maximum number of decimal digits of a coordinate

Returns:

A String instance.

as_text

public String as_text()

Returns the WKT representation of "this". MEOS Functions:

spatialset_as_text

Returns:

A String instance.

as_text

public String as_text(int max_decimals)

Returns the WKT representation of "this". MEOS Functions:

spatialset_as_text

Parameters:

max_decimals - The maximum number of decimal digits of a coordinate

Returns:

A String instance.

get_inner

public abstract jnr.ffi.Pointer get_inner()

Specified by:

get_inner in class Set<org.locationtech.jts.geom.Geometry>

start_element

public org.locationtech.jts.geom.Geometry start_element()
                                                 throws org.locationtech.jts.io.ParseException

Returns the first element in "this".

MEOS Functions:

geoset_start_value

Specified by:

start_element in class Set<org.locationtech.jts.geom.Geometry>

Returns:

A Geometry instance

Throws:

org.locationtech.jts.io.ParseException

end_element

public org.locationtech.jts.geom.Geometry end_element()
                                               throws org.locationtech.jts.io.ParseException

Returns the last element in "this".

MEOS Functions:

geoset_end_value

Specified by:

end_element in class Set<org.locationtech.jts.geom.Geometry>

Returns:

A Geometry instance

Throws:

org.locationtech.jts.io.ParseException

srid

public int srid()

Returns the SRID of "this". MEOS Functions:

spatialset_srid

Returns:

An integer

contains

public boolean contains(GeoSet other)
                 throws Exception

Throws:

Exception

intersection_geom

public org.locationtech.jts.geom.Geometry intersection_geom(org.locationtech.jts.geom.Geometry geom)
                                                     throws org.locationtech.jts.io.ParseException

Returns the intersection of "this" and "other".

MEOS Functions:

intersection_geoset_geo

intersection_set_set

Parameters:

geom - A GeoSet or Geometry instance

Returns:

An object of the same type as "other" or "None" if the intersection is empty.

Throws:

org.locationtech.jts.io.ParseException

intersection_geoset

public GeoSet intersection_geoset(GeoSet geo,
 String type)

Returns the intersection of "this" and "other".

MEOS Functions:

intersection_geoset_geo

intersection_set_set

Parameters:

geo - A GeoSet or Geometry instance

type - the type of GeoSet

Returns:

An object of the same type as "other" or "None" if the intersection is empty.

Throws:

org.locationtech.jts.io.ParseException

minus

public GeoSet minus(Object geo,
 String type)

Returns the difference of "this" and "other".

MEOS Functions:

minus_geoset_geo

minus_set_set

Parameters:

geo - A GeoSet or Geometry instance

type - the type of GeoSet

Returns:

A GeoSet instance or "null" if the difference is empty.

subtract_from

public org.locationtech.jts.geom.Geometry subtract_from(Object geo,
 String type)
                                                 throws org.locationtech.jts.io.ParseException

Throws:

org.locationtech.jts.io.ParseException

union

public GeoSet union(Object geo,
 String type)

Returns the union of "this" and "other".

MEOS Functions:

union_geoset_geo

union_set_set

Parameters:

geo - A GeoSet or Geometry instance

type - the type of GeoSet

Returns:

A GeoSet instance.

round

public GeoSet round(int decimals,
 String type)

Rounds the coordinate values to a number of decimal places.

MEOS Functions:

set_round

Parameters:

decimals - The number of decimal places to use for the coordinates.

type - the type of GeoSet

Returns:

A new GeoSet object of the same subtype of "this".