core/org.gnit.lucenekmp.search/SynonymQuery

SynonymQuery

A query that treats multiple terms as synonyms.

For scoring purposes, this query tries to score the terms as if you had indexed them as one term: it will match any of the terms but only invoke the similarity a single time, scoring the sum of all term frequencies for the document.

Types

Builder

class Builder(field: String)

A builder for SynonymQuery.

Companion

object Companion

Properties

field

val field: String

Returns the field name of this SynonymQuery

Functions

createWeight

open override fun createWeight(searcher: IndexSearcher, scoreMode: ScoreMode, boost: Float): Weight

Expert: Constructs an appropriate Weight implementation for this query.

equals

open operator override fun equals(other: Any?): Boolean

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly.

getTerms

fun getTerms(): MutableList<Term>

Returns the terms of this SynonymQuery

hashCode

open override fun hashCode(): Int

Override and implement query hash code properly in a subclass. This is required so that [ ] works properly.

rewrite

open override fun rewrite(indexSearcher: IndexSearcher): Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

toString

open override fun toString(): String

Prints a query to a string.

open override fun toString(field: String?): String

Prints a query to a string, with field assumed to be the default field and omitted.

visit

open override fun visit(visitor: QueryVisitor)

Recurse through the query tree, visiting any child queries.