org.springframework.data.mongodb.core.geo

Class Sphere

java.lang.Object

org.springframework.data.mongodb.core.geo.Sphere

All Implemented Interfaces:

Serializable, Shape

public class Sphere
extends Object
implements Shape

Represents a geospatial sphere value.

Since:

1.5

Author:

Thomas Darimont, Mark Paluch

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND

Constructor Summary

Constructors

Constructor and Description
Sphere(Circle circle) Creates a Sphere from the given Circle.
Sphere(Point center, Distance radius) Creates a Sphere around the given center Point with the given radius.
Sphere(Point center, double radius) Creates a Sphere around the given center Point with the given radius.

Method Summary

Modifier and Type	Method and Description
List<? extends Object>	asList() Returns the Shape as a list of usually Double or Lists of Doubles.
boolean	equals(Object obj)
Point	getCenter() Returns the center of the Circle.
String	getCommand() Returns the command to be used to create the $within criterion.
Distance	getRadius() Returns the radius of the Circle.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND

public static final String COMMAND

See Also:

Constant Field Values

Constructor Detail

Sphere

public Sphere(Point center,
              Distance radius)

Creates a Sphere around the given center Point with the given radius.

Parameters:

center - must not be null.

radius - must not be null.

Sphere

public Sphere(Point center,
              double radius)

Creates a Sphere around the given center Point with the given radius.

Parameters:

center -

radius -

Sphere

public Sphere(Circle circle)

Creates a Sphere from the given Circle.

Parameters:

circle -

Method Detail

getCenter

public Point getCenter()

Returns the center of the Circle.

Returns:

will never be null.

getRadius

public Distance getRadius()

Returns the radius of the Circle.

Returns:

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asList

public List<? extends Object> asList()

Returns the Shape as a list of usually Double or Lists of Doubles. Wildcard bound to allow implementations to return a more concrete element type.

Returns:

getCommand

public String getCommand()

Returns the command to be used to create the $within criterion.

Returns: