Uses of Class
org.apache.lucene.store.IndexInput
Packages that use IndexInput
Package
Description
Codecs API: API for customization of the encoding and structure of the index.
Lucene 10.1 file format.
Lucene 9.0 file format.
Lucene 9.5 file format.
Lucene 9.9 file format.
Internal implementations to support SIMD vectorization.
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.
Finite state transducers
Packed integer arrays and streams.
Provides quantization methods for scaling vector values to smaller data types and possibly fewer
dimensions
-
Uses of IndexInput in org.apache.lucene.codecs
Methods in org.apache.lucene.codecs with parameters of type IndexInputModifier 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
.Constructors in org.apache.lucene.codecs with parameters of type IndexInputModifierConstructorDescriptionprotected
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.lucene101
Methods in org.apache.lucene.codecs.lucene101 with parameters of type IndexInputModifier and TypeMethodDescriptionvoid
Lucene101PostingsReader.init
(IndexInput termsIn, SegmentReadState state) Constructors in org.apache.lucene.codecs.lucene101 with parameters of type IndexInputModifierConstructorDescriptionPostingIndexInput
(IndexInput in, ForUtil forUtil, ForDeltaUtil forDeltaUtil) -
Uses of IndexInput in org.apache.lucene.codecs.lucene90
Methods in org.apache.lucene.codecs.lucene90 that return IndexInputModifier and TypeMethodDescriptionstatic IndexInput
IndexedDISI.createBlockSlice
(IndexInput slice, String sliceDescription, long offset, long length, int jumpTableEntryCount) Helper method for usingIndexedDISI(IndexInput, RandomAccessInput, int, byte, long)
.Methods in org.apache.lucene.codecs.lucene90 with parameters of type IndexInputModifier and TypeMethodDescriptionstatic IndexInput
IndexedDISI.createBlockSlice
(IndexInput slice, String sliceDescription, long offset, long length, int jumpTableEntryCount) Helper method for usingIndexedDISI(IndexInput, RandomAccessInput, int, byte, long)
.static RandomAccessInput
IndexedDISI.createJumpTable
(IndexInput slice, long offset, long length, int jumpTableEntryCount) Helper method for usingIndexedDISI(IndexInput, RandomAccessInput, int, byte, long)
.Constructors in org.apache.lucene.codecs.lucene90 with parameters of type IndexInputModifierConstructorDescriptionIndexedDISI
(IndexInput in, long offset, long length, int jumpTableEntryCount, byte denseRankPower, long cost) This constructor always creates a new blockSlice and a new jumpTable from in, to ensure that operations are independent from the caller. -
Uses of IndexInput in org.apache.lucene.codecs.lucene95
Fields in org.apache.lucene.codecs.lucene95 declared as IndexInputModifier and TypeFieldDescriptionprotected final IndexInput
OffHeapByteVectorValues.slice
protected final IndexInput
OffHeapFloatVectorValues.slice
Methods in org.apache.lucene.codecs.lucene95 that return IndexInputModifier and TypeMethodDescriptionHasIndexSlice.getSlice()
Returns an IndexInput from which to read this instance's values.OffHeapByteVectorValues.getSlice()
OffHeapFloatVectorValues.getSlice()
Methods in org.apache.lucene.codecs.lucene95 with parameters of type IndexInputModifier and TypeMethodDescriptionOrdToDocDISIReaderConfiguration.fromStoredMeta
(IndexInput inputMeta, int size) Reads in the necessary fields stored in the outputMeta to configureDirectMonotonicReader
andIndexedDISI
.OrdToDocDISIReaderConfiguration.getDirectMonotonicReader
(IndexInput dataIn) OrdToDocDISIReaderConfiguration.getIndexedDISI
(IndexInput dataIn) static OffHeapByteVectorValues
OffHeapByteVectorValues.load
(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData) static OffHeapFloatVectorValues
OffHeapFloatVectorValues.load
(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData) Constructors in org.apache.lucene.codecs.lucene95 with parameters of type IndexInputModifierConstructorDescriptionDenseOffHeapVectorValues
(int dimension, int size, IndexInput slice, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction vectorSimilarityFunction) DenseOffHeapVectorValues
(int dimension, int size, IndexInput slice, int byteSize, FlatVectorsScorer flatVectorsScorer, VectorSimilarityFunction similarityFunction) -
Uses of IndexInput in org.apache.lucene.codecs.lucene99
Fields in org.apache.lucene.codecs.lucene99 declared as IndexInputModifier and TypeFieldDescriptionprotected final IndexInput
OffHeapQuantizedByteVectorValues.slice
Methods in org.apache.lucene.codecs.lucene99 that return IndexInputMethods in org.apache.lucene.codecs.lucene99 with parameters of type IndexInputModifier and TypeMethodDescriptionOffHeapQuantizedByteVectorValues.load
(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, long quantizedVectorDataOffset, long quantizedVectorDataLength, IndexInput vectorData) Constructors in org.apache.lucene.codecs.lucene99 with parameters of type IndexInputModifierConstructorDescriptionDenseOffHeapVectorValues
(int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice) -
Uses of IndexInput in org.apache.lucene.internal.vectorization
Fields in org.apache.lucene.internal.vectorization declared as IndexInputMethods in org.apache.lucene.internal.vectorization with parameters of type IndexInputModifier and TypeMethodDescriptionabstract PostingDecodingUtil
VectorizationProvider.newPostingDecodingUtil
(IndexInput input) Create a newPostingDecodingUtil
for the givenIndexInput
.Constructors in org.apache.lucene.internal.vectorization with parameters of type IndexInputModifierConstructorDescriptionprotected
Sole constructor, called by sub-classes. -
Uses of IndexInput in org.apache.lucene.store
Subclasses of IndexInput in org.apache.lucene.storeModifier and TypeClassDescriptionclass
Simple implementation ofChecksumIndexInput
that wraps another input and delegates calls.class
Base implementation class for bufferedIndexInput
.final class
class
Extension of IndexInput, computing checksum as it goes.class
IndexInput implementation that delegates calls to another directory.Fields in org.apache.lucene.store declared as IndexInputFields in org.apache.lucene.store with type parameters of type IndexInputModifier 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_ONE_BUFFER
Methods in org.apache.lucene.store that return IndexInputModifier and TypeMethodDescriptionBufferedChecksumIndexInput.clone()
ByteBuffersIndexInput.clone()
IndexInput.clone()
Returns a clone of this stream.FilterIndexInput.getDelegate()
Gets the delegate that was passed in on creationabstract 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.IndexInput.slice
(String sliceDescription, long offset, long length, ReadAdvice readAdvice) Create a slice with a specificReadAdvice
.static IndexInput
FilterIndexInput.unwrap
(IndexInput in) Unwraps all FilterIndexInputs until the first non-FilterIndexInput IndexInput instance and returns itstatic IndexInput
FilterIndexInput.unwrapOnlyTest
(IndexInput in) Unwraps all test FilterIndexInputs until the first non-test FilterIndexInput IndexInput instance and returns itMethods in org.apache.lucene.store with parameters of type IndexInputModifier and TypeMethodDescriptionstatic IndexInput
FilterIndexInput.unwrap
(IndexInput in) Unwraps all FilterIndexInputs until the first non-FilterIndexInput IndexInput instance and returns itstatic IndexInput
FilterIndexInput.unwrapOnlyTest
(IndexInput in) Unwraps all test FilterIndexInputs until the first non-test FilterIndexInput IndexInput instance and returns itstatic BufferedIndexInput
BufferedIndexInput.wrap
(String sliceDescription, IndexInput other, long offset, long length) Wraps a portion of another IndexInput with buffering.Constructors in org.apache.lucene.store with parameters of type IndexInputModifierConstructorDescriptionCreates a new BufferedChecksumIndexInputFilterIndexInput
(String resourceDescription, IndexInput in) Creates a FilterIndexInput with a resource description and wrapped delegate IndexInputConstructor parameters in org.apache.lucene.store with type arguments of type IndexInputModifierConstructorDescriptionByteBuffersDirectory
(LockFactory factory, Supplier<ByteBuffersDataOutput> bbOutputSupplier, BiFunction<String, ByteBuffersDataOutput, IndexInput> outputToInput) -
Uses of IndexInput in org.apache.lucene.util
Methods in org.apache.lucene.util with parameters of type IndexInputModifier and TypeMethodDescriptionvoid
PagedBytes.copy
(IndexInput in, long byteCount) Read this many bytes from in -
Uses of IndexInput in org.apache.lucene.util.bkd
Constructors in org.apache.lucene.util.bkd with parameters of type IndexInputModifierConstructorDescriptionBKDReader
(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.fst
Constructors in org.apache.lucene.util.fst with parameters of type IndexInputModifierConstructorDescriptionOffHeapFSTStore
(IndexInput in, long offset, FST.FSTMetadata<?> metadata) -
Uses of IndexInput in org.apache.lucene.util.packed
Methods in org.apache.lucene.util.packed with parameters of type IndexInputModifier 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. -
Uses of IndexInput in org.apache.lucene.util.quantization
Methods in org.apache.lucene.util.quantization that return IndexInput