Module org.elasticsearch.server

Package org.elasticsearch.common.geo

Class GeoBoundingBox

java.lang.Object

org.elasticsearch.common.geo.BoundingBox<GeoPoint>

org.elasticsearch.common.geo.GeoBoundingBox

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class GeoBoundingBox
extends BoundingBox<GeoPoint>

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

Modifier and Type	Class	Description
protected static class	GeoBoundingBox.GeoBoundsParser

Nested classes/interfaces inherited from class org.elasticsearch.common.geo.BoundingBox

BoundingBox.BoundsParser<T extends BoundingBox<? extends SpatialPoint>>

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	LAT_FIELD
static final ParseField	LON_FIELD

Fields inherited from class org.elasticsearch.common.geo.BoundingBox

BOTTOM_RIGHT_FIELD, bottomRight, BOUNDS_FIELD, TOP_LEFT_FIELD, topLeft

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GeoPoint	bottomRight()
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.
GeoPoint	topLeft()
XContentBuilder	toXContentFragment(XContentBuilder builder)
XContentBuilder	toXContentFragmentWithArray(XContentBuilder builder)	There exists a special case where we use an array format for building the XContent for the bounds.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.common.geo.BoundingBox

bottom, equals, hashCode, isUnbounded, left, right, top, toString, toXContent

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

LAT_FIELD

public static final ParseField LAT_FIELD

LON_FIELD

public static final ParseField LON_FIELD

Constructor Details

GeoBoundingBox

public GeoBoundingBox(GeoPoint topLeft,
 GeoPoint bottomRight)

GeoBoundingBox

public GeoBoundingBox(StreamInput input)
               throws IOException

Throws:

IOException

Method Details

topLeft

public GeoPoint topLeft()

Overrides:

topLeft in class BoundingBox<GeoPoint>

bottomRight

public GeoPoint bottomRight()

Overrides:

bottomRight in class BoundingBox<GeoPoint>

toXContentFragment

public XContentBuilder toXContentFragment(XContentBuilder builder)
                                   throws IOException

Specified by:

toXContentFragment in class BoundingBox<GeoPoint>

Throws:

IOException

toXContentFragmentWithArray

public XContentBuilder toXContentFragmentWithArray(XContentBuilder builder)
                                            throws IOException

There exists a special case where we use an array format for building the XContent for the bounds. Specifically the GeoBoundingBoxQueryBuilder makes use of this. All other cases build a keyed map.

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.

Throws:

IOException

parseBoundingBox

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

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

Throws:

IOException

ElasticsearchParseException