Class DocValuesConsumer

Abstract API that consumes numeric, binary and sorted docvalues. Concrete implementations of this actually do "something" with the docvalues (write it into the index in a specific format).

The lifecycle is:

  1. DocValuesConsumer is created by FieldsConsumer(SegmentWriteState) or NormsConsumer(SegmentWriteState).
  2. AddNumericField(FieldInfo, IEnumerable<Nullable<Int64>>), AddBinaryField(FieldInfo, IEnumerable<BytesRef>), or AddSortedField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<Nullable<Int64>>) are called for each Numeric, Binary, or Sorted docvalues field. The API is a "pull" rather than "push", and the implementation is free to iterate over the values multiple times ().
  3. After all fields are added, the consumer is Dispose()d.

@lucene.experimental

Inheritance
System.Object
DocValuesConsumer
Lucene45DocValuesConsumer
SimpleTextDocValuesWriter
Assembly: DistributedLucene.Net.dll
Syntax
public abstract class DocValuesConsumer : IDisposable

Constructors

Name Description
DocValuesConsumer()

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

Methods

Name Description
AddBinaryField(FieldInfo, IEnumerable<BytesRef>)

Writes binary docvalues for a field.

AddNumericField(FieldInfo, IEnumerable<Nullable<Int64>>)

Writes numeric docvalues for a field.

AddSortedField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<Nullable<Int64>>)

Writes pre-sorted binary docvalues for a field.

AddSortedSetField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<Nullable<Int64>>, IEnumerable<Nullable<Int64>>)

Writes pre-sorted set docvalues for a field

Dispose()

Disposes all resources used by this object.
Dispose(Boolean)

Implementations must override and should dispose all resources used by this instance.
MergeBinaryField(FieldInfo, MergeState, IList<BinaryDocValues>, IList<IBits>)

Merges the binary docvalues from toMerge.

The default implementation calls AddBinaryField(FieldInfo, IEnumerable<BytesRef>), passing an that merges and filters deleted documents on the fly.
MergeNumericField(FieldInfo, MergeState, IList<NumericDocValues>, IList<IBits>)

Merges the numeric docvalues from toMerge.

The default implementation calls AddNumericField(FieldInfo, IEnumerable<Nullable<Int64>>), passing an that merges and filters deleted documents on the fly.
MergeSortedField(FieldInfo, MergeState, IList<SortedDocValues>)

Merges the sorted docvalues from toMerge.

The default implementation calls AddSortedField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<Nullable<Int64>>), passing an that merges ordinals and values and filters deleted documents.
MergeSortedSetField(FieldInfo, MergeState, IList<SortedSetDocValues>)

Merges the sortedset docvalues from toMerge.

The default implementation calls AddSortedSetField(FieldInfo, IEnumerable<BytesRef>, IEnumerable<Nullable<Int64>>, IEnumerable<Nullable<Int64>>), passing an that merges ordinals and values and filters deleted documents.

Extension Methods