Package org.elasticsearch.common.geo

Class GeoBoundingBox

java.lang.Object

org.elasticsearch.common.geo.GeoBoundingBox

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class GeoBoundingBox
extends Object
implements ToXContentFragment, Writeable

A class representing a Geo-Bounding-Box for use by Geo queries and aggregations that deal with extents/rectangles representing rectangular areas of interest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	BOTTOM_RIGHT_FIELD
static final ParseField	BOUNDS_FIELD
static final ParseField	LAT_FIELD
static final ParseField	LON_FIELD
static final ParseField	TOP_LEFT_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GeoBoundingBox(GeoPoint topLeft, GeoPoint bottomRight)
GeoBoundingBox(StreamInput input)

Method Summary

Modifier and Type	Method	Description
double	bottom()
GeoPoint	bottomRight()
boolean	equals(Object o)
int	hashCode()
boolean	isUnbounded()
double	left()
static GeoBoundingBox	parseBoundingBox(XContentParser parser)	Parses the bounding box and returns bottom, top, left, right coordinates
boolean	pointInBounds(double lon, double lat)	If the bounding box crosses the date-line (left greater-than right) then the longitude of the point need only to be higher than the left or lower than the right.
double	right()
double	top()
GeoPoint	topLeft()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentFragment(XContentBuilder builder, boolean buildLatLonFields)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

BOUNDS_FIELD

public static final ParseField BOUNDS_FIELD

LAT_FIELD

public static final ParseField LAT_FIELD

LON_FIELD

public static final ParseField LON_FIELD

TOP_LEFT_FIELD

public static final ParseField TOP_LEFT_FIELD

BOTTOM_RIGHT_FIELD

public static final ParseField BOTTOM_RIGHT_FIELD

Constructor Details

GeoBoundingBox

public GeoBoundingBox(GeoPoint topLeft,
 GeoPoint bottomRight)

GeoBoundingBox

public GeoBoundingBox(StreamInput input)
               throws IOException

Throws:

IOException

Method Details

isUnbounded

public boolean isUnbounded()

topLeft

public GeoPoint topLeft()

bottomRight

public GeoPoint bottomRight()

top

public double top()

bottom

public double bottom()

left

public double left()

right

public double right()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContentFragment

public XContentBuilder toXContentFragment(XContentBuilder builder,
 boolean buildLatLonFields)
                                   throws IOException

Throws:

IOException

pointInBounds

public boolean pointInBounds(double lon,
 double lat)

If the bounding box crosses the date-line (left greater-than right) then the longitude of the point need only to be higher than the left or lower than the right. Otherwise, it must be both.

Parameters:

lon - the longitude of the point

lat - the latitude of the point

Returns:

whether the point (lon, lat) is in the specified bounding box

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

parseBoundingBox

public static GeoBoundingBox parseBoundingBox(XContentParser parser)
                                       throws IOException,
ElasticsearchParseException

Parses the bounding box and returns bottom, top, left, right coordinates

Throws:

IOException

ElasticsearchParseException