Module org.apache.lucene.sandbox
Package org.apache.lucene.sandbox.facet
Class FacetFieldLeafCollector
java.lang.Object
org.apache.lucene.sandbox.facet.FacetFieldLeafCollector
- All Implemented Interfaces:
LeafCollector
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final LeafReaderContext
private final FacetCutter
private LeafFacetCutter
private LeafFacetRecorder
private final FacetRecorder
-
Constructor Summary
ConstructorsConstructorDescriptionFacetFieldLeafCollector
(LeafReaderContext context, FacetCutter cutter, FacetRecorder recorder) -
Method Summary
Modifier and TypeMethodDescriptionvoid
collect
(int doc) Called once for every document matching a query, with the unbased document number.Optionally returns an iterator over competitive documents.void
Called before successive calls toLeafCollector.collect(int)
.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.LeafCollector
collect, finish
-
Field Details
-
context
-
cutter
-
recorder
-
leafCutter
-
leafRecorder
-
-
Constructor Details
-
FacetFieldLeafCollector
FacetFieldLeafCollector(LeafReaderContext context, FacetCutter cutter, FacetRecorder recorder)
-
-
Method Details
-
setScorer
Description copied from interface:LeafCollector
Called before successive calls toLeafCollector.collect(int)
. Implementations that need the score of the current document (passed-in toLeafCollector.collect(int)
), should save the passed-in Scorer and call scorer.score() when needed.- Specified by:
setScorer
in interfaceLeafCollector
- Throws:
IOException
-
collect
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 currentLeafReaderContext
will be skipped andIndexSearcher
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 interfaceLeafCollector
- Throws:
IOException
-
competitiveIterator
Description copied from interface:LeafCollector
Optionally returns an iterator over competitive documents.Collectors should delegate this method to their comparators if their comparators provide the skipping functionality over non-competitive docs.
The default is to return
null
which is interpreted as the collector provide any competitive iterator.- Specified by:
competitiveIterator
in interfaceLeafCollector
- Throws:
IOException
-