EarlyTerminatingCollector (Solr 9.3.0 core API)

java.lang.Object
- org.apache.lucene.search.FilterCollector
- - org.apache.solr.search.EarlyTerminatingCollector

All Implemented Interfaces:

org.apache.lucene.search.Collector
```
public class EarlyTerminatingCollector
extends org.apache.lucene.search.FilterCollector
```
A wrapper Collector that throws EarlyTerminatingCollectorException) once a specified maximum number of documents are collected.

Field Summary
- Fields inherited from class org.apache.lucene.search.FilterCollector
  in

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.apache.lucene.search.LeafCollector`	`getLeafCollector(org.apache.lucene.index.LeafReaderContext context)`

Methods inherited from class org.apache.lucene.search.FilterCollector
scoreMode, setWeight, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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
  - getLeafCollector
```
public org.apache.lucene.search.LeafCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext context)
                                                        throws IOException
```
    Specified by:
    
    getLeafCollector in interface org.apache.lucene.search.Collector
    
    Overrides:
    
    getLeafCollector in class org.apache.lucene.search.FilterCollector
    
    Throws:
    
    IOException