Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SearchGroup<TGroupValue>

    Represents a group that is found during the first pass search.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Inheritance
    object
    SearchGroup<TGroupValue>
    CollectedSearchGroup<TGroupValue>
    Implements
    ISearchGroup<TGroupValue>
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search.Grouping
    Assembly: Lucene.Net.Grouping.dll
    Syntax
    public class SearchGroup<TGroupValue> : ISearchGroup<TGroupValue>
    Type Parameters
    Name Description
    TGroupValue

    Properties

    GroupValue

    The value that defines this group

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

    SortValues

    The sort values used during sorting. These are the groupSort field values of the highest rank document (by the groupSort) within the group. Can be null if fillFields=false had been passed to GetTopGroups(int, bool)

    Declaration
    public object[] SortValues { get; set; }
    Property Value
    Type Description
    object[]

    Methods

    Equals(object)

    Determines whether the specified object is equal to the current object.

    Declaration
    public override bool Equals(object o)
    Parameters
    Type Name Description
    object o
    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()

    Implements

    ISearchGroup<TGroupValue>
    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.