Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Facets

    Common base class for all facets implementations.

    Note

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

    Inheritance
    System.Object
    Facets
    MultiFacets
    RangeFacetCounts
    SortedSetDocValuesFacetCounts
    TaxonomyFacets
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Lucene.Net.Facet
    Assembly: Lucene.Net.Facet.dll
    Syntax
    public abstract class Facets

    Constructors

    | Improve this Doc View Source

    Facets()

    Default constructor.

    Declaration
    protected Facets()

    Methods

    | Improve this Doc View Source

    GetAllDims(Int32)

    Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.

    Declaration
    public abstract IList<FacetResult> GetAllDims(int topN)
    Parameters
    Type Name Description
    System.Int32 topN
    Returns
    Type Description
    System.Collections.Generic.IList<FacetResult>
    | Improve this Doc View Source

    GetSpecificValue(String, String[])

    Return the count or value for a specific path. Returns -1 if this path doesn't exist, else the count.

    Declaration
    public abstract float GetSpecificValue(string dim, params string[] path)
    Parameters
    Type Name Description
    System.String dim
    System.String[] path
    Returns
    Type Description
    System.Single
    | Improve this Doc View Source

    GetTopChildren(Int32, String, String[])

    Returns the topN child labels under the specified path. Returns null if the specified path doesn't exist or if this dimension was never seen.

    Declaration
    public abstract FacetResult GetTopChildren(int topN, string dim, params string[] path)
    Parameters
    Type Name Description
    System.Int32 topN
    System.String dim
    System.String[] path
    Returns
    Type Description
    FacetResult
    • 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.