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, operator: Option[MatchOperator] = 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
- Alphabetic
- By Inheritance
- MatchQuery
- Serializable
- Product
- Equals
- SearchQuery
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MatchQuery(matchStr: String, fuzziness: Option[Int] = None, prefixLength: Option[Int] = None, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None, operator: Option[MatchOperator] = None)
- matchStr
input string to be matched against.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def matchOperator(operator: MatchOperator): MatchQuery
Defines how the individual match terms should be logically concatenated.
Defines how the individual match terms should be logically concatenated.
- operator
whith which logical operator the terms should be combined.
- returns
a copy of this, for chaining
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- returns
the String representation of the FTS query, which is its JSON representation without global parameters.
- Definition Classes
- SearchQuery → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()