org.mongodb.morphia.query

Class Shape

java.lang.Object

org.mongodb.morphia.query.Shape

public class Shape
extends Object

This encapsulates the data necessary to define a shape for queries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shape.Point Defines a Point

Method Summary

Modifier and Type	Method and Description
static Shape	box(Shape.Point bottomLeft, Shape.Point upperRight) Specifies a rectangle for a geospatial $geoWithin query to return documents that are within the bounds of the rectangle, according to their point-based location data.
static Shape	center(Shape.Point center, double radius) Specifies a circle for a $geoWithin query.
static Shape	centerSphere(Shape.Point center, double radius) Specifies a circle for a geospatial query that uses spherical geometry.
String	getGeometry()
Shape.Point[]	getPoints()
static Shape	polygon(Shape.Point... points) Specifies a polygon for a geospatial $geoWithin query on legacy coordinate pairs.
DBObject	toDBObject() Creates a DBObject from this Shape

Methods inherited from class java.lang.Object

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

Method Detail

box

public static Shape box(Shape.Point bottomLeft,
                        Shape.Point upperRight)

Specifies a rectangle for a geospatial $geoWithin query to return documents that are within the bounds of the rectangle, according to their point-based location data.

Parameters:

bottomLeft - the bottom left bound

upperRight - the upper right bound

Returns:

the box

MongoDB documentation

$box

$geoWithin

center

public static Shape center(Shape.Point center,
                           double radius)

Specifies a circle for a $geoWithin query.

Parameters:

center - the center of the circle

radius - the radius circle

Returns:

the box

MongoDB documentation

$center

$geoWithin

centerSphere

public static Shape centerSphere(Shape.Point center,
                                 double radius)

Specifies a circle for a geospatial query that uses spherical geometry.

Parameters:

center - the center of the circle

radius - the radius circle

Returns:

the box

MongoDB documentation

$centerSphere

polygon

public static Shape polygon(Shape.Point... points)

Specifies a polygon for a geospatial $geoWithin query on legacy coordinate pairs.

Parameters:

points - the points of the polygon

Returns:

the box

MongoDB documentation

$polygon

$geoWithin

getGeometry

public String getGeometry()

Returns:

the geometry of the shape

getPoints

public Shape.Point[] getPoints()

Returns:

the points of the shape

toDBObject

public DBObject toDBObject()

Creates a DBObject from this Shape

Returns:

the DBObject