Show / Hide Table of Contents

    Class DocumentExtensions

    LUCENENET specific extensions to the class.

    Inheritance
    System.Object
    DocumentExtensions
    Namespace: Lucene.Net.Documents
    Assembly: Lucene.Net.Facet.dll
    Syntax
    public static class DocumentExtensions : object

    Methods

    | Improve this Doc View Source

    AddAssociationFacetField(Document, BytesRef, String, String[])

    Adds a new AssociationFacetField using dim and path and an association.

    Declaration
    public static AssociationFacetField AddAssociationFacetField(this Document document, BytesRef assoc, string dim, params string[] path)
    Parameters
    Type Name Description
    Document document

    This .

    BytesRef assoc

    Associated value.

    System.String dim

    Dimension for this field.

    System.String[] path

    Facet path for this field.

    Returns
    Type Description
    AssociationFacetField

    The field that was added to this .

    | Improve this Doc View Source

    AddFacetField(Document, String, String[])

    Adds a new FacetField with the specified dim and path.

    Declaration
    public static FacetField AddFacetField(this Document document, string dim, params string[] path)
    Parameters
    Type Name Description
    Document document

    This .

    System.String dim

    Dimension for this field.

    System.String[] path

    Facet path for this field.

    Returns
    Type Description
    FacetField

    The field that was added to this .

    | Improve this Doc View Source

    AddInt32AssociationFacetField(Document, Int32, String, String[])

    Adds a new Int32AssociationFacetField using dim and path and an association.

    Declaration
    public static Int32AssociationFacetField AddInt32AssociationFacetField(this Document document, int assoc, string dim, params string[] path)
    Parameters
    Type Name Description
    Document document

    This .

    System.Int32 assoc

    Associated value.

    System.String dim

    Dimension for this field.

    System.String[] path

    Facet path for this field.

    Returns
    Type Description
    Int32AssociationFacetField

    The field that was added to this .

    | Improve this Doc View Source

    AddSingleAssociationFacetField(Document, Single, String, String[])

    Adds a new SingleAssociationFacetField using dim and path and a association.

    Declaration
    public static SingleAssociationFacetField AddSingleAssociationFacetField(this Document document, float assoc, string dim, params string[] path)
    Parameters
    Type Name Description
    Document document

    This .

    System.Single assoc

    Associated value.

    System.String dim

    Dimension for this field.

    System.String[] path

    Facet path for this field.

    Returns
    Type Description
    SingleAssociationFacetField

    The field that was added to this .

    | Improve this Doc View Source

    AddSortedSetDocValuesFacetField(Document, String, String)

    Adds a new SortedSetDocValuesFacetField.

    Declaration
    public static SortedSetDocValuesFacetField AddSortedSetDocValuesFacetField(this Document document, string dim, string label)
    Parameters
    Type Name Description
    Document document

    This .

    System.String dim

    Dimension for this field.

    System.String label

    Label for this field.

    Returns
    Type Description
    SortedSetDocValuesFacetField

    The field that was added to this .

    Remarks

    Add a SortedSetDocValuesFacetField to your for every facet label to be indexed via .

    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)