case class TermRangeQuery(min: Option[String] = None, inclusiveMin: Option[Boolean] = None, max: Option[String] = None, inclusiveMax: Option[Boolean] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable

An FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.

At least one of min and max must be provided.

Since

1.0.0

Linear Supertypes
Serializable, Product, Equals, SearchQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TermRangeQuery
  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 TermRangeQuery(min: Option[String] = None, inclusiveMin: Option[Boolean] = None, max: Option[String] = None, inclusiveMax: Option[Boolean] = None, field: Option[String] = None, boost: Option[Double] = None)

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): TermRangeQuery

    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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def field(field: String): TermRangeQuery

    If specified, only this field will be matched.

    If specified, only this field will be matched.

    returns

    a copy of this, for chaining

  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def max(max: String): TermRangeQuery

    Sets the upper boundary of the range.

    Sets the upper boundary of the range. The upper boundary is considered exclusive by default on the server side.

    returns

    a copy of this, for chaining

  12. def max(max: String, inclusive: Boolean): TermRangeQuery

    Sets the upper boundary of the range, inclusive or not depending on the second parameter.

    Sets the upper boundary of the range, inclusive or not depending on the second parameter.

    returns

    a copy of this, for chaining

  13. def min(min: String): TermRangeQuery

    Sets the lower boundary of the range.

    Sets the lower boundary of the range. The lower boundary is considered inclusive by default on the server side.

    returns

    a copy of this, for chaining

  14. def min(min: String, inclusive: Boolean): TermRangeQuery

    Sets the lower boundary of the range, inclusive or not depending on the second parameter.

    Sets the lower boundary of the range, inclusive or not depending on the second parameter.

    returns

    a copy of this, for chaining

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String

    returns

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

    Definition Classes
    SearchQuery → AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SearchQuery

Inherited from AnyRef

Inherited from Any

Ungrouped