Class Lucene90CompressingTermVectorsWriter
- java.lang.Object
-
- org.apache.lucene.codecs.TermVectorsWriter
-
- org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingTermVectorsWriter
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Accountable
public final class Lucene90CompressingTermVectorsWriter extends TermVectorsWriter
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
-
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPosition(int position, int startOffset, int endOffset, BytesRef payload)Adds a term position and offsetsvoidaddProx(int numProx, DataInput positions, DataInput offsets)Called by IndexWriter when writing new segments.voidclose()voidfinish(int numDocs)Called beforeTermVectorsWriter.close(), passing in the number of documents that were written.voidfinishDocument()Called after a doc and all its fields have been added.voidfinishField()Called after a field and all its terms have been added.Collection<Accountable>getChildResources()Returns nested resources of this class.intmerge(MergeState mergeState)Merges in the term vectors from the readers inmergeState.longramBytesUsed()Return the memory usage of this object in bytes.voidstartDocument(int numVectorFields)Called before writing the term vectors of the document.voidstartField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads)Called before writing the terms of the field.voidstartTerm(BytesRef term, int freq)Adds a term and its term frequencyfreq.-
Methods inherited from class org.apache.lucene.codecs.TermVectorsWriter
addAllDocVectors, finishTerm
-
-
-
-
Method Detail
-
close
public void close() throws IOException- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classTermVectorsWriter- Throws:
IOException
-
startDocument
public void startDocument(int numVectorFields) throws IOExceptionDescription copied from class:TermVectorsWriterCalled before writing the term vectors of the document.TermVectorsWriter.startField(FieldInfo, int, boolean, boolean, boolean)will be callednumVectorFieldstimes. Note that if term vectors are enabled, this is called even if the document has no vector fields, in this casenumVectorFieldswill be zero.- Specified by:
startDocumentin classTermVectorsWriter- Throws:
IOException
-
finishDocument
public void finishDocument() throws IOExceptionDescription copied from class:TermVectorsWriterCalled after a doc and all its fields have been added.- Overrides:
finishDocumentin classTermVectorsWriter- Throws:
IOException
-
startField
public void startField(FieldInfo info, int numTerms, boolean positions, boolean offsets, boolean payloads) throws IOException
Description copied from class:TermVectorsWriterCalled before writing the terms of the field.TermVectorsWriter.startTerm(BytesRef, int)will be callednumTermstimes.- Specified by:
startFieldin classTermVectorsWriter- Throws:
IOException
-
finishField
public void finishField() throws IOExceptionDescription copied from class:TermVectorsWriterCalled after a field and all its terms have been added.- Overrides:
finishFieldin classTermVectorsWriter- Throws:
IOException
-
startTerm
public void startTerm(BytesRef term, int freq) throws IOException
Description copied from class:TermVectorsWriterAdds a term and its term frequencyfreq. If this field has positions and/or offsets enabled, thenTermVectorsWriter.addPosition(int, int, int, BytesRef)will be calledfreqtimes respectively.- Specified by:
startTermin classTermVectorsWriter- Throws:
IOException
-
addPosition
public void addPosition(int position, int startOffset, int endOffset, BytesRef payload) throws IOExceptionDescription copied from class:TermVectorsWriterAdds a term position and offsets- Specified by:
addPositionin classTermVectorsWriter- Throws:
IOException
-
finish
public void finish(int numDocs) throws IOExceptionDescription copied from class:TermVectorsWriterCalled 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:
finishin classTermVectorsWriter- Throws:
IOException
-
addProx
public void addProx(int numProx, DataInput positions, DataInput offsets) throws IOExceptionDescription copied from class:TermVectorsWriterCalled 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:
addProxin classTermVectorsWriter- Throws:
IOException
-
merge
public int merge(MergeState mergeState) throws IOException
Description copied from class:TermVectorsWriterMerges 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(int), returning the number of documents that were written. Implementations can override this method for more sophisticated merging (bulk-byte copying, etc).- Overrides:
mergein classTermVectorsWriter- Throws:
IOException
-
ramBytesUsed
public long ramBytesUsed()
Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal.
-
getChildResources
public Collection<Accountable> getChildResources()
Description copied from interface:AccountableReturns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).- See Also:
Accountables
-
-