Class CompressingTermVectorsWriter
java.lang.Object
org.apache.lucene.codecs.TermVectorsWriter
org.apache.lucene.codecs.compressing.CompressingTermVectorsWriter
- All Implemented Interfaces:
Closeable
,AutoCloseable
-
Constructor Summary
ConstructorsConstructorDescriptionCompressingTermVectorsWriter
(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize) Sole constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abort()
Aborts writing entirely, implementation should remove any partially-written files, etc.void
addPosition
(int position, int startOffset, int endOffset, BytesRef payload) Adds a term position and offsetsvoid
Called by IndexWriter when writing new segments.void
close()
void
finish
(FieldInfos fis, int numDocs) Called beforeTermVectorsWriter.close()
, passing in the number of documents that were written.void
Called after a doc and all its fields have been added.void
Called after a field and all its terms have been added.Return the BytesRef Comparator used to sort terms before feeding to this API.int
merge
(MergeState mergeState) Merges in the term vectors from the readers inmergeState
.void
startDocument
(int numVectorFields) Called before writing the term vectors of the document.void
startField
(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads) Called before writing the terms of the field.void
Adds a term and its term frequencyfreq
.Methods inherited from class org.apache.lucene.codecs.TermVectorsWriter
addAllDocVectors, finishTerm
-
Constructor Details
-
CompressingTermVectorsWriter
public CompressingTermVectorsWriter(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize) throws IOException Sole constructor.- Throws:
IOException
-
-
Method Details
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classTermVectorsWriter
- Throws:
IOException
-
abort
public void abort()Description copied from class:TermVectorsWriter
Aborts writing entirely, implementation should remove any partially-written files, etc.- Specified by:
abort
in classTermVectorsWriter
-
startDocument
Description copied from class:TermVectorsWriter
Called before writing the term vectors of the document.TermVectorsWriter.startField(FieldInfo, int, boolean, boolean, boolean)
will be callednumVectorFields
times. Note that if term vectors are enabled, this is called even if the document has no vector fields, in this casenumVectorFields
will be zero.- Specified by:
startDocument
in classTermVectorsWriter
- Throws:
IOException
-
finishDocument
Description copied from class:TermVectorsWriter
Called after a doc and all its fields have been added.- Overrides:
finishDocument
in classTermVectorsWriter
- Throws:
IOException
-
startField
public void startField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads) throws IOException Description copied from class:TermVectorsWriter
Called before writing the terms of the field.TermVectorsWriter.startTerm(BytesRef, int)
will be callednumTerms
times.- Specified by:
startField
in classTermVectorsWriter
- Throws:
IOException
-
finishField
Description copied from class:TermVectorsWriter
Called after a field and all its terms have been added.- Overrides:
finishField
in classTermVectorsWriter
- Throws:
IOException
-
startTerm
Description copied from class:TermVectorsWriter
Adds a term and its term frequencyfreq
. If this field has positions and/or offsets enabled, thenTermVectorsWriter.addPosition(int, int, int, BytesRef)
will be calledfreq
times respectively.- Specified by:
startTerm
in classTermVectorsWriter
- Throws:
IOException
-
addPosition
public void addPosition(int position, int startOffset, int endOffset, BytesRef payload) throws IOException Description copied from class:TermVectorsWriter
Adds a term position and offsets- Specified by:
addPosition
in classTermVectorsWriter
- Throws:
IOException
-
finish
Description copied from class:TermVectorsWriter
Called beforeTermVectorsWriter.close()
, passing in the number of documents that were written. Note that this is intentionally redundant (equivalent to the number of calls toTermVectorsWriter.startDocument(int)
, but a Codec should check that this is the case to detect the JRE bug described in LUCENE-1282.- Specified by:
finish
in classTermVectorsWriter
- Throws:
IOException
-
getComparator
Description copied from class:TermVectorsWriter
Return the BytesRef Comparator used to sort terms before feeding to this API.- Specified by:
getComparator
in classTermVectorsWriter
-
addProx
Description copied from class:TermVectorsWriter
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
TermVectorsWriter.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!!!
- Overrides:
addProx
in classTermVectorsWriter
- Throws:
IOException
-
merge
Description copied from class:TermVectorsWriter
Merges in the term vectors from the readers inmergeState
. The default implementation skips over deleted documents, and usesTermVectorsWriter.startDocument(int)
,TermVectorsWriter.startField(FieldInfo, int, boolean, boolean, boolean)
,TermVectorsWriter.startTerm(BytesRef, int)
,TermVectorsWriter.addPosition(int, int, int, BytesRef)
, andTermVectorsWriter.finish(FieldInfos, int)
, returning the number of documents that were written. Implementations can override this method for more sophisticated merging (bulk-byte copying, etc).- Overrides:
merge
in classTermVectorsWriter
- Throws:
IOException
-