org.hibernate.ogm.datastore.mongodb.type

Class GeoPolygon

java.lang.Object

org.hibernate.ogm.datastore.mongodb.type.AbstractGeoJsonObject

org.hibernate.ogm.datastore.mongodb.type.GeoPolygon

All Implemented Interfaces:

Serializable

@Experimental
public class GeoPolygon
extends AbstractGeoJsonObject

Type used to represent a GeoJSON Polygon in MongoDB and support spatial queries.

Author:

Guillaume Smet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
GeoPolygon(GeoPoint firstPoint, GeoPoint secondPoint, GeoPoint thirdPoint, GeoPoint fourthPoint, GeoPoint... additionalPoints) Instantiates a new Polygon.
GeoPolygon(List<GeoPoint> exteriorRing) Instantiates a new Polygon.

Method Summary

Modifier and Type	Method and Description
GeoPolygon	addHole(GeoPoint firstPoint, GeoPoint secondPoint, GeoPoint thirdPoint, GeoPoint fourthPoint, GeoPoint... additionalPoints) Adds a new hole to the polygon.
GeoPolygon	addHole(List<GeoPoint> hole) Adds a new hole to the polygon.
GeoPolygon	addHoles(List<List<GeoPoint>> holes) Adds new holes to the polygon.
boolean	equals(Object obj)
static GeoPolygon	fromDocument(org.bson.Document document)
List<GeoPoint>	getExternalRing() Returns the external ring of the polygon.
List<List<GeoPoint>>	getRings()
int	hashCode()
protected org.bson.BsonArray	toCoordinates()
String	toString()

Methods inherited from class org.hibernate.ogm.datastore.mongodb.type.AbstractGeoJsonObject

checkType, toBsonDocument

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

GeoPolygon

public GeoPolygon(List<GeoPoint> exteriorRing)

Instantiates a new Polygon.

Parameters:

exteriorRing - the exterior ring of the polygon, it cannot self-intersect

GeoPolygon

public GeoPolygon(GeoPoint firstPoint,
                  GeoPoint secondPoint,
                  GeoPoint thirdPoint,
                  GeoPoint fourthPoint,
                  GeoPoint... additionalPoints)

Instantiates a new Polygon.

Parameters:

firstPoint - the first point of the polygon

secondPoint - the second point of the polygon

thirdPoint - the third point of the polygon

fourthPoint - the third point of the polygon

additionalPoints - the additional points of the polygon

Method Detail

addHole

public GeoPolygon addHole(List<GeoPoint> hole)

Adds a new hole to the polygon.

Parameters:

hole - a hole, must be contained in the exterior ring and must not overlap or intersect another hole

Returns:

this for chaining

addHole

public GeoPolygon addHole(GeoPoint firstPoint,
                          GeoPoint secondPoint,
                          GeoPoint thirdPoint,
                          GeoPoint fourthPoint,
                          GeoPoint... additionalPoints)

Adds a new hole to the polygon.

Parameters:

firstPoint - the first point of the polygon

secondPoint - the second point of the polygon

thirdPoint - the third point of the polygon

fourthPoint - the third point of the polygon

additionalPoints - the additional points of the polygon

addHoles

public GeoPolygon addHoles(List<List<GeoPoint>> holes)

Adds new holes to the polygon.

Parameters:

holes - holes, must be contained in the exterior ring and must not overlap or intersect another hole

Returns:

this for chaining

getExternalRing

public List<GeoPoint> getExternalRing()

Returns the external ring of the polygon.

Returns:

the external ring

getRings

public List<List<GeoPoint>> getRings()

Returns:

the rings of the polygon

toCoordinates

protected org.bson.BsonArray toCoordinates()

Specified by:

toCoordinates in class AbstractGeoJsonObject

fromDocument

public static GeoPolygon fromDocument(org.bson.Document document)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object