org.springframework.data.elasticsearch.core.geo

Class GeoJsonPolygon

java.lang.Object

org.springframework.data.elasticsearch.core.geo.GeoJsonPolygon

All Implemented Interfaces:

GeoJson<Iterable<GeoJsonLineString>>

public class GeoJsonPolygon
extends Object
implements GeoJson<Iterable<GeoJsonLineString>>

GeoJson representation of a polygon.
Copied from Spring Data Mongodb

Since:

4.1

Author:

Christoph Strobl, Mark Paluch, Peter-Josef Meisch

See Also:

https://geojson.org/geojson-spec.html#polygon

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<GeoJsonLineString>	getCoordinates() The value of the coordinates member is always an Iterable.
String	getType() String value representing the type of the GeoJson object.
int	hashCode()
static GeoJsonPolygon	of(GeoJsonLineString geoJsonLineString) Creates new GeoJsonPolygon from the given GeoJsonLineString.
static GeoJsonPolygon	of(GeoPoint first, GeoPoint second, GeoPoint third, GeoPoint fourth, GeoPoint... others) Creates new GeoJsonPolygon from the given GeoPoints.
static GeoJsonPolygon	of(List<Point> points) Creates new GeoJsonPolygon from the given Points.
static GeoJsonPolygon	of(Point first, Point second, Point third, Point fourth, Point... others) Creates new GeoJsonPolygon from the given Points.
static GeoJsonPolygon	ofGeoPoints(List<GeoPoint> geoPoints) Creates new GeoJsonPolygon from the given GeoPoints.
String	toString()
GeoJsonPolygon	withInnerRing(GeoJsonLineString lineString) Creates a new GeoJsonPolygon with an inner ring defined be the given GeoJsonLineString.
GeoJsonPolygon	withInnerRing(GeoPoint first, GeoPoint second, GeoPoint third, GeoPoint fourth, GeoPoint... others) Creates a new GeoJsonPolygon with an inner ring defined be the given GeoPoints.
GeoJsonPolygon	withInnerRing(List<Point> points) Creates a new GeoJsonPolygon with an inner ring defined be the given List of Points.
GeoJsonPolygon	withInnerRing(Point first, Point second, Point third, Point fourth, Point... others) Creates a new GeoJsonPolygon with an inner ring defined be the given Points.
GeoJsonPolygon	withInnerRingOfGeoPoints(List<GeoPoint> geoPoints) Creates a new GeoJsonPolygon with an inner ring defined be the given List of GeoPoints.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.elasticsearch.core.geo.GeoJson

of, toJson

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Method Detail

of

public static GeoJsonPolygon of(GeoJsonLineString geoJsonLineString)

Creates new GeoJsonPolygon from the given GeoJsonLineString.

Parameters:

geoJsonLineString - must not be null.

of

public static GeoJsonPolygon of(List<Point> points)

Creates new GeoJsonPolygon from the given Points.

Parameters:

points - must not be null.

ofGeoPoints

public static GeoJsonPolygon ofGeoPoints(List<GeoPoint> geoPoints)

Creates new GeoJsonPolygon from the given GeoPoints.

Parameters:

geoPoints - must not be null.

of

public static GeoJsonPolygon of(Point first,
                                Point second,
                                Point third,
                                Point fourth,
                                Point... others)

Creates new GeoJsonPolygon from the given Points.

Parameters:

first - must not be null.

second - must not be null.

third - must not be null.

fourth - must not be null

others - can be empty.

of

public static GeoJsonPolygon of(GeoPoint first,
                                GeoPoint second,
                                GeoPoint third,
                                GeoPoint fourth,
                                GeoPoint... others)

Creates new GeoJsonPolygon from the given GeoPoints.

Parameters:

first - must not be null.

second - must not be null.

third - must not be null.

fourth - must not be null

others - can be empty.

withInnerRing

public GeoJsonPolygon withInnerRing(Point first,
                                    Point second,
                                    Point third,
                                    Point fourth,
                                    Point... others)

Creates a new GeoJsonPolygon with an inner ring defined be the given Points.

Parameters:

first - must not be null.

second - must not be null.

third - must not be null.

fourth - must not be null.

others - can be empty.

Returns:

new GeoJsonPolygon.

withInnerRing

public GeoJsonPolygon withInnerRing(GeoPoint first,
                                    GeoPoint second,
                                    GeoPoint third,
                                    GeoPoint fourth,
                                    GeoPoint... others)

Creates a new GeoJsonPolygon with an inner ring defined be the given GeoPoints.

Parameters:

first - must not be null.

second - must not be null.

third - must not be null.

fourth - must not be null.

others - can be empty.

Returns:

new GeoJsonPolygon.

withInnerRing

public GeoJsonPolygon withInnerRing(List<Point> points)

Creates a new GeoJsonPolygon with an inner ring defined be the given List of Points.

Parameters:

points - must not be null.

Returns:

new GeoJsonPolygon.

withInnerRingOfGeoPoints

public GeoJsonPolygon withInnerRingOfGeoPoints(List<GeoPoint> geoPoints)

Creates a new GeoJsonPolygon with an inner ring defined be the given List of GeoPoints.

Parameters:

geoPoints - must not be null.

Returns:

new GeoJsonPolygon.

withInnerRing

public GeoJsonPolygon withInnerRing(GeoJsonLineString lineString)

Creates a new GeoJsonPolygon with an inner ring defined be the given GeoJsonLineString.

Parameters:

lineString - must not be null.

Returns:

new GeoJsonPolygon.

Since:

1.10

getType

public String getType()

Description copied from interface: GeoJson

String value representing the type of the GeoJson object.

Specified by:

getType in interface GeoJson<Iterable<GeoJsonLineString>>

Returns:

will never be null.

See Also:

https://geojson.org/geojson-spec.html#geojson-objects

getCoordinates

public List<GeoJsonLineString> getCoordinates()

Description copied from interface: GeoJson

The value of the coordinates member is always an Iterable. The structure for the elements within is determined by GeoJson.getType() of geometry.

Specified by:

getCoordinates in interface GeoJson<Iterable<GeoJsonLineString>>

Returns:

will never be null.

See Also:

https://geojson.org/geojson-spec.html#geometry-objects

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object