Class PostingsConsumer

Abstract API that consumes postings for an individual term.

The lifecycle is:

  1. PostingsConsumer is returned for each term by StartTerm(BytesRef).
  2. StartDoc(Int32, Int32) is called for each document where the term occurs, specifying id and term frequency for that document.
  3. If positions are enabled for the field, then AddPosition(Int32, BytesRef, Int32, Int32) will be called for each occurrence in the document.
  4. FinishDoc() is called when the producer is done adding positions to the document.

@lucene.experimental

Inheritance
System.Object
PostingsConsumer
PostingsWriterBase
Assembly: DistributedLucene.Net.dll
Syntax
public abstract class PostingsConsumer : object

Constructors

Name Description
PostingsConsumer()

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

Methods

Name Description
AddPosition(Int32, BytesRef, Int32, Int32)

Add a new position & payload, and start/end offset. A null payload means no payload; a non-null payload with zero length also means no payload. Caller may reuse the BytesRef for the payload between calls (method must fully consume the payload). startOffset and endOffset will be -1 when offsets are not indexed.
FinishDoc()

Called when we are done adding positions & payloads for each doc.
Merge(MergeState, IndexOptions, DocsEnum, FixedBitSet)

Default merge impl: append documents, mapping around deletes.
StartDoc(Int32, Int32)

Adds a new doc in this term. freq will be -1 when term frequencies are omitted for the field.

Extension Methods