Module org.apache.lucene.core
Class Lucene90CompressingTermVectorsReader
java.lang.Object
org.apache.lucene.index.TermVectors
org.apache.lucene.codecs.TermVectorsReader
org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingTermVectorsReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Cloneable
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final record
private class
private static class
private static class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
private boolean
private final CompressionMode
private final Decompressor
private final FieldInfos
(package private) final FieldsIndex
private final long
private final long
private final long
private final long
private final int
private final int
private static final int
private static final int
private final long[]
private int
private final BlockPackedReaderIterator
(package private) final IndexInput
private final int
Fields inherited from class org.apache.lucene.index.TermVectors
EMPTY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Lucene90CompressingTermVectorsReader
(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Checks consistency of this reader.clone()
Create a clone that one caller at a time may use to read term vectors.void
close()
private void
get
(int doc) Returns term vectors for this document, or null if term vectors were not indexed.(package private) int
(package private) CompressionMode
(package private) FieldsIndex
(package private) long
Returns an instance optimized for merging.(package private) long
(package private) long
(package private) long
(package private) int
(package private) int
(package private) IndexInput
(package private) int
(package private) boolean
isLoaded
(int docID) Checks if a given docID was loaded in the current block state.private int[][]
positionIndex
(int skip, int numFields, LongValues numTerms, int[] termFreqs) void
prefetch
(int docID) Optional method: Give a hint to thisTermVectors
instance that the given document will be read in the near future.private int[][]
readPositions
(int skip, int numFields, LongValues flags, LongValues numTerms, int[] termFreqs, int flag, int totalPositions, int[][] positionIndex) private static RandomAccessInput
slice
(IndexInput in) private static int
sum
(int[] arr) toString()
Methods inherited from class org.apache.lucene.index.TermVectors
get
-
Field Details
-
PREFETCH_CACHE_SIZE
private static final int PREFETCH_CACHE_SIZE- See Also:
-
PREFETCH_CACHE_MASK
private static final int PREFETCH_CACHE_MASK- See Also:
-
fieldInfos
-
indexReader
-
vectorsStream
-
version
private final int version -
packedIntsVersion
private final int packedIntsVersion -
compressionMode
-
decompressor
-
chunkSize
private final int chunkSize -
numDocs
private final int numDocs -
closed
private boolean closed -
reader
-
numChunks
private final long numChunks -
numDirtyChunks
private final long numDirtyChunks -
numDirtyDocs
private final long numDirtyDocs -
maxPointer
private final long maxPointer -
blockState
-
prefetchedBlockIDCache
private final long[] prefetchedBlockIDCache -
prefetchedBlockIDCacheIndex
private int prefetchedBlockIDCacheIndex
-
-
Constructor Details
-
Lucene90CompressingTermVectorsReader
-
Lucene90CompressingTermVectorsReader
public Lucene90CompressingTermVectorsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) throws IOException Sole constructor.- Throws:
IOException
-
-
Method Details
-
getCompressionMode
CompressionMode getCompressionMode() -
getChunkSize
int getChunkSize() -
getPackedIntsVersion
int getPackedIntsVersion() -
getVersion
int getVersion() -
getIndexReader
FieldsIndex getIndexReader() -
getVectorsStream
IndexInput getVectorsStream() -
getMaxPointer
long getMaxPointer() -
getNumDirtyDocs
long getNumDirtyDocs() -
getNumDirtyChunks
long getNumDirtyChunks() -
getNumChunks
long getNumChunks() -
getNumDocs
int getNumDocs() -
ensureOpen
- Throws:
AlreadyClosedException
- if this TermVectorsReader is closed
-
close
- Throws:
IOException
-
clone
Description copied from class:TermVectorsReader
Create a clone that one caller at a time may use to read term vectors.- Specified by:
clone
in classTermVectorsReader
-
getMergeInstance
Description copied from class:TermVectorsReader
Returns an instance optimized for merging. This instance may only be consumed in the thread that calledTermVectorsReader.getMergeInstance()
.The default implementation returns
this
- Overrides:
getMergeInstance
in classTermVectorsReader
-
slice
- Throws:
IOException
-
isLoaded
boolean isLoaded(int docID) Checks if a given docID was loaded in the current block state. -
prefetch
Description copied from class:TermVectors
Optional method: Give a hint to thisTermVectors
instance that the given document will be read in the near future. This typically delegates toIndexInput.prefetch(long, long)
and is useful to parallelize I/O across multiple documents.NOTE: This API is expected to be called on a small enough set of doc IDs that they could all fit in the page cache. If you plan on retrieving a very large number of documents, it may be a good idea to perform calls to
TermVectors.prefetch(int)
andTermVectors.get(int)
in batches instead of prefetching all documents up-front.- Overrides:
prefetch
in classTermVectors
- Throws:
IOException
-
get
Description copied from class:TermVectors
Returns term vectors for this document, or null if term vectors were not indexed.The returned Fields instance acts like a single-document inverted index (the docID will be 0). If offsets are available they are in an
OffsetAttribute
available from thePostingsEnum
.- Specified by:
get
in classTermVectors
- Throws:
IOException
-
positionIndex
-
readPositions
private int[][] readPositions(int skip, int numFields, LongValues flags, LongValues numTerms, int[] termFreqs, int flag, int totalPositions, int[][] positionIndex) throws IOException - Throws:
IOException
-
sum
private static int sum(int[] arr) -
checkIntegrity
Description copied from class:TermVectorsReader
Checks consistency of this reader.Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.
- Specified by:
checkIntegrity
in classTermVectorsReader
- Throws:
IOException
-
toString
-