Module org.apache.lucene.grouping
Class GroupFacetCollector
java.lang.Object
org.apache.lucene.search.SimpleCollector
org.apache.lucene.search.grouping.GroupFacetCollector
- All Implemented Interfaces:
Collector
,LeafCollector
- Direct Known Subclasses:
TermGroupFacetCollector
Base class for computing grouped facets.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents a facet entry with a value and a count.static class
The grouped facet result.protected static class
Contains the local grouped segment counts for a particular segment.private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
protected final String
protected final BytesRef
protected final String
protected int[]
protected final List
<GroupFacetCollector.SegmentResult> protected int
protected int
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
GroupFacetCollector
(String groupField, String facetField, BytesRef facetPrefix) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract GroupFacetCollector.SegmentResult
void
finish()
Hook that gets called once the leaf that is associated with this collector has finished collecting successfully, including when aCollectionTerminatedException
is thrown.mergeSegmentResults
(int size, int minCount, boolean orderByCount) Returns grouped facet results that were computed over zero or more segments.Indicates what features are required from the scorer.void
Called before successive calls toLeafCollector.collect(int)
.Methods inherited from class org.apache.lucene.search.SimpleCollector
collect, doSetNextReader, 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
-
groupField
-
facetField
-
facetPrefix
-
segmentResults
-
segmentFacetCounts
protected int[] segmentFacetCounts -
segmentTotalCount
protected int segmentTotalCount -
startFacetOrd
protected int startFacetOrd -
endFacetOrd
protected int endFacetOrd
-
-
Constructor Details
-
GroupFacetCollector
-
-
Method Details
-
mergeSegmentResults
public GroupFacetCollector.GroupedFacetResult mergeSegmentResults(int size, int minCount, boolean orderByCount) throws IOException Returns grouped facet results that were computed over zero or more segments. Grouped facet counts are merged from zero or more segment results.- Parameters:
size
- The total number of facets to include. This is typically offset + limitminCount
- The minimum count a facet entry should have to be included in the grouped facet resultorderByCount
- Whether to sort the facet entries by facet entry count. Iffalse
then the facets are sorted lexicographically in ascending order.- Returns:
- grouped facet results
- Throws:
IOException
- If I/O related errors occur during merging segment grouped facet counts.
-
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
-
createSegmentResult
- Throws:
IOException
-
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
-
scoreMode
Description copied from interface:Collector
Indicates what features are required from the scorer.
-