Package org.opensearch.search.query

Class EarlyTerminatingCollectorManager<C extends org.apache.lucene.search.Collector>

java.lang.Object

org.opensearch.search.query.EarlyTerminatingCollectorManager<C>

All Implemented Interfaces:

org.apache.lucene.search.CollectorManager<EarlyTerminatingCollector,ReduceableSearchResult>, EarlyTerminatingListener

public class EarlyTerminatingCollectorManager<C extends org.apache.lucene.search.Collector>
extends Object
implements org.apache.lucene.search.CollectorManager<EarlyTerminatingCollector,ReduceableSearchResult>, EarlyTerminatingListener

Manager for the EarlyTerminatingCollector

Opensearch.internal:

Method Summary

Modifier and Type	Method	Description
EarlyTerminatingCollector	newCollector()
void	onEarlyTermination(int maxCountHits, boolean forcedTermination)	Early termination event notification
ReduceableSearchResult	reduce(Collection<EarlyTerminatingCollector> collectors)

Methods inherited from class java.lang.Object

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

Method Details

newCollector

public EarlyTerminatingCollector newCollector()
                                       throws IOException

Specified by:

newCollector in interface org.apache.lucene.search.CollectorManager<EarlyTerminatingCollector,ReduceableSearchResult>

Throws:

IOException

reduce

public ReduceableSearchResult reduce(Collection<EarlyTerminatingCollector> collectors)
                              throws IOException

Specified by:

reduce in interface org.apache.lucene.search.CollectorManager<EarlyTerminatingCollector,ReduceableSearchResult>

Throws:

IOException

onEarlyTermination

public void onEarlyTermination(int maxCountHits,
 boolean forcedTermination)

Description copied from interface: EarlyTerminatingListener

Early termination event notification

Specified by:

onEarlyTermination in interface EarlyTerminatingListener

Parameters:

maxCountHits - desired maximum number of hits

forcedTermination - :true" if forced termination has been requested, "false" otherwise