Class CompressingTermVectorsWriter

TermVectorsWriter for CompressingTermVectorsFormat.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
object
TermVectorsWriter
CompressingTermVectorsWriter
Implements
Inherited Members
Namespace: Lucene.Net.Codecs.Compressing
Assembly: Lucene.Net.dll
Syntax
public sealed class CompressingTermVectorsWriter : TermVectorsWriter, IDisposable

Constructors

CompressingTermVectorsWriter(Directory, SegmentInfo, string, IOContext, string, CompressionMode, int)

Sole constructor.

Declaration
public CompressingTermVectorsWriter(Directory directory, SegmentInfo si, string segmentSuffix, IOContext context, string formatName, CompressionMode compressionMode, int chunkSize)
Parameters
Type Name Description
Directory directory
SegmentInfo si
string segmentSuffix
IOContext context
string formatName
CompressionMode compressionMode
int chunkSize

Properties

Comparer

Return the IComparer{BytesRef} used to sort terms before feeding to this API.

Declaration
public override IComparer<BytesRef> Comparer { get; }
Property Value
Type Description
IComparer<BytesRef>
Overrides

Methods

Abort()

Aborts writing entirely, implementation should remove any partially-written files, etc.

Declaration
public override void Abort()
Overrides

AddPosition(int, int, int, BytesRef)

Adds a term position and offsets.

Declaration
public override void AddPosition(int position, int startOffset, int endOffset, BytesRef payload)
Parameters
Type Name Description
int position
int startOffset
int endOffset
BytesRef payload
Overrides

AddProx(int, DataInput, DataInput)

Called by IndexWriter when writing new segments.

This is an expert API that allows the codec to consume positions and offsets directly from the indexer.

The default implementation calls AddPosition(int, int, int, BytesRef), but subclasses can override this if they want to efficiently write all the positions, then all the offsets, for example.

NOTE: this API is extremely expert and subject to change or removal!!!

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration
public override void AddProx(int numProx, DataInput positions, DataInput offsets)
Parameters
Type Name Description
int numProx
DataInput positions
DataInput offsets
Overrides

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

Finish(FieldInfos, int)

Called before Dispose(bool), passing in the number of documents that were written. Note that this is intentionally redundant (equivalent to the number of calls to StartDocument(int), but a Codec should check that this is the case to detect the bug described in LUCENE-1282.

Declaration
public override void Finish(FieldInfos fis, int numDocs)
Parameters
Type Name Description
FieldInfos fis
int numDocs
Overrides

FinishDocument()

Called after a doc and all its fields have been added.

Declaration
public override void FinishDocument()
Overrides

FinishField()

Called after a field and all its terms have been added.

Declaration
public override void FinishField()
Overrides

Merge(MergeState)

Merges in the term vectors from the readers in mergeState. The default implementation skips over deleted documents, and uses StartDocument(int), StartField(FieldInfo, int, bool, bool, bool), StartTerm(BytesRef, int), AddPosition(int, int, int, BytesRef), and Finish(FieldInfos, int), returning the number of documents that were written. Implementations can override this method for more sophisticated merging (bulk-byte copying, etc).

Declaration
public override int Merge(MergeState mergeState)
Parameters
Type Name Description
MergeState mergeState
Returns
Type Description
int
Overrides

StartDocument(int)

Called before writing the term vectors of the document. StartField(FieldInfo, int, bool, bool, bool) will be called numVectorFields times. Note that if term vectors are enabled, this is called even if the document has no vector fields, in this case numVectorFields will be zero.

Declaration
public override void StartDocument(int numVectorFields)
Parameters
Type Name Description
int numVectorFields
Overrides

StartField(FieldInfo, int, bool, bool, bool)

Called before writing the terms of the field. StartTerm(BytesRef, int) will be called numTerms times.

Declaration
public override void StartField(FieldInfo info, int numTerms, bool positions, bool offsets, bool payloads)
Parameters
Type Name Description
FieldInfo info
int numTerms
bool positions
bool offsets
bool payloads
Overrides

StartTerm(BytesRef, int)

Adds a term and its term frequency freq. If this field has positions and/or offsets enabled, then AddPosition(int, int, int, BytesRef) will be called freq times respectively.

Declaration
public override void StartTerm(BytesRef term, int freq)
Parameters
Type Name Description
BytesRef term
int freq
Overrides

Implements