Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Interface ITopGroups<TGroupValue>

    LUCENENET specific interface used to provide covariance with the TGroupValue type to simulate Java's wildcard generics.

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

    Properties

    | Improve this Doc View Source

    Groups

    Group results in groupSort order

    Declaration
    IGroupDocs<TGroupValue>[] Groups { get; }
    Property Value
    Type Description
    IGroupDocs<TGroupValue>[]
    | Improve this Doc View Source

    GroupSort

    How groups are sorted against each other

    Declaration
    SortField[] GroupSort { get; }
    Property Value
    Type Description
    Lucene.Net.Search.SortField[]
    | Improve this Doc View Source

    MaxScore

    Highest score across all hits, or System.Single.NaN if scores were not computed.

    Declaration
    float MaxScore { get; }
    Property Value
    Type Description
    System.Single
    | Improve this Doc View Source

    TotalGroupCount

    The total number of unique groups. If null this value is not computed.

    Declaration
    int? TotalGroupCount { get; }
    Property Value
    Type Description
    System.Nullable<System.Int32>
    | Improve this Doc View Source

    TotalGroupedHitCount

    Number of documents grouped into the topN groups

    Declaration
    int TotalGroupedHitCount { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    TotalHitCount

    Number of documents matching the search

    Declaration
    int TotalHitCount { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    WithinGroupSort

    How docs are sorted within each group

    Declaration
    SortField[] WithinGroupSort { get; }
    Property Value
    Type Description
    Lucene.Net.Search.SortField[]
    • Improve this Doc
    • View Source
    Back to top Copyright © 2022 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.