case class BooleanQuery extends SearchQuery with Product with Serializable

A compound FTS query that allows various combinations of sub-queries.

Since

1.0.0

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

Value Members

  1. def boost(boost: Double): BooleanQuery

    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 must(mustQueries: SearchQuery*): BooleanQuery

    Results must satisfy all of these queries.

    Results must satisfy all of these queries.

    returns

    a copy of this, for chaining

  3. def mustNot(mustNotQueries: SearchQuery*): BooleanQuery

    Results must not satisfy any of these queries.

    Results must not satisfy any of these queries.

    returns

    a copy of this, for chaining

  4. def productElementNames: Iterator[String]
    Definition Classes
    Product
  5. def should(shouldQueries: SearchQuery*): BooleanQuery

    Results should satisfy all of these queries.

    Results should satisfy all of these queries.

    returns

    a copy of this, for chaining

  6. def shouldMin(minForShould: Int): BooleanQuery

    If a hit satisfies at least this many queries in the should section, its score will be boosted.

    If a hit satisfies at least this many queries in the should section, its score will be boosted. By default, this is set to 1.

    returns

    a copy of this, for chaining

  7. def toString(): String

    returns

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

    Definition Classes
    SearchQuery → AnyRef → Any