CombinedFieldQuery

A Query that treats multiple fields as a single stream and scores terms as if they had been indexed in a single field whose values would be the union of the values of the provided fields.

The query works as follows:

  1. Given a list of fields and weights, it pretends there is a synthetic combined field where all terms have been indexed. It computes new term and collection statistics for this combined field.
  2. It uses a disjunction iterator and [IndexSearcher.similarity] to score documents.

In order for a similarity to be compatible, [Similarity.computeNorm] must be additive: the norm of the combined field is the sum of norms for each individual field. The norms must also be encoded using [SmallFloat.intToByte4]. These requirements hold for all similarities that don't customize [Similarity.computeNorm], which includes [BM25Similarity] and [DFRSimilarity]. Per-field similarities are not supported.

The query also requires that either all fields or no fields have norms enabled. Having only some fields with norms enabled can result in errors.

This query assumes that all fields share the same analyzer. Scores may not make much sense if all fields don't have the same analyzer.

The scoring is based on BM25F's simple formula described in: http://www.staff.city.ac.uk/~sb317/papers/foundations_bm25_review.pdf. This query implements the same approach but allows other similarities besides [BM25Similarity].

Types

Link copied to clipboard
class Builder

A builder for CombinedFieldQuery.

Link copied to clipboard
inner class CombinedFieldWeight(query: Query, searcher: IndexSearcher, scoreMode: ScoreMode, boost: Float) : Weight
Link copied to clipboard
object Companion
Link copied to clipboard
data class FieldAndWeight(val field: String, val weight: Float)

Properties

Link copied to clipboard

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

Functions

Link copied to clipboard
open override fun createWeight(searcher: IndexSearcher, scoreMode: ScoreMode, boost: Float): Weight

Expert: Constructs an appropriate Weight implementation for this query.

Link copied to clipboard
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.

Link copied to clipboard
open override fun hashCode(): Int

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

Link copied to clipboard
open override fun ramBytesUsed(): Long

Return the memory usage of this object in bytes. Negative values are illegal.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun visit(visitor: QueryVisitor)

Recurse through the query tree, visiting any child queries.