Package org.apache.lucene.search.grouping

Class CollapseTopFieldDocs

org.apache.lucene.search.TopDocs
org.apache.lucene.search.TopFieldDocs
org.apache.lucene.search.grouping.CollapseTopFieldDocs
public final class CollapseTopFieldDocs extends org.apache.lucene.search.TopFieldDocs
Represents hits returned by CollapsingTopDocsCollector.getTopDocs().

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    []
    collapseValues
    The collapse value for each top doc
    field
    The field used for collapsing

    Fields inherited from class org.apache.lucene.search.TopFieldDocs

    fields

    Fields inherited from class org.apache.lucene.search.TopDocs

    scoreDocs, totalHits

  • Constructor Summary

    Constructors
    Constructor
    Description
     field, org.apache.lucene.search.TotalHits totalHits, org.apache.lucene.search.ScoreDoc[] scoreDocs, org.apache.lucene.search.SortField[] sortFields, [] values)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static CollapseTopFieldDocs
    merge​(org.apache.lucene.search.Sort sort, int start, int size, CollapseTopFieldDocs[] shardHits, boolean setShardIndex)
    Returns a new CollapseTopDocs, containing topN collapsed results across the provided CollapseTopDocs, sorting by score.

    Methods inherited from class org.apache.lucene.search.TopDocs

    merge, merge, merge, merge

    Methods inherited from class java.lang.

    , , , , , , , , , ,

  • Field Details

    • field

      public final  field
      The field used for collapsing

    • collapseValues

      public final [] collapseValues
      The collapse value for each top doc

  • Constructor Details

    • CollapseTopFieldDocs

      public CollapseTopFieldDocs​( field, org.apache.lucene.search.TotalHits totalHits, org.apache.lucene.search.ScoreDoc[] scoreDocs, org.apache.lucene.search.SortField[] sortFields, [] values)

  • Method Details

    • merge

      public static CollapseTopFieldDocs merge​(org.apache.lucene.search.Sort sort, int start, int size, CollapseTopFieldDocs[] shardHits, boolean setShardIndex)
      Returns a new CollapseTopDocs, containing topN collapsed results across the provided CollapseTopDocs, sorting by score. Each CollapseTopFieldDocs instance must be sorted.