Package org.hibernate.search.engine.spatial

Interface GeoPolygon

public interface GeoPolygon

A polygon in the geocentric coordinate system.

Method Summary

Modifier and Type	Method	Description
static GeoPolygon	of(List<GeoPoint> points)	Create a GeoPolygon from a list of points.
static GeoPolygon	of(GeoPoint firstPoint, GeoPoint secondPoint, GeoPoint thirdPoint, GeoPoint fourthPoint, GeoPoint... additionalPoints)	Create a GeoPolygon from points.
List<GeoPoint>	points()

Method Detail

points

List<GeoPoint> points()

Returns:

The points of this polygon. The first and last points are always identical.

of

static GeoPolygon of(List<GeoPoint> points)

Create a GeoPolygon from a list of points.

The first and last points must be identical.

Parameters:

points - The list of points. Must not be null. Must contain at least four points.

Returns:

The corresponding GeoPolygon.

Throws:

IllegalArgumentException - If the list is null, or if the first and last points are not identical.

of

static GeoPolygon of(GeoPoint firstPoint,
                     GeoPoint secondPoint,
                     GeoPoint thirdPoint,
                     GeoPoint fourthPoint,
                     GeoPoint... additionalPoints)

Create a GeoPolygon from points.

The first and last points must be identical.

Parameters:

firstPoint - The first point. Must not be null.

secondPoint - The second point. Must not be null.

thirdPoint - The third point. Must not be null.

fourthPoint - The fourth point. Must not be null.

additionalPoints - An array of additional points. Must not be null. May be empty.

Returns:

The corresponding GeoPolygon.

Throws:

IllegalArgumentException - If any of the arguments is null, or if the first and last points are not identical.