Module org.apache.lucene.facet

Package org.apache.lucene.facet

Class FacetsCollectorManager

java.lang.Object

org.apache.lucene.facet.FacetsCollectorManager

All Implemented Interfaces:

CollectorManager<FacetsCollector,FacetsCollector>

public class FacetsCollectorManager
extends Object
implements CollectorManager<FacetsCollector,FacetsCollector>

A CollectorManager implementation which produces FacetsCollector and produces a merged FacetsCollector. This is used for concurrent FacetsCollection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FacetsCollectorManager.FacetsResult	Holds results of a search run via static utility methods exposed by this class.
private static class	FacetsCollectorManager.ReducedFacetsCollector

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	keepScores

Constructor Summary

Constructors

Constructor	Description
FacetsCollectorManager()	Sole constructor.
FacetsCollectorManager(boolean keepScores)	Creates a new collector manager that in turn creates FacetsCollector using the provided keepScores flag.

Method Summary

Modifier and Type	Method	Description
private static FacetsCollectorManager.FacetsResult	doSearch(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, boolean doDocScores, FacetsCollectorManager fcm)
private static FacetsCollector.MatchingDocs	merge(FacetsCollector.MatchingDocs matchingDocs1, FacetsCollector.MatchingDocs matchingDocs2)
FacetsCollector	newCollector()	Return a new Collector.
FacetsCollector	reduce(Collection<FacetsCollector> collectors)	Reduce the results of individual collectors into a meaningful result.
(package private) static Collection<FacetsCollector.MatchingDocs>	reduceMatchingDocs(Collection<? extends FacetsCollector> facetsCollectors)	Reduces matching docs held by the provided facets collectors, merging matching docs for the same leaf into a single matching docs instance
static FacetsCollectorManager.FacetsResult	search(IndexSearcher searcher, Query q, int n, FacetsCollectorManager fcm)	Utility method, to search and also populate a FacetsCollector with hits.
static FacetsCollectorManager.FacetsResult	search(IndexSearcher searcher, Query q, int n, Sort sort, boolean doDocScores, FacetsCollectorManager fcm)	Utility method, to search and also populate a FacetsCollector with hits.
static FacetsCollectorManager.FacetsResult	search(IndexSearcher searcher, Query q, int n, Sort sort, FacetsCollectorManager fcm)	Utility method, to search and also populate a FacetsCollector with hits.
static FacetsCollectorManager.FacetsResult	searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, FacetsCollectorManager fcm)	Utility method, to search and also populate a FacetsCollector with hits.
static FacetsCollectorManager.FacetsResult	searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, boolean doDocScores, FacetsCollectorManager fcm)	Utility method, to search and also populate a FacetsCollector with hits.
static FacetsCollectorManager.FacetsResult	searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, FacetsCollectorManager fcm)	Utility method, to search and also populate a FacetsCollector with hits.

Methods inherited from class java.lang.Object

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

Field Details

keepScores

private final boolean keepScores

Constructor Details

FacetsCollectorManager

public FacetsCollectorManager()

Sole constructor.

FacetsCollectorManager

public FacetsCollectorManager(boolean keepScores)

Creates a new collector manager that in turn creates FacetsCollector using the provided keepScores flag. hits.

Method Details

newCollector

public FacetsCollector newCollector()
                             throws IOException

Description copied from interface: CollectorManager

Return a new Collector. This must return a different instance on each call.

Specified by:

newCollector in interface CollectorManager<FacetsCollector,FacetsCollector>

Throws:

IOException

reduce

public FacetsCollector reduce(Collection<FacetsCollector> collectors)
                       throws IOException

Description copied from interface: CollectorManager

Reduce the results of individual collectors into a meaningful result. For instance a TopDocsCollector would compute the top docs of each collector and then merge them using TopDocs.merge(int, TopDocs[]). This method must be called after collection is finished on all provided collectors.

Specified by:

reduce in interface CollectorManager<FacetsCollector,FacetsCollector>

Throws:

IOException

reduceMatchingDocs

static Collection<FacetsCollector.MatchingDocs> reduceMatchingDocs(Collection<? extends FacetsCollector> facetsCollectors)

Reduces matching docs held by the provided facets collectors, merging matching docs for the same leaf into a single matching docs instance

Parameters:

facetsCollectors - the facets collectors

Returns:

the reduced matching docs, with one instance per leaf reader context

merge

private static FacetsCollector.MatchingDocs merge(FacetsCollector.MatchingDocs matchingDocs1,
 FacetsCollector.MatchingDocs matchingDocs2)

search

public static FacetsCollectorManager.FacetsResult search(IndexSearcher searcher,
 Query q,
 int n,
 FacetsCollectorManager fcm)
                                                  throws IOException

Utility method, to search and also populate a FacetsCollector with hits. The provided FacetsCollectorManager will be used for creating/reducing FacetsCollector instances.

Throws:

IOException

search

public static FacetsCollectorManager.FacetsResult search(IndexSearcher searcher,
 Query q,
 int n,
 Sort sort,
 FacetsCollectorManager fcm)
                                                  throws IOException

Utility method, to search and also populate a FacetsCollector with hits. The provided FacetsCollectorManager will be used for creating/reducing FacetsCollector instances.

Throws:

IOException

search

public static FacetsCollectorManager.FacetsResult search(IndexSearcher searcher,
 Query q,
 int n,
 Sort sort,
 boolean doDocScores,
 FacetsCollectorManager fcm)
                                                  throws IOException

Utility method, to search and also populate a FacetsCollector with hits. The provided FacetsCollectorManager will be used for creating/reducing FacetsCollector instances.

Throws:

IOException

searchAfter

public static FacetsCollectorManager.FacetsResult searchAfter(IndexSearcher searcher,
 ScoreDoc after,
 Query q,
 int n,
 FacetsCollectorManager fcm)
                                                       throws IOException

Utility method, to search and also populate a FacetsCollector with hits. The provided FacetsCollectorManager will be used for creating/reducing FacetsCollector instances.

Throws:

IOException

searchAfter

public static FacetsCollectorManager.FacetsResult searchAfter(IndexSearcher searcher,
 ScoreDoc after,
 Query q,
 int n,
 Sort sort,
 FacetsCollectorManager fcm)
                                                       throws IOException

Utility method, to search and also populate a FacetsCollector with hits. The provided FacetsCollectorManager will be used for creating/reducing FacetsCollector instances.

Throws:

IOException

searchAfter

public static FacetsCollectorManager.FacetsResult searchAfter(IndexSearcher searcher,
 ScoreDoc after,
 Query q,
 int n,
 Sort sort,
 boolean doDocScores,
 FacetsCollectorManager fcm)
                                                       throws IOException

Utility method, to search and also populate a FacetsCollector with hits. The provided FacetsCollectorManager will be used for creating/reducing FacetsCollector instances.

Throws:

IOException

doSearch

private static FacetsCollectorManager.FacetsResult doSearch(IndexSearcher searcher,
 ScoreDoc after,
 Query q,
 int n,
 Sort sort,
 boolean doDocScores,
 FacetsCollectorManager fcm)
                                                     throws IOException

Throws:

IOException