Module org.elasticsearch.server

Package org.elasticsearch.common.geo

Class BoundingBox<T extends SpatialPoint>

java.lang.Object

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

All Implemented Interfaces:

GenericNamedWriteable, NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

Direct Known Subclasses:

GeoBoundingBox

public abstract class BoundingBox<T extends SpatialPoint>
extends Object
implements ToXContentFragment, GenericNamedWriteable

A class representing a Bounding-Box for use by Geo and Cartesian 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	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	BOTTOM_RIGHT_FIELD
protected final T	bottomRight
static final ParseField	BOUNDS_FIELD
static final ParseField	TOP_LEFT_FIELD
protected final T	topLeft

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BoundingBox(T topLeft, T bottomRight)

Method Summary

Modifier and Type	Method	Description
final double	bottom()
T	bottomRight()
boolean	equals(Object o)
int	hashCode()
boolean	isUnbounded()
final double	left()
final double	right()
final double	top()
T	topLeft()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
abstract XContentBuilder	toXContentFragment(XContentBuilder builder)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

getMinimalSupportedVersion, getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Field Details

BOUNDS_FIELD

public static final ParseField BOUNDS_FIELD

TOP_LEFT_FIELD

public static final ParseField TOP_LEFT_FIELD

BOTTOM_RIGHT_FIELD

public static final ParseField BOTTOM_RIGHT_FIELD

topLeft

protected final T extends SpatialPoint topLeft

bottomRight

protected final T extends SpatialPoint bottomRight

Constructor Details

BoundingBox

public BoundingBox(T topLeft,
 T bottomRight)

Method Details

isUnbounded

public boolean isUnbounded()

topLeft

public T topLeft()

bottomRight

public T bottomRight()

top

public final double top()

bottom

public final double bottom()

left

public final double left()

right

public final double right()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContentFragment

public abstract XContentBuilder toXContentFragment(XContentBuilder builder)
                                            throws IOException

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