java.lang.Object
org.apache.lucene.search.SimpleCollector
org.apache.lucene.facet.FacetsCollector
- All Implemented Interfaces:
Collector
,LeafCollector
- Direct Known Subclasses:
FacetsCollectorManager.ReducedFacetsCollector
,RandomSamplingFacetsCollector
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final record
Holds the documents that were matched in theLeafReaderContext
. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate LeafReaderContext
private DocIdSetBuilder
private final boolean
private final List
<FacetsCollector.MatchingDocs> private Scorable
private float[]
private int
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorFacetsCollector
(boolean keepScores) Create this; ifkeepScores
is true then a float[] is allocated to hold score of all hits. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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 collectingcontext
.void
finish()
Hook that gets called once the leaf that is associated with this collector has finished collecting successfully, including when aCollectionTerminatedException
is thrown.final boolean
True if scores were saved.Returns the documents matched by the query, oneFacetsCollector.MatchingDocs
per visited segment.Indicates what features are required from the scorer.final void
Called before successive calls toLeafCollector.collect(int)
.Methods inherited from class org.apache.lucene.search.SimpleCollector
getLeafCollector
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, competitiveIterator
-
Field Details
-
context
-
scorer
-
totalHits
private int totalHits -
scores
private float[] scores -
keepScores
private final boolean keepScores -
matchingDocs
-
docsBuilder
-
-
Constructor Details
-
FacetsCollector
public FacetsCollector()Default constructor -
FacetsCollector
public FacetsCollector(boolean keepScores) Create this; ifkeepScores
is true then a float[] is allocated to hold score of all hits.
-
-
Method Details
-
getKeepScores
public final boolean getKeepScores()True if scores were saved. -
getMatchingDocs
Returns the documents matched by the query, oneFacetsCollector.MatchingDocs
per visited segment. -
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
- Specified by:
collect
in classSimpleCollector
- Throws:
IOException
-
scoreMode
Description copied from interface:Collector
Indicates what features are required from the scorer. -
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
- Overrides:
setScorer
in classSimpleCollector
- Throws:
IOException
-
doSetNextReader
Description copied from class:SimpleCollector
This method is called before collectingcontext
.- Overrides:
doSetNextReader
in classSimpleCollector
- Throws:
IOException
-
finish
Description copied from interface:LeafCollector
Hook that gets called once the leaf that is associated with this collector has finished collecting successfully, including when aCollectionTerminatedException
is thrown. This is typically useful to compile data that has been collected on this leaf, e.g. to convert facet counts on leaf ordinals to facet counts on global ordinals. The default implementation does nothing.Note: It can be assumed that this method will only be called once per LeafCollector instance.
- Throws:
IOException
-