org.springframework.data.mongodb.core.geo

Class GeoJsonPolygon

java.lang.Object

org.springframework.data.geo.Polygon

org.springframework.data.mongodb.core.geo.GeoJsonPolygon

All Implemented Interfaces:

Serializable, Iterable<Point>, Shape, GeoJson<List<GeoJsonLineString>>

public class GeoJsonPolygon
extends Polygon
implements GeoJson<List<GeoJsonLineString>>

GeoJson representation of Polygon. Unlike Polygon the GeoJsonPolygon requires a closed border. Which means that the first and last Point have to have same coordinate pairs.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

See Also:

https://geojson.org/geojson-spec.html#polygon, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeoJsonPolygon(List<Point> points) Creates new GeoJsonPolygon from the given Points.
GeoJsonPolygon(Point first, Point second, Point third, Point fourth, Point... others) Creates new GeoJsonPolygon from the given Points.

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()
GeoJsonPolygon	withInnerRing(GeoJsonLineString lineString) Creates a new GeoJsonPolygon with an inner ring defined be the given GeoJsonLineString.
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.

Methods inherited from class org.springframework.data.geo.Polygon

getPoints, iterator, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GeoJsonPolygon

public GeoJsonPolygon(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.

GeoJsonPolygon

public GeoJsonPolygon(List<Point> points)

Creates new GeoJsonPolygon from the given Points.

Parameters:

points - must not be null.

Method Detail

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.

Since:

1.10

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.

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<List<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<List<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 Polygon

hashCode

public int hashCode()

Overrides:

hashCode in class Polygon