case class MatchPhraseQuery(matchPhrase: String, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable
An FTS query that matches several given terms (a "phrase"), applying further processing like analyzers to them.
- matchPhrase
The input phrase to be matched against.
- Since
1.0.0
- Alphabetic
- By Inheritance
- MatchPhraseQuery
- Serializable
- Product
- Equals
- SearchQuery
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MatchPhraseQuery(matchPhrase: String, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None)
- matchPhrase
The input phrase 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): MatchPhraseQuery
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): MatchPhraseQuery
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() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def field(field: String): MatchPhraseQuery
If specified, only this field will be matched.
If specified, only this field will be matched.
- returns
a copy of this, for chaining
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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(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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated