case class MatchQuery(matchStr: String, fuzziness: Option[Int] = None, prefixLength: Option[Int] = None, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable

An FTS query that matches a given term, applying further processing to it like analyzers, stemming and even fuzziness.

matchStr

input string to be matched against.

Since

1.0.0

Linear Supertypes
Serializable, Serializable, Product, Equals, SearchQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MatchQuery
  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 MatchQuery(matchStr: String, fuzziness: Option[Int] = None, prefixLength: Option[Int] = None, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None)

    matchStr

    input string to be matched against.

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. def analyzer(analyzer: String): MatchQuery

    Analyzers are used to transform input text into a stream of tokens for indexing.

    Analyzers are used to transform input text into a stream of tokens for indexing. The Server comes with built-in analyzers and the users can create their own.

    analyzer

    The string here is the name of the analyzer used.

    returns

    a copy of this, for chaining

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def boost(boost: Double): MatchQuery

    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

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def field(field: String): MatchQuery

    If specified, only this field will be matched.

    If specified, only this field will be matched.

    returns

    a copy of this, for chaining

  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fuzziness(fuzziness: Int): MatchQuery

    If a fuzziness is specified, variations of the term can be searched.

    If a fuzziness is specified, variations of the term can be searched. Additionally, if fuzziness is enabled then the prefix_length parameter is also taken into account (see below).

    For now the server interprets the fuzziness factor as a "Levenshtein edit distance" to apply on the term.

    returns

    a copy of this, for chaining

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. 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
    MatchQuerySearchQuery
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def prefixLength(prefixLength: Int): MatchQuery

    This parameter can be used to require that the term also have the same prefix of the specified length.

    This parameter can be used to require that the term also have the same prefix of the specified length.

    returns

    a copy of this, for chaining

  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(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. 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