Module org.apache.lucene.misc

Package org.apache.lucene.misc.search

Class MemoryAccountingBitsetCollector

java.lang.Object

org.apache.lucene.search.SimpleCollector

org.apache.lucene.misc.search.MemoryAccountingBitsetCollector

All Implemented Interfaces:

Collector, LeafCollector

public class MemoryAccountingBitsetCollector
extends SimpleCollector

Bitset collector which supports memory tracking

Field Summary

Fields

Modifier and Type	Field	Description
(package private) FixedBitSet	bitSet
(package private) int	docBase
(package private) int	length
(package private) final CollectorMemoryTracker	tracker

Constructor Summary

Constructors

Constructor	Description
MemoryAccountingBitsetCollector(CollectorMemoryTracker tracker)

Method Summary

Modifier and Type	Method	Description
void	collect(int doc)	Called once for every document matching a query, with the unbased document number.
protected void	doSetNextReader(LeafReaderContext context)	This method is called before collecting context.
ScoreMode	scoreMode()	Indicates what features are required from the scorer.

Methods inherited from class org.apache.lucene.search.SimpleCollector

getLeafCollector, setScorer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.search.Collector

setWeight

Methods inherited from interface org.apache.lucene.search.LeafCollector

collect, competitiveIterator, finish

Field Details

tracker

final CollectorMemoryTracker tracker

bitSet

FixedBitSet bitSet

length

int length

docBase

int docBase

Constructor Details

MemoryAccountingBitsetCollector

public MemoryAccountingBitsetCollector(CollectorMemoryTracker tracker)

Method Details

doSetNextReader

protected void doSetNextReader(LeafReaderContext context)
                        throws IOException

Description copied from class: SimpleCollector

This method is called before collecting context.

Overrides:

doSetNextReader in class SimpleCollector

Throws:

IOException

collect

public void collect(int doc)

Description copied from interface: LeafCollector

Called once for every document matching a query, with the unbased document number.

Note: The collection of the current segment can be terminated by throwing a CollectionTerminatedException. In this case, the last docs of the current LeafReaderContext will be skipped and IndexSearcher will swallow the exception and continue collection with the next leaf.

Note: This is called in an inner search loop. For good search performance, implementations of this method should not call StoredFields.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Specified by:

collect in interface LeafCollector

Specified by:

collect in class SimpleCollector

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.