## Uses of Class
org.apache.lucene.search.Collector

- Packages that use Collector
  Package | Description
  --- | ---
  org.apache.lucene.search | Code to search indices.

- - ### Uses of Collector in org.apache.lucene.search

    Subclasses of Collector in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CachingCollector` Caches all docs, and optionally also scores, coming from a search, and is then able to replay them to another collector.
    `class` | `MultiCollector` A `Collector` which allows running a search with several `Collector`s.
    `class` | `PositiveScoresOnlyCollector` A `Collector` implementation which wraps another `Collector` and makes sure only documents with scores > 0 are collected.
    `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 `FieldComparator`s.
    `class` | `TopScoreDocCollector` A `Collector` implementation that collects the top-scoring hits, returning them as a `TopDocs`.
    `class` | `TotalHitCountCollector` Just counts the total number of hits.

    Fields in org.apache.lucene.search declared as Collector
    Modifier and Type | Field and Description
    --- | ---
    `protected Collector` | CachingCollector.`other`

    Methods in org.apache.lucene.search that return Collector
    Modifier and Type | Method and Description
    --- | ---
    `static Collector` | MultiCollector.`wrap(Collector... collectors)` Wraps a list of `Collector`s with a `MultiCollector`.

    Methods in org.apache.lucene.search with parameters of type Collector
    Modifier and Type | Method and 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.
    `abstract void` | CachingCollector.`replay(Collector other)` Replays the cached doc IDs (and scores) to the given Collector.
    `void` | Scorer.`score(Collector collector)` Scores and collects all matching documents.
    `void` | ScoreCachingWrappingScorer.`score(Collector collector)`
    `void` | ConstantScoreQuery.ConstantScorer.`score(Collector collector)`
    `boolean` | Scorer.`score(Collector collector, int max, int firstDocID)` Expert: Collects matching documents in a range.
    `boolean` | ScoreCachingWrappingScorer.`score(Collector collector, int max, int firstDocID)`
    `boolean` | ConstantScoreQuery.ConstantScorer.`score(Collector collector, int max, int firstDocID)`
    `protected void` | IndexSearcher.`search(List<AtomicReaderContext> leaves, Weight weight, Collector collector)` Lower-level search API.
    `void` | IndexSearcher.`search(Query query, Collector results)` Lower-level search API.
    `void` | IndexSearcher.`search(Query query, Filter filter, 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)` Wraps a list of `Collector`s with a `MultiCollector`.

    Constructors in org.apache.lucene.search with parameters of type Collector
    Constructor and Description
    `PositiveScoresOnlyCollector(Collector c)`
    `TimeLimitingCollector(Collector collector, Counter clock, long ticksAllowed)` Create a TimeLimitedCollector wrapper over another `Collector` with a specified timeout.

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.