org.mongodb.morphia.geo

Class GeoJson

java.lang.Object

org.mongodb.morphia.geo.GeoJson

public final class GeoJson
extends Object

Factory class for creating GeoJSON types. See the documentation for all the types.

Method Summary

Methods

Modifier and Type	Method and Description
static GeometryCollection	geometryCollection(Geometry... geometries) Return a GeometryCollection that will let you create a GeometryCollection GeoJSON GeometryCollection.
static LineString	lineString(Point... points) Create a new LineString representing a GeoJSON LineString type.
static MultiLineString	multiLineString(LineString... lines) Create a new MultiLineString representing a GeoJSON MultiLineString type.
static MultiPoint	multiPoint(Point... points) Create a new MultiPoint representing a GeoJSON MultiPoint type.
static MultiPolygon	multiPolygon(Polygon... polygons) Create a new MultiPolygon representing a GeoJSON MultiPolygon type.
static Point	point(double latitude, double longitude) Create a new Point representing a GeoJSON point type.
static Polygon	polygon(LineString exteriorBoundary, LineString... interiorBoundaries) Lets you create a Polygon representing a GeoJSON Polygon type.
static Polygon	polygon(Point... points) Create a new Polygon representing a GeoJSON Polygon type.

Methods inherited from class java.lang.Object

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

Method Detail

point

public static Point point(double latitude,
          double longitude)

Create a new Point representing a GeoJSON point type. For a safer way to create points with latitude and longitude coordinates without mixing up the order, see pointBuilder().

Supported by server versions 2.4 and above.

Parameters:

latitude - the point's latitude coordinate

longitude - the point's longitude coordinate

Returns:

a Point instance representing a single location point defined by the given latitude and longitude

See Also:

PointBuilder

lineString

public static LineString lineString(Point... points)

Create a new LineString representing a GeoJSON LineString type. Supported by server versions 2.4 an above.

Parameters:

points - an ordered series of Points that make up the line

Returns:

a LineString instance representing a series of ordered points that make up a line

polygon

public static Polygon polygon(Point... points)

Create a new Polygon representing a GeoJSON Polygon type. This helper method uses org.mongodb.morphia.geo.GeoJson#polygon(LineString, LineString...) to create the Polygon. If you need to create Polygons with interior rings (holes), use that method.

Supported by server versions 2.4 and above.

Parameters:

points - an ordered series of Points that make up the polygon. The first and last points should be the same to close the polygon

Returns:

a Polygon as defined by the points.

Throws:

IllegalArgumentException - if the start and end points are not the same

See Also:

polygon(LineString, LineString...)

polygon

public static Polygon polygon(LineString exteriorBoundary,
              LineString... interiorBoundaries)

Lets you create a Polygon representing a GeoJSON Polygon type. This method is especially useful for defining polygons with inner rings.

Supported by server versions 2.4 and above.

Parameters:

exteriorBoundary - a LineString that contains a series of Points that make up the polygon. The first and last points should be the same to close the polygon

interiorBoundaries - optional varargs that let you define the boundaries for any holes inside the polygon

Returns:

a PolygonBuilder to be used to build up the required Polygon

Throws:

IllegalArgumentException - if the start and end points are not the same

multiPoint

public static MultiPoint multiPoint(Point... points)

Create a new MultiPoint representing a GeoJSON MultiPoint type. Supported by server versions 2.6 and above.

Parameters:

points - a set of points that make up the MultiPoint object

Returns:

a MultiPoint object containing all the given points

multiLineString

public static MultiLineString multiLineString(LineString... lines)

Create a new MultiLineString representing a GeoJSON MultiLineString type. Supported by server versions 2.6 and above.

Parameters:

lines - a set of lines that make up the MultiLineString object

Returns:

a MultiLineString object containing all the given lines

multiPolygon

public static MultiPolygon multiPolygon(Polygon... polygons)

Create a new MultiPolygon representing a GeoJSON MultiPolygon type. Supported by server versions 2.6 and above.

Parameters:

polygons - a series of polygons (which may contain inner rings)

Returns:

a MultiPolygon object containing all the given polygons

geometryCollection

public static GeometryCollection geometryCollection(Geometry... geometries)

Return a GeometryCollection that will let you create a GeometryCollection GeoJSON GeometryCollection. Supported by server version 2.6

Parameters:

geometries - a series of Geometry instances that will make up this GeometryCollection

Returns:

a GeometryCollection made up of all the geometries