Package org.apache.lucene.search.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

@Deprecated
public abstract class GroupFacetCollector
extends SimpleCollector

Deprecated.

Use TermGroupFacetCollectorManager instead, which supports concurrent search. GroupedFacetResult and GroupedFacetResult.FacetEntry are now top-level classes.

Base class for computing grouped facets.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GroupFacetCollector.FacetEntry	Deprecated. Represents a facet entry with a value and a count.
static class	GroupFacetCollector.GroupedFacetResult	Deprecated. The grouped facet result.
protected static class	GroupFacetCollector.SegmentResult	Deprecated. Contains the local grouped segment counts for a particular segment.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	endFacetOrd	Deprecated.
protected final String	facetField	Deprecated.
protected final BytesRef	facetPrefix	Deprecated.
protected final String	groupField	Deprecated.
protected int[]	segmentFacetCounts	Deprecated.
protected final List<GroupFacetCollector.SegmentResult>	segmentResults	Deprecated.
protected int	segmentTotalCount	Deprecated.
protected int	startFacetOrd	Deprecated.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GroupFacetCollector(String groupField, String facetField, BytesRef facetPrefix)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected abstract GroupFacetCollector.SegmentResult	createSegmentResult()	Deprecated.
void	finish()	Deprecated.
GroupFacetCollector.GroupedFacetResult	mergeSegmentResults(int size, int minCount, boolean orderByCount)	Deprecated. Use TermGroupFacetCollectorManager instead.
ScoreMode	scoreMode()	Deprecated.
void	setScorer(Scorable scorer)	Deprecated.

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.Collector

setWeight

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

collect, collectRange, competitiveIterator

Field Details

groupField

protected final String groupField

Deprecated.

facetField

protected final String facetField

Deprecated.

facetPrefix

protected final BytesRef facetPrefix

Deprecated.

segmentResults

protected final List<GroupFacetCollector.SegmentResult> segmentResults

Deprecated.

segmentFacetCounts

protected int[] segmentFacetCounts

Deprecated.

segmentTotalCount

protected int segmentTotalCount

Deprecated.

startFacetOrd

protected int startFacetOrd

Deprecated.

endFacetOrd

protected int endFacetOrd

Deprecated.

Constructor Details

GroupFacetCollector

protected GroupFacetCollector(String groupField,
 String facetField,
 BytesRef facetPrefix)

Deprecated.

Method Details

mergeSegmentResults

@Deprecated
public GroupFacetCollector.GroupedFacetResult mergeSegmentResults(int size,
 int minCount,
 boolean orderByCount)
                                                           throws IOException

Deprecated.

Use TermGroupFacetCollectorManager instead. The size, minCount, and orderByCount parameters are now passed to its constructor, and merging happens automatically inside IndexSearcher.search(org.apache.lucene.search.Query, org.apache.lucene.search.CollectorManager).

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 + limit

minCount - The minimum count a facet entry should have to be included in the grouped facet result

orderByCount - Whether to sort the facet entries by facet entry count. If false 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

public void finish()
            throws IOException

Deprecated.

Throws:

IOException

createSegmentResult

protected abstract GroupFacetCollector.SegmentResult createSegmentResult()
                                                                  throws IOException

Deprecated.

Throws:

IOException

setScorer

public void setScorer(Scorable scorer)
               throws IOException

Deprecated.

Specified by:

setScorer in interface LeafCollector

Overrides:

setScorer in class SimpleCollector

Throws:

IOException

scoreMode

public ScoreMode scoreMode()

Deprecated.