Module org.apache.lucene.core

Package org.apache.lucene.search

Class HitsThresholdChecker

java.lang.Object

org.apache.lucene.search.HitsThresholdChecker

Direct Known Subclasses:

HitsThresholdChecker.GlobalHitsThresholdChecker, HitsThresholdChecker.LocalHitsThresholdChecker

abstract class HitsThresholdChecker
extends Object

Used for defining custom algorithms to allow searches to early terminate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	HitsThresholdChecker.GlobalHitsThresholdChecker	Implementation of HitsThresholdChecker which allows global hit counting
private static class	HitsThresholdChecker.LocalHitsThresholdChecker	Default implementation of HitsThresholdChecker to be used for single threaded execution

Field Summary

Fields

Modifier and Type	Field	Description
private static final HitsThresholdChecker	EXACT_HITS_COUNT_THRESHOLD_CHECKER	No-op implementation of HitsThresholdChecker that does no counting, as the threshold can never be reached.
private final int	totalHitsThreshold

Constructor Summary

Constructors

Constructor	Description
HitsThresholdChecker(int totalHitsThreshold)

Method Summary

Modifier and Type	Method	Description
(package private) static HitsThresholdChecker	create(int totalHitsThreshold)
(package private) static HitsThresholdChecker	createShared(int totalHitsThreshold)
(package private) final int	getHitsThreshold()
(package private) abstract void	incrementHitCount()
(package private) abstract boolean	isThresholdReached()
(package private) abstract ScoreMode	scoreMode()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXACT_HITS_COUNT_THRESHOLD_CHECKER

private static final HitsThresholdChecker EXACT_HITS_COUNT_THRESHOLD_CHECKER

No-op implementation of HitsThresholdChecker that does no counting, as the threshold can never be reached. This is useful for cases where early termination is never desired, so that the overhead of counting hits can be avoided.

totalHitsThreshold

private final int totalHitsThreshold

Constructor Details

HitsThresholdChecker

HitsThresholdChecker(int totalHitsThreshold)

Method Details

create

static HitsThresholdChecker create(int totalHitsThreshold)

createShared

static HitsThresholdChecker createShared(int totalHitsThreshold)

getHitsThreshold

final int getHitsThreshold()

isThresholdReached

abstract boolean isThresholdReached()

scoreMode

abstract ScoreMode scoreMode()

incrementHitCount

abstract void incrementHitCount()