queries/org.gnit.lucenekmp.queries.intervals/IntervalQuery

IntervalQuery

class IntervalQuery : Query

A query that retrieves documents containing intervals returned from an IntervalsSource

Static constructor functions for various different sources can be found in the [Intervals] class

Scores for this query are computed as a function of the sloppy frequency of intervals appearing in a particular document. Sloppy frequency is calculated from the number of matching intervals, and their width, with wider intervals contributing lower values. The scores can be adjusted with two optional parameters:

  • pivot - the sloppy frequency value at which the overall score of the document will equal 0.5. The default value is 1
  • exp - higher values of this parameter make the function grow more slowly below the pivot and faster higher than the pivot. The default value is 1

Optimal values for both pivot and exp depend on the type of queries and corpus of documents being queried.

Scores are bounded to between 0 and 1. For higher contributions, wrap the query in a [org.gnit.lucenekmp.search.BoostQuery]

Constructors

Link copied to clipboard
constructor(field: String, intervalsSource: IntervalsSource)

Create a new IntervalQuery

constructor(field: String, intervalsSource: IntervalsSource, pivot: Float)

Create a new IntervalQuery with a scoring pivot

constructor(field: String, intervalsSource: IntervalsSource, pivot: Float, exp: Float)

Create a new IntervalQuery with a scoring pivot and exponent

Properties

Link copied to clipboard
val field: String

The field to query

Functions

Link copied to clipboard
open override fun createWeight(searcher: IndexSearcher, scoreMode: ScoreMode, boost: Float): Weight
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open fun rewrite(indexSearcher: IndexSearcher): Query
Link copied to clipboard
open override fun toString(field: String?): String
open override fun toString(): String
Link copied to clipboard
open override fun visit(visitor: QueryVisitor)
Generated by Dokka
© 2026 Copyright