core/org.gnit.lucenekmp.search/BooleanQuery

BooleanQuery

class BooleanQuery : Query, Iterable<BooleanClause>

A Query that matches documents matching boolean combinations of other queries, e.g. [ ]s, PhraseQuerys or other BooleanQuerys.

Types

A builder for boolean queries.

Properties

isPureDisjunction

val isPureDisjunction: Boolean

isTwoClausePureDisjunctionWithTerms

val isTwoClausePureDisjunctionWithTerms: Boolean

minimumNumberShouldMatch

val minimumNumberShouldMatch: Int

Gets the minimum number of the optional BooleanClauses which must be satisfied.

Functions

fun clauses(): MutableList<BooleanClause>

Return a list of the clauses of this BooleanQuery.

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

Expert: Constructs an appropriate Weight implementation for this query.

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

Compares the specified object with this boolean query for equality. Returns true if and only if the provided object

fun getClauses(occur: BooleanClause.Occur): MutableCollection<Query>

Return the collection of queries for the given Occur.

open override fun hashCode(): Int

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

open operator override fun iterator(): MutableIterator<BooleanClause>

Returns an iterator on the clauses in this query. It implements the Iterable interface to make it possible to do:

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.

rewriteNoScoring

fun rewriteNoScoring(): BooleanQuery

rewriteTwoClauseDisjunctionWithTermsForCount

fun rewriteTwoClauseDisjunctionWithTermsForCount(indexSearcher: IndexSearcher): Array<Query>

Rewrite a single two clause disjunction query with terms to two term queries and a conjunction query using the inclusion–exclusion principle.

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

Prints a user-readable version of this query.

open override fun toString(): String

Prints a query to a string.

open override fun visit(visitor: QueryVisitor)

Recurse through the query tree, visiting any child queries.