Uses of Class
org.apache.lucene.store.IndexInput
Package
Description
Codecs API: API for customization of the encoding and structure of the index.
Lucene 9.0 file format.
Binary i/o API, used for all index data.
Some utility classes.
Block KD-tree, implementing the generic spatial data structure described in this paper.
Packed integer arrays and streams.
-
Uses of IndexInput in org.apache.lucene.codecs
Modifier and TypeMethodDescriptionstatic long
CodecUtil.checksumEntireFile
(IndexInput input) Clones the provided input, reads all bytes from the file, and callsCodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput)
abstract void
PostingsReaderBase.init
(IndexInput termsIn, SegmentReadState state) Performs any initialization, such as reading and verifying the header from the provided terms dictionaryIndexInput
.protected long
MultiLevelSkipListReader.readChildPointer
(IndexInput skipStream) read the child pointer written viaMultiLevelSkipListWriter.writeChildPointer(long, DataOutput)
.static byte[]
CodecUtil.readFooter
(IndexInput in) Retrieves the full footer from the providedIndexInput
.static byte[]
CodecUtil.readIndexHeader
(IndexInput in) Retrieves the full index header from the providedIndexInput
.protected long
MultiLevelSkipListReader.readLevelLength
(IndexInput skipStream) read the length of the current level written viaMultiLevelSkipListWriter.writeLevelLength(long, IndexOutput)
.protected abstract int
MultiLevelSkipListReader.readSkipData
(int level, IndexInput skipStream) Subclasses must implement the actual skip data encoding in this method.static long
CodecUtil.retrieveChecksum
(IndexInput in) Returns (but does not validate) the checksum previously written byCodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput)
.static long
CodecUtil.retrieveChecksum
(IndexInput in, long expectedLength) Returns (but does not validate) the checksum previously written byCodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput)
.static void
CodecUtil.verifyAndCopyIndexHeader
(IndexInput in, DataOutput out, byte[] expectedID) Expert: verifies the incomingIndexInput
has an index header and that its segment ID matches the expected one, and then copies that index header into the providedDataOutput
.ModifierConstructorDescriptionprotected
MultiLevelSkipListReader
(IndexInput skipStream, int maxSkipLevels, int skipInterval) Creates aMultiLevelSkipListReader
, whereskipInterval
andskipMultiplier
are the same.protected
MultiLevelSkipListReader
(IndexInput skipStream, int maxSkipLevels, int skipInterval, int skipMultiplier) Creates aMultiLevelSkipListReader
. -
Uses of IndexInput in org.apache.lucene.codecs.lucene90
Modifier and TypeMethodDescriptionvoid
Lucene90PostingsReader.init
(IndexInput termsIn, SegmentReadState state) -
Uses of IndexInput in org.apache.lucene.store
Modifier and TypeClassDescriptionclass
Simple implementation ofChecksumIndexInput
that wraps another input and delegates calls.class
Base implementation class for bufferedIndexInput
.class
Base IndexInput implementation that uses an array of ByteBuffers to represent a file.final class
class
Extension of IndexInput, computing checksum as it goes.Modifier and TypeFieldDescriptionstatic final BiFunction<String,
ByteBuffersDataOutput, IndexInput> ByteBuffersDirectory.OUTPUT_AS_BYTE_ARRAY
static final BiFunction<String,
ByteBuffersDataOutput, IndexInput> ByteBuffersDirectory.OUTPUT_AS_MANY_BUFFERS
static final BiFunction<String,
ByteBuffersDataOutput, IndexInput> ByteBuffersDirectory.OUTPUT_AS_MANY_BUFFERS_LUCENE
static final BiFunction<String,
ByteBuffersDataOutput, IndexInput> ByteBuffersDirectory.OUTPUT_AS_ONE_BUFFER
Modifier and TypeMethodDescriptionBufferedChecksumIndexInput.clone()
ByteBuffersIndexInput.clone()
IndexInput.clone()
Returns a clone of this stream.abstract IndexInput
Opens a stream for reading an existing file.Creates an IndexInput for the file with the given name.abstract IndexInput
Creates a slice of this index input, with the given description, offset, and length.Modifier and TypeMethodDescriptionstatic BufferedIndexInput
BufferedIndexInput.wrap
(String sliceDescription, IndexInput other, long offset, long length) Wraps a portion of another IndexInput with buffering.ModifierConstructorDescriptionCreates a new BufferedChecksumIndexInputModifierConstructorDescriptionByteBuffersDirectory
(LockFactory factory, Supplier<ByteBuffersDataOutput> bbOutputSupplier, BiFunction<String, ByteBuffersDataOutput, IndexInput> outputToInput) -
Uses of IndexInput in org.apache.lucene.util
Modifier and TypeMethodDescriptionvoid
PagedBytes.copy
(IndexInput in, long byteCount) Read this many bytes from in -
Uses of IndexInput in org.apache.lucene.util.bkd
ModifierConstructorDescriptionBKDReader
(IndexInput metaIn, IndexInput indexIn, IndexInput dataIn) Caller must pre-seek the providedIndexInput
to the index location thatBKDWriter.finish(org.apache.lucene.store.IndexOutput, org.apache.lucene.store.IndexOutput, org.apache.lucene.store.IndexOutput)
returned. -
Uses of IndexInput in org.apache.lucene.util.packed
Modifier and TypeMethodDescriptionstatic DirectMonotonicReader.Meta
DirectMonotonicReader.loadMeta
(IndexInput metaIn, long numValues, int blockShift) Load metadata from the givenIndexInput
.static MonotonicBlockPackedReader
MonotonicBlockPackedReader.of
(IndexInput in, int packedIntsVersion, int blockSize, long valueCount) Sole constructor.