Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Interface IGroupDocs<TGroupValue>

    LUCENENET specific interface used to apply covariance to TGroupValue to simulate Java's wildcard generics.

    Namespace: Lucene.Net.Search.Grouping
    Assembly: Lucene.Net.Grouping.dll
    Syntax
    public interface IGroupDocs<out TGroupValue>
    Type Parameters
    Name Description
    TGroupValue

    Properties

    GroupSortValues

    Matches the groupSort passed to AbstractFirstPassGroupingCollector<TGroupValue>.

    Declaration
    object[] GroupSortValues { get; }
    Property Value
    Type Description
    object[]

    GroupValue

    The groupField value for all docs in this group; this may be null if hits did not have the groupField.

    Declaration
    TGroupValue GroupValue { get; }
    Property Value
    Type Description
    TGroupValue

    MaxScore

    Max score in this group

    Declaration
    float MaxScore { get; }
    Property Value
    Type Description
    float

    Score

    Overall aggregated score of this group (currently only set by join queries).

    Declaration
    float Score { get; }
    Property Value
    Type Description
    float

    ScoreDocs

    Hits; this may be Lucene.Net.Search.FieldDoc instances if the withinGroupSort sorted by fields.

    Declaration
    ScoreDoc[] ScoreDocs { get; }
    Property Value
    Type Description
    ScoreDoc[]

    TotalHits

    Total hits within this group

    Declaration
    int TotalHits { get; }
    Property Value
    Type Description
    int
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.