Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class DocValues

    This class contains utility methods and constants for DocValues

    Inheritance
    object
    DocValues
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class DocValues

    Fields

    EMPTY_BINARY

    An empty BinaryDocValues which returns EMPTY_BYTES for every document

    Declaration
    public static readonly BinaryDocValues EMPTY_BINARY
    Field Value
    Type Description
    BinaryDocValues

    EMPTY_NUMERIC

    An empty NumericDocValues which returns zero for every document

    Declaration
    public static readonly NumericDocValues EMPTY_NUMERIC
    Field Value
    Type Description
    NumericDocValues

    EMPTY_SORTED

    An empty SortedDocValues which returns EMPTY_BYTES for every document

    Declaration
    public static readonly SortedDocValues EMPTY_SORTED
    Field Value
    Type Description
    SortedDocValues

    EMPTY_SORTED_SET

    An empty SortedDocValues which returns NO_MORE_ORDS for every document

    Declaration
    public static readonly SortedSetDocValues EMPTY_SORTED_SET
    Field Value
    Type Description
    SortedSetDocValues

    Methods

    DocsWithValue(SortedDocValues, int)

    Returns a IBits representing all documents from dv that have a value.

    Declaration
    public static IBits DocsWithValue(SortedDocValues dv, int maxDoc)
    Parameters
    Type Name Description
    SortedDocValues dv
    int maxDoc
    Returns
    Type Description
    IBits

    DocsWithValue(SortedSetDocValues, int)

    Returns a IBits representing all documents from dv that have a value.

    Declaration
    public static IBits DocsWithValue(SortedSetDocValues dv, int maxDoc)
    Parameters
    Type Name Description
    SortedSetDocValues dv
    int maxDoc
    Returns
    Type Description
    IBits

    Singleton(SortedDocValues)

    Returns a multi-valued view over the provided SortedDocValues

    Declaration
    public static SortedSetDocValues Singleton(SortedDocValues dv)
    Parameters
    Type Name Description
    SortedDocValues dv
    Returns
    Type Description
    SortedSetDocValues

    UnwrapSingleton(SortedSetDocValues)

    Returns a single-valued view of the SortedSetDocValues, if it was previously wrapped with Singleton(SortedDocValues), or null.

    Declaration
    public static SortedDocValues UnwrapSingleton(SortedSetDocValues dv)
    Parameters
    Type Name Description
    SortedSetDocValues dv
    Returns
    Type Description
    SortedDocValues
    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.