org.apache.lucene.search

## Class ScoreDoc

- java.lang.Object
- - org.apache.lucene.search.ScoreDoc

- Direct Known Subclasses:
    FieldDoc, FieldValueHitQueue.Entry

      public class ScoreDoc
      extends Object

  Holds one hit in `TopDocs`.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `int` | `doc` A hit document's number.
    `float` | `score` The score of this document for the query.
    `int` | `shardIndex` Only set by `TopDocs.merge(int, org.apache.lucene.search.TopDocs[])`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ScoreDoc(int doc, float score)` Constructs a ScoreDoc.
    `ScoreDoc(int doc, float score, int shardIndex)` Constructs a ScoreDoc.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### score

          public float score

      The score of this document for the query.

    - #### doc

          public int doc

      A hit document's number.
      See Also:
        `IndexSearcher.doc(int)`

    - #### shardIndex

          public int shardIndex

      Only set by `TopDocs.merge(int, org.apache.lucene.search.TopDocs[])`

  - ### Constructor Detail

    - #### ScoreDoc

          public ScoreDoc(int doc,
                          float score)

      Constructs a ScoreDoc.

    - #### ScoreDoc

          public ScoreDoc(int doc,
                          float score,
                          int shardIndex)

      Constructs a ScoreDoc.

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

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