Package org.elasticsearch.common.geo

Class GeoBoundingBox

java.lang.Object
org.elasticsearch.common.geo.GeoBoundingBox
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class GeoBoundingBox
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject, 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.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 org.elasticsearch.common.ParseField BOTTOM_RIGHT_FIELD  
    static org.elasticsearch.common.ParseField BOUNDS_FIELD  
    static org.elasticsearch.common.ParseField LAT_FIELD  
    static org.elasticsearch.common.ParseField LON_FIELD  
    static org.elasticsearch.common.ParseField TOP_LEFT_FIELD  

    Fields inherited from interface org.elasticsearch.common.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​(java.lang.Object o)  
    int hashCode()  
    boolean isUnbounded()  
    double left()  
    static GeoBoundingBox parseBoundingBox​(org.elasticsearch.common.xcontent.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()  
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    org.elasticsearch.common.xcontent.XContentBuilder toXContentFragment​(org.elasticsearch.common.xcontent.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.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • BOUNDS_FIELD

      public static final org.elasticsearch.common.ParseField BOUNDS_FIELD

    • LAT_FIELD

      public static final org.elasticsearch.common.ParseField LAT_FIELD

    • LON_FIELD

      public static final org.elasticsearch.common.ParseField LON_FIELD

    • TOP_LEFT_FIELD

      public static final org.elasticsearch.common.ParseField TOP_LEFT_FIELD

    • BOTTOM_RIGHT_FIELD

      public static final org.elasticsearch.common.ParseField BOTTOM_RIGHT_FIELD

  • Constructor Details

    • GeoBoundingBox

      public GeoBoundingBox​(GeoPoint topLeft, GeoPoint bottomRight)

    • GeoBoundingBox

      public GeoBoundingBox​(StreamInput input) throws java.io.IOException
      Throws:
      java.io.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 org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • toXContentFragment

      public org.elasticsearch.common.xcontent.XContentBuilder toXContentFragment​(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean buildLatLonFields) throws java.io.IOException
      Throws:
      java.io.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 java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • parseBoundingBox

      public static GeoBoundingBox parseBoundingBox​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException, ElasticsearchParseException
      Parses the bounding box and returns bottom, top, left, right coordinates
      Throws:
      java.io.IOException
      ElasticsearchParseException