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

Constructor Summary

Constructors

Constructor	Description
HitsThresholdChecker()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

HitsThresholdChecker

HitsThresholdChecker()

Method Details

create

public static HitsThresholdChecker create(int totalHitsThreshold)

createShared

public static HitsThresholdChecker createShared(int totalHitsThreshold)

incrementHitCount

public abstract void incrementHitCount()

scoreMode

public abstract ScoreMode scoreMode()

getHitsThreshold

public abstract int getHitsThreshold()

isThresholdReached

public abstract boolean isThresholdReached()