org.apache.solr.search

Class EarlyTerminatingCollector

java.lang.Object

org.apache.lucene.search.Collector

org.apache.solr.search.EarlyTerminatingCollector

public class EarlyTerminatingCollector
extends org.apache.lucene.search.Collector

A wrapper Collector that throws EarlyTerminatingCollectorException) once a specified maximum number of documents are collected.

Constructor Summary

Constructors

Constructor and Description
EarlyTerminatingCollector(org.apache.lucene.search.Collector delegate, int maxDocsToCollect) Wraps a Collector, throwing EarlyTerminatingCollectorException once the specified maximum is reached.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsDocsOutOfOrder() This collector requires that docs be collected in order, otherwise the computed number of scanned docs in the resulting EarlyTerminatingCollectorException will be meaningless.
void	collect(int doc)
void	setNextReader(org.apache.lucene.index.AtomicReaderContext context)
void	setScorer(org.apache.lucene.search.Scorer scorer)

Methods inherited from class java.lang.Object

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

Constructor Detail

EarlyTerminatingCollector

public EarlyTerminatingCollector(org.apache.lucene.search.Collector delegate,
                                 int maxDocsToCollect)

Wraps a Collector, throwing EarlyTerminatingCollectorException once the specified maximum is reached.

Parameters:

delegate - - the Collector to wrap.

maxDocsToCollect - - the maximum number of documents to Collect

Method Detail

acceptsDocsOutOfOrder

public boolean acceptsDocsOutOfOrder()

This collector requires that docs be collected in order, otherwise the computed number of scanned docs in the resulting EarlyTerminatingCollectorException will be meaningless.

Specified by:

acceptsDocsOutOfOrder in class org.apache.lucene.search.Collector

collect

public void collect(int doc)
             throws IOException

Specified by:

collect in class org.apache.lucene.search.Collector

Throws:

IOException

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext context)
                   throws IOException

Specified by:

setNextReader in class org.apache.lucene.search.Collector

Throws:

IOException

setScorer

public void setScorer(org.apache.lucene.search.Scorer scorer)
               throws IOException

Specified by:

setScorer in class org.apache.lucene.search.Collector

Throws:

IOException