c

com.couchbase.client.scala.search.queries

GeoBoundingBoxQuery

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, Serializable, Product, Equals, SearchQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeoBoundingBoxQuery
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SearchQuery
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. 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

  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def injectParams(input: JsonObject): Unit

    Override to inject query-specific parameters when doing the SearchOptions.export.

    Override to inject query-specific parameters when doing the SearchOptions.export.

    input

    the prepared JsonObject that will represent the query.

    Attributes
    protected
    Definition Classes
    GeoBoundingBoxQuerySearchQuery
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String

    returns

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

    Definition Classes
    SearchQuery → AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SearchQuery

Inherited from AnyRef

Inherited from Any

Ungrouped