core/org.gnit.lucenekmp.search/BoostQuery

BoostQuery

class BoostQuery(query: Query, boost: Float) : Query

A Query wrapper that allows to give a boost to the wrapped query. Boost values that are less than one will give less importance to this query compared to other ones while values that are greater than one will give more importance to the scores returned by this query.

More complex boosts can be applied by using FunctionScoreQuery in the lucene-queries module

Constructors

BoostQuery

constructor(query: Query, boost: Float)

Properties

boost

val boost: Float

Return the applied boost.

query

val query: Query

Return the wrapped Query.

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.

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(field: String?): String

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

open override fun toString(): String

Prints a query to a string.

visit

open override fun visit(visitor: QueryVisitor)

Recurse through the query tree, visiting any child queries.