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

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

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

    Classes in org.apache.lucene.search with type parameters of type ScoreDoc
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TopDocsCollector<T extends ScoreDoc>` A base class for all collectors that return a `TopDocs` output.

    Subclasses of ScoreDoc in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FieldDoc` Expert: A ScoreDoc which also contains information about how to sort the referenced document.
    `static class` | `FieldValueHitQueue.Entry` Extension of ScoreDoc to also store the `FieldComparator` slot.

    Fields in org.apache.lucene.search declared as ScoreDoc
    Modifier and Type | Field and Description
    --- | ---
    `ScoreDoc[]` | TopDocs.`scoreDocs` The top hits for the query.

    Methods in org.apache.lucene.search with parameters of type ScoreDoc
    Modifier and Type | Method and Description
    --- | ---
    `static TopScoreDocCollector` | TopScoreDocCollector.`create(int numHits, ScoreDoc after, boolean docsScoredInOrder)` Creates a new `TopScoreDocCollector` given the number of hits to collect, the bottom of the previous page, and whether documents are scored in order by the input `Scorer` to `TopScoreDocCollector.setScorer(Scorer)`.
    `protected TopDocs` | TopScoreDocCollector.`newTopDocs(ScoreDoc[] results, int start)`
    `protected TopDocs` | TopFieldCollector.`newTopDocs(ScoreDoc[] results, int start)`
    `protected TopDocs` | TopDocsCollector.`newTopDocs(ScoreDoc[] results, int start)` Returns a `TopDocs` instance containing the given results.
    `protected void` | TopFieldCollector.`populateResults(ScoreDoc[] results, int howMany)`
    `protected void` | TopDocsCollector.`populateResults(ScoreDoc[] results, int howMany)` Populates the results array with the ScoreDoc instances.
    `protected TopDocs` | IndexSearcher.`search(List<AtomicReaderContext> leaves, Weight weight, ScoreDoc after, int nDocs)` Expert: Low-level search implementation.
    `protected TopDocs` | IndexSearcher.`search(Weight weight, ScoreDoc after, int nDocs)` Expert: Low-level search implementation.
    `TopDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, Filter filter, int n)` Finds the top `n` hits for `query`, applying `filter` if non-null, where all results are after a previous result (`after`).
    `TopDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, Filter filter, int n, Sort sort)` Finds the top `n` hits for `query`, applying `filter` if non-null, where all results are after a previous result (`after`).
    `TopDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, Filter filter, int n, Sort sort, boolean doDocScores, boolean doMaxScore)` Finds the top `n` hits for `query` where all results are after a previous result (`after`), allowing control over whether hit scores and max score should be computed.
    `TopDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, int n)` Finds the top `n` hits for `query` where all results are after a previous result (`after`).
    `TopDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, int n, Sort sort)` Finds the top `n` hits for `query` where all results are after a previous result (`after`).

    Constructors in org.apache.lucene.search with parameters of type ScoreDoc
    Constructor and Description
    `TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore)`
    `TopFieldDocs(int totalHits, ScoreDoc[] scoreDocs, SortField[] fields, float maxScore)` Creates one of these objects.

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