Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Lucene45DocValuesConsumer

    Writer for Lucene45DocValuesFormat

    Inheritance
    object
    DocValuesConsumer
    Lucene45DocValuesConsumer
    Implements
    IDisposable
    Inherited Members
    DocValuesConsumer.MergeNumericField(FieldInfo, MergeState, IList<NumericDocValues>, IList<IBits>)
    DocValuesConsumer.MergeBinaryField(FieldInfo, MergeState, IList<BinaryDocValues>, IList<IBits>)
    DocValuesConsumer.MergeSortedField(FieldInfo, MergeState, IList<SortedDocValues>)
    DocValuesConsumer.MergeSortedSetField(FieldInfo, MergeState, IList<SortedSetDocValues>)
    DocValuesConsumer.Dispose()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Codecs.Lucene45
    Assembly: Lucene.Net.dll
    Syntax
    public class Lucene45DocValuesConsumer : DocValuesConsumer, IDisposable

    Constructors

    Lucene45DocValuesConsumer(SegmentWriteState, string, string, string, string)

    Expert: Creates a new writer.

    Declaration
    public Lucene45DocValuesConsumer(SegmentWriteState state, string dataCodec, string dataExtension, string metaCodec, string metaExtension)
    Parameters
    Type Name Description
    SegmentWriteState state
    string dataCodec
    string dataExtension
    string metaCodec
    string metaExtension

    Fields

    BINARY_FIXED_UNCOMPRESSED

    Uncompressed binary, written directly (fixed length).

    Declaration
    public const int BINARY_FIXED_UNCOMPRESSED = 0
    Field Value
    Type Description
    int

    BINARY_PREFIX_COMPRESSED

    Compressed binary with shared prefixes

    Declaration
    public const int BINARY_PREFIX_COMPRESSED = 2
    Field Value
    Type Description
    int

    BINARY_VARIABLE_UNCOMPRESSED

    Uncompressed binary, written directly (variable length).

    Declaration
    public const int BINARY_VARIABLE_UNCOMPRESSED = 1
    Field Value
    Type Description
    int

    DELTA_COMPRESSED

    Compressed using packed blocks of ints.

    Declaration
    public const int DELTA_COMPRESSED = 0
    Field Value
    Type Description
    int

    GCD_COMPRESSED

    Compressed by computing the GCD.

    Declaration
    public const int GCD_COMPRESSED = 1
    Field Value
    Type Description
    int

    SORTED_SET_SINGLE_VALUED_SORTED

    Single-valued sorted set values, encoded as sorted values, so no level of indirection: docId -> ord.

    Declaration
    public static readonly int SORTED_SET_SINGLE_VALUED_SORTED
    Field Value
    Type Description
    int

    SORTED_SET_WITH_ADDRESSES

    Standard storage for sorted set values with 1 level of indirection: docId -> address -> ord.

    Declaration
    public static readonly int SORTED_SET_WITH_ADDRESSES
    Field Value
    Type Description
    int

    TABLE_COMPRESSED

    Compressed by giving IDs to unique values.

    Declaration
    public const int TABLE_COMPRESSED = 2
    Field Value
    Type Description
    int

    Methods

    AddBinaryField(FieldInfo, IEnumerable<BytesRef>)

    Writes binary docvalues for a field.

    Declaration
    public override void AddBinaryField(FieldInfo field, IEnumerable<BytesRef> values)
    Parameters
    Type Name Description
    FieldInfo field

    Field information.

    IEnumerable<BytesRef> values

    IEnumerable<T> of binary values (one for each document). null indicates a missing value.

    Overrides
    DocValuesConsumer.AddBinaryField(FieldInfo, IEnumerable<BytesRef>)
    Exceptions
    Type Condition
    IOException

    If an I/O error occurred.

    AddNumericField(FieldInfo, IEnumerable<long?>)

    Writes numeric docvalues for a field.

    Declaration
    public override void AddNumericField(FieldInfo field, IEnumerable<long?> values)
    Parameters
    Type Name Description
    FieldInfo field

    Field information.

    IEnumerable<long?> values

    IEnumerable<T> of numeric values (one for each document). null indicates a missing value.

    Overrides
    DocValuesConsumer.AddNumericField(FieldInfo, IEnumerable<long?>)
    Exceptions
    Type Condition
    IOException

    If an I/O error occurred.

    AddSortedField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<long?>)

    Writes pre-sorted binary docvalues for a field.

    Declaration
    public override void AddSortedField(FieldInfo field, IEnumerable<BytesRef> values, IEnumerable<long?> docToOrd)
    Parameters
    Type Name Description
    FieldInfo field

    Field information.

    IEnumerable<BytesRef> values

    IEnumerable<T> of binary values in sorted order (deduplicated).

    IEnumerable<long?> docToOrd

    IEnumerable<T> of ordinals (one for each document). -1 indicates a missing value.

    Overrides
    DocValuesConsumer.AddSortedField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<long?>)
    Exceptions
    Type Condition
    IOException

    If an I/O error occurred.

    AddSortedSetField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<long?>, IEnumerable<long?>)

    Writes pre-sorted set docvalues for a field

    Declaration
    public override void AddSortedSetField(FieldInfo field, IEnumerable<BytesRef> values, IEnumerable<long?> docToOrdCount, IEnumerable<long?> ords)
    Parameters
    Type Name Description
    FieldInfo field

    Field information.

    IEnumerable<BytesRef> values

    IEnumerable<T> of binary values in sorted order (deduplicated).

    IEnumerable<long?> docToOrdCount

    IEnumerable<T> of the number of values for each document. A zero ordinal count indicates a missing value.

    IEnumerable<long?> ords

    IEnumerable<T> of ordinal occurrences (docToOrdCount*maxDoc total).

    Overrides
    DocValuesConsumer.AddSortedSetField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<long?>, IEnumerable<long?>)
    Exceptions
    Type Condition
    IOException

    If an I/O error occurred.

    AddTermsDict(FieldInfo, IEnumerable<BytesRef>)

    Expert: writes a value dictionary for a sorted/sortedset field.

    Declaration
    protected virtual void AddTermsDict(FieldInfo field, IEnumerable<BytesRef> values)
    Parameters
    Type Name Description
    FieldInfo field
    IEnumerable<BytesRef> values

    Dispose(bool)

    Implementations must override and should dispose all resources used by this instance.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing
    Overrides
    DocValuesConsumer.Dispose(bool)

    Implements

    IDisposable
    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.