Uses of Interface
org.apache.lucene.search.Collector

Packages that use Collector

Package	Description
org.apache.lucene.monitor	Monitoring framework
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.grouping	Grouping.
org.apache.lucene.search.join	Support for index-time and query-time joins.
org.apache.lucene.search.suggest.document	Support for document suggestion

Uses of Collector in org.apache.lucene.monitor

Classes in org.apache.lucene.monitor that implement Collector

Modifier and Type	Class	Description
private class	CollectingMatcher.MatchCollector
(package private) static final class	QueryIndex.MonitorQueryCollector	A Collector that decodes the stored query for each document hit.

Uses of Collector in org.apache.lucene.search

Classes in org.apache.lucene.search with type parameters of type Collector

Modifier and Type	Interface	Description
interface	CollectorManager<C extends Collector,T>	A manager of collectors.

Classes in org.apache.lucene.search that implement Collector

Modifier and Type	Class	Description
class	CachingCollector	Caches all docs, and optionally also scores, coming from a search, and is then able to replay them to another collector.
private static class	CachingCollector.NoScoreCachingCollector
private static class	CachingCollector.ScoreCachingCollector
class	DiversifiedTopDocsCollector	A TopDocsCollector that controls diversity in results by ensuring no more than maxHitsPerKey results from a common source are collected in the final results.
class	DocValuesStatsCollector	A Collector which computes statistics for a DocValues field.
class	FilterCollector	Collector delegator.
final class	LargeNumHitsTopDocsCollector	Optimized collector for large number of hits.
class	MemoryAccountingBitsetCollector	Bitset collector which supports memory tracking
class	MultiCollector	A Collector which allows running a search with several Collectors.
class	MultiCollectorManager.Collectors
class	PositiveScoresOnlyCollector	A Collector implementation which wraps another Collector and makes sure only documents with scores > 0 are collected.
class	SimpleCollector	Base Collector implementation that is used to collect all contexts.
class	TimeLimitingCollector	The TimeLimitingCollector is used to timeout search requests that take longer than the maximum allowed search time limit.
class	TopDocsCollector<T extends ScoreDoc>	A base class for all collectors that return a TopDocs output.
class	TopFieldCollector	A Collector that sorts by SortField using FieldComparators.
private static final class	TopFieldCollector.PagingFieldCollector
private static class	TopFieldCollector.SimpleFieldCollector
class	TopScoreDocCollector	A Collector implementation that collects the top-scoring hits, returning them as a TopDocs.
private static class	TopScoreDocCollector.PagingTopScoreDocCollector
private static class	TopScoreDocCollector.SimpleTopScoreDocCollector
class	TotalHitCountCollector	Just counts the total number of hits.

Fields in org.apache.lucene.search declared as Collector

Modifier and Type	Field	Description
private Collector	TimeLimitingCollector.collector
private final Collector[]	MultiCollector.collectors
private final Collector[]	MultiCollectorManager.Collectors.collectors
protected final Collector	FilterCollector.in

Methods in org.apache.lucene.search with type parameters of type Collector

Modifier and Type	Method	Description
<C extends Collector, T> T	IndexSearcher.search(Query query, CollectorManager<C,T> collectorManager)	Lower-level search API.

Methods in org.apache.lucene.search that return Collector

Modifier and Type	Method	Description
static Collector	MultiCollector.wrap(Iterable<? extends Collector> collectors)	Wraps a list of Collectors with a MultiCollector.
static Collector	MultiCollector.wrap(Collector... collectors)	See MultiCollector.wrap(Iterable).

Methods in org.apache.lucene.search with parameters of type Collector

Modifier and Type	Method	Description
static CachingCollector	CachingCollector.create(Collector other, boolean cacheScores, double maxRAMMB)	Create a new CachingCollector that wraps the given collector and caches documents and scores up to the specified RAM threshold.
static CachingCollector	CachingCollector.create(Collector other, boolean cacheScores, int maxDocsToCache)	Create a new CachingCollector that wraps the given collector and caches documents and scores up to the specified max docs threshold.
void	CachingCollector.NoScoreCachingCollector.replay(Collector other)
abstract void	CachingCollector.replay(Collector other)	Replays the cached doc IDs (and scores) to the given Collector.
protected void	IndexSearcher.search(List<LeafReaderContext> leaves, Weight weight, Collector collector)	Lower-level search API.
void	IndexSearcher.search(Query query, Collector results)	Lower-level search API.
void	TimeLimitingCollector.setCollector(Collector collector)	This is so the same timer can be used with a multi-phase search process such as grouping.
static Collector	MultiCollector.wrap(Collector... collectors)	See MultiCollector.wrap(Iterable).

Method parameters in org.apache.lucene.search with type arguments of type Collector

Modifier and Type	Method	Description
static Collector	MultiCollector.wrap(Iterable<? extends Collector> collectors)	Wraps a list of Collectors with a MultiCollector.

Constructors in org.apache.lucene.search with parameters of type Collector

Modifier	Constructor	Description
private	CachingCollector(Collector in)
	FilterCollector(Collector in)	Sole constructor.
private	MultiCollector(Collector... collectors)
(package private)	NoScoreCachingCollector(Collector in, int maxDocsToCache)
	PositiveScoresOnlyCollector(Collector in)
(package private)	ScoreCachingCollector(Collector in, int maxDocsToCache)
	TimeLimitingCollector(Collector collector, Counter clock, long ticksAllowed)	Create a TimeLimitedCollector wrapper over another Collector with a specified timeout.

Uses of Collector in org.apache.lucene.search.grouping

Classes in org.apache.lucene.search.grouping with type parameters of type Collector

Modifier and Type	Class	Description
class	GroupReducer<T,C extends Collector>	Concrete implementations of this class define what to collect for individual groups during the second-pass of a grouping search.
private static final class	GroupReducer.GroupCollector<C extends Collector>

Classes in org.apache.lucene.search.grouping that implement Collector

Modifier and Type	Class	Description
class	AllGroupHeadsCollector<T>	This collector specializes in collecting the most relevant document (group head) for each group that matches the query.
private static class	AllGroupHeadsCollector.ScoringGroupHeadsCollector<T>	Specialized implementation for sorting by score
private static class	AllGroupHeadsCollector.SortingGroupHeadsCollector<T>	General implementation using a FieldComparator to select the group head
class	AllGroupsCollector<T>	A collector that collects all groups that match the query.
class	BlockGroupingCollector	BlockGroupingCollector performs grouping with a single pass collector, as long as you are grouping by a doc block field, ie all documents sharing a given group value were indexed as a doc block using the atomic IndexWriter.addDocuments() or IndexWriter.updateDocuments() API.
class	DistinctValuesCollector<T,R>	A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.
private static class	DistinctValuesCollector.ValuesCollector<R>
class	FirstPassGroupingCollector<T>	FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
class	GroupFacetCollector	Base class for computing grouped facets.
class	SecondPassGroupingCollector<T>	SecondPassGroupingCollector runs over an already collected set of groups, further applying a GroupReducer to each group
class	TermGroupFacetCollector	An implementation of GroupFacetCollector that computes grouped facets based on the indexed terms from DocValues.
(package private) static class	TermGroupFacetCollector.MV
(package private) static class	TermGroupFacetCollector.SV
class	TopGroupsCollector<T>	A second-pass collector that collects the TopDocs for each group, and returns them as a TopGroups object
private static class	TopGroupsCollector.MaxScoreCollector
private static class	TopGroupsCollector.TopDocsAndMaxScoreCollector

Fields in org.apache.lucene.search.grouping declared as Collector

Modifier and Type	Field	Description
(package private) final C	GroupReducer.GroupCollector.collector

Uses of Collector in org.apache.lucene.search.join

Subinterfaces of Collector in org.apache.lucene.search.join

Modifier and Type	Interface	Description
(package private) interface	GenericTermsCollector

Classes in org.apache.lucene.search.join that implement Collector

Modifier and Type	Class	Description
(package private) class	DocValuesTermsCollector<DV>
(package private) final class	GlobalOrdinalsCollector	A collector that collects all ordinals from a specified field matching the query.
(package private) class	GlobalOrdinalsWithScoreCollector
(package private) static final class	GlobalOrdinalsWithScoreCollector.Avg
(package private) static final class	GlobalOrdinalsWithScoreCollector.Max
(package private) static final class	GlobalOrdinalsWithScoreCollector.Min
(package private) static final class	GlobalOrdinalsWithScoreCollector.NoScore
(package private) static final class	GlobalOrdinalsWithScoreCollector.Sum
(package private) class	TermsCollector<DV>	A collector that collects all terms from a specified field matching the query.
(package private) static class	TermsCollector.MV
(package private) static class	TermsCollector.SV
(package private) class	TermsWithScoreCollector<DV>
(package private) static class	TermsWithScoreCollector.MV
(package private) static class	TermsWithScoreCollector.MV.Avg
(package private) static class	TermsWithScoreCollector.SV
(package private) static class	TermsWithScoreCollector.SV.Avg

Uses of Collector in org.apache.lucene.search.suggest.document

Classes in org.apache.lucene.search.suggest.document that implement Collector

Modifier and Type	Class	Description
class	TopSuggestDocsCollector	Collector that collects completion and score, along with document id