Show / Hide Table of Contents

    Class SortedSetDocValues

    A per-document set of presorted byte[] values.

    Per-Document values in a SortedDocValues are deduplicated, dereferenced, and sorted into a dictionary of unique values. A pointer to the dictionary value (ordinal) can be retrieved for each document. Ordinals are dense and in increasing sorted order.

    Inheritance
    System.Object
    SortedSetDocValues
    MultiDocValues.MultiSortedSetDocValues
    RandomAccessOrds
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class SortedSetDocValues : object

    Constructors

    | Improve this Doc View Source

    SortedSetDocValues()

    Sole constructor. (For invocation by subclass constructors, typically implicit.)

    Declaration
    protected SortedSetDocValues()

    Fields

    | Improve this Doc View Source

    NO_MORE_ORDS

    When returned by NextOrd() it means there are no more ordinals for the document.

    Declaration
    public static readonly long NO_MORE_ORDS
    Field Value
    Type Description
    System.Int64

    Properties

    | Improve this Doc View Source

    ValueCount

    Returns the number of unique values.

    Declaration
    public abstract long ValueCount { get; }
    Property Value
    Type Description
    System.Int64

    Number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

    Methods

    | Improve this Doc View Source

    GetTermsEnum()

    Returns a TermsEnum over the values. The enum supports Ord and SeekExact(Int64).

    Declaration
    public virtual TermsEnum GetTermsEnum()
    Returns
    Type Description
    TermsEnum
    | Improve this Doc View Source

    LookupOrd(Int64, BytesRef)

    Retrieves the value for the specified ordinal.

    Declaration
    public abstract void LookupOrd(long ord, BytesRef result)
    Parameters
    Type Name Description
    System.Int64 ord

    ordinal to lookup

    BytesRef result

    will be populated with the ordinal's value

    See Also
    NextOrd()
    | Improve this Doc View Source

    LookupTerm(BytesRef)

    If key exists, returns its ordinal, else returns -insertionPoint-1, like .

    Declaration
    public virtual long LookupTerm(BytesRef key)
    Parameters
    Type Name Description
    BytesRef key

    Key to look up

    Returns
    Type Description
    System.Int64
    | Improve this Doc View Source

    NextOrd()

    Returns the next ordinal for the current document (previously set by SetDocument(Int32).

    Declaration
    public abstract long NextOrd()
    Returns
    Type Description
    System.Int64

    Next ordinal for the document, or NO_MORE_ORDS. ordinals are dense, start at 0, then increment by 1 for the next value in sorted order.

    | Improve this Doc View Source

    SetDocument(Int32)

    Sets iteration to the specified docID

    Declaration
    public abstract void SetDocument(int docID)
    Parameters
    Type Name Description
    System.Int32 docID

    document ID

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