case class GeoBoundingBoxQuery(topLeftLon: Double, topLeftLat: Double, bottomRightLon: Double, bottomRightLat: Double, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable

An FTS query which finds all matches within a given box (identified by the upper left and lower right corner coordinates).

topLeftLon

the longitude of the top-left point of the box

topLeftLat

the latitude of the top-left point of the box

bottomRightLon

the longitude of the bottom-right point of the box

bottomRightLat

the latitude of the bottom-right point of the box

Since

1.0.0

Linear Supertypes
Serializable, Product, Equals, SearchQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeoBoundingBoxQuery
  2. Serializable
  3. Product
  4. Equals
  5. SearchQuery
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GeoBoundingBoxQuery(topLeftLon: Double, topLeftLat: Double, bottomRightLon: Double, bottomRightLat: Double, field: Option[String] = None, boost: Option[Double] = None)

    topLeftLon

    the longitude of the top-left point of the box

    topLeftLat

    the latitude of the top-left point of the box

    bottomRightLon

    the longitude of the bottom-right point of the box

    bottomRightLat

    the latitude of the bottom-right point of the box

Value Members

  1. def boost(boost: Double): GeoBoundingBoxQuery

    The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1)

    The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1)

    boost

    the boost parameter, which must be >= 0

    returns

    a copy of this, for chaining

  2. def field(field: String): GeoBoundingBoxQuery

    If specified, only this field will be matched.

    If specified, only this field will be matched.

    returns

    a copy of this, for chaining

  3. def productElementNames: Iterator[String]
    Definition Classes
    Product
  4. def productIterator: Iterator[Any]
    Definition Classes
    Product
  5. def toString(): String

    returns

    the String representation of the FTS query, which is its JSON representation without global parameters.

    Definition Classes
    SearchQuery → AnyRef → Any