Uses of Class
org.apache.lucene.store.IndexInput
-
Packages that use IndexInput Package Description org.apache.lucene.codecs Codecs API: API for customization of the encoding and structure of the index.org.apache.lucene.codecs.lucene90 Lucene 9.0 file format.org.apache.lucene.codecs.lucene912 Lucene 9.12 file format.org.apache.lucene.codecs.lucene95 Lucene 9.5 file format.org.apache.lucene.codecs.lucene99 Lucene 9.9 file format.org.apache.lucene.internal.vectorization Internal implementations to support SIMD vectorization.org.apache.lucene.store Binary i/o API, used for all index data.org.apache.lucene.util Some utility classes.org.apache.lucene.util.bkd Block KD-tree, implementing the generic spatial data structure described in this paper.org.apache.lucene.util.fst Finite state transducersorg.apache.lucene.util.hnsw Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.org.apache.lucene.util.packed Packed integer arrays and streams. -
-
Uses of IndexInput in org.apache.lucene.codecs
Methods in org.apache.lucene.codecs with parameters of type IndexInput Modifier and Type Method Description static longCodecUtil. checksumEntireFile(IndexInput input)Clones the provided input, reads all bytes from the file, and callsCodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput)abstract voidPostingsReaderBase. init(IndexInput termsIn, SegmentReadState state)Performs any initialization, such as reading and verifying the header from the provided terms dictionaryIndexInput.protected longMultiLevelSkipListReader. 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 longMultiLevelSkipListReader. readLevelLength(IndexInput skipStream)read the length of the current level written viaMultiLevelSkipListWriter.writeLevelLength(long, IndexOutput).protected abstract intMultiLevelSkipListReader. readSkipData(int level, IndexInput skipStream)Subclasses must implement the actual skip data encoding in this method.static longCodecUtil. retrieveChecksum(IndexInput in)Returns (but does not validate) the checksum previously written byCodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput).static longCodecUtil. retrieveChecksum(IndexInput in, long expectedLength)Returns (but does not validate) the checksum previously written byCodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput).static voidCodecUtil. verifyAndCopyIndexHeader(IndexInput in, DataOutput out, byte[] expectedID)Expert: verifies the incomingIndexInputhas 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 IndexInput Constructor Description MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval)Creates aMultiLevelSkipListReader, whereskipIntervalandskipMultiplierare the same.MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval, int skipMultiplier)Creates aMultiLevelSkipListReader. -
Uses of IndexInput in org.apache.lucene.codecs.lucene90
Methods in org.apache.lucene.codecs.lucene90 that return IndexInput Modifier and Type Method Description static IndexInputIndexedDISI. 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 IndexInput Modifier and Type Method Description static IndexInputIndexedDISI. createBlockSlice(IndexInput slice, String sliceDescription, long offset, long length, int jumpTableEntryCount)Helper method for usingIndexedDISI(IndexInput, RandomAccessInput, int, byte, long).static RandomAccessInputIndexedDISI. 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 IndexInput Constructor Description IndexedDISI(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.lucene912
Methods in org.apache.lucene.codecs.lucene912 with parameters of type IndexInput Modifier and Type Method Description voidLucene912PostingsReader. init(IndexInput termsIn, SegmentReadState state)Constructors in org.apache.lucene.codecs.lucene912 with parameters of type IndexInput Constructor Description PostingIndexInput(IndexInput in, ForUtil forUtil, ForDeltaUtil forDeltaUtil) -
Uses of IndexInput in org.apache.lucene.codecs.lucene95
Fields in org.apache.lucene.codecs.lucene95 declared as IndexInput Modifier and Type Field Description protected IndexInputOffHeapByteVectorValues. sliceprotected IndexInputOffHeapFloatVectorValues. sliceMethods in org.apache.lucene.codecs.lucene95 that return IndexInput Modifier and Type Method Description IndexInputOffHeapByteVectorValues. getSlice()IndexInputOffHeapFloatVectorValues. getSlice()Methods in org.apache.lucene.codecs.lucene95 with parameters of type IndexInput Modifier and Type Method Description static OrdToDocDISIReaderConfigurationOrdToDocDISIReaderConfiguration. fromStoredMeta(IndexInput inputMeta, int size)Reads in the necessary fields stored in the outputMeta to configureDirectMonotonicReaderandIndexedDISI.DirectMonotonicReaderOrdToDocDISIReaderConfiguration. getDirectMonotonicReader(IndexInput dataIn)IndexedDISIOrdToDocDISIReaderConfiguration. getIndexedDISI(IndexInput dataIn)static OffHeapByteVectorValuesOffHeapByteVectorValues. load(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData)static OffHeapFloatVectorValuesOffHeapFloatVectorValues. 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 IndexInput Constructor Description DenseOffHeapVectorValues(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 IndexInput Modifier and Type Field Description protected IndexInputOffHeapQuantizedByteVectorValues. sliceMethods in org.apache.lucene.codecs.lucene99 that return IndexInput Modifier and Type Method Description IndexInputOffHeapQuantizedByteVectorValues. getSlice()Methods in org.apache.lucene.codecs.lucene99 with parameters of type IndexInput Modifier and Type Method Description static OffHeapQuantizedByteVectorValuesOffHeapQuantizedByteVectorValues. 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 IndexInput Constructor Description DenseOffHeapVectorValues(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 IndexInput Modifier and Type Field Description IndexInputPostingDecodingUtil. inThe wrapperIndexInput.Methods in org.apache.lucene.internal.vectorization with parameters of type IndexInput Modifier and Type Method Description abstract PostingDecodingUtilVectorizationProvider. newPostingDecodingUtil(IndexInput input)Create a newPostingDecodingUtilfor the givenIndexInput.Constructors in org.apache.lucene.internal.vectorization with parameters of type IndexInput Constructor Description PostingDecodingUtil(IndexInput in)Sole constructor, called by sub-classes. -
Uses of IndexInput in org.apache.lucene.store
Subclasses of IndexInput in org.apache.lucene.store Modifier and Type Class Description classBufferedChecksumIndexInputSimple implementation ofChecksumIndexInputthat wraps another input and delegates calls.classBufferedIndexInputBase implementation class for bufferedIndexInput.classByteBufferIndexInputDeprecated.This class was made public for internal reasons (instanceofchecks).classByteBuffersIndexInputclassChecksumIndexInputExtension of IndexInput, computing checksum as it goes.classFilterIndexInputIndexInput implementation that delegates calls to another directory.Fields in org.apache.lucene.store declared as IndexInput Modifier and Type Field Description protected IndexInputFilterIndexInput. inFields in org.apache.lucene.store with type parameters of type IndexInput Modifier and Type Field Description static BiFunction<String,ByteBuffersDataOutput,IndexInput>ByteBuffersDirectory. OUTPUT_AS_BYTE_ARRAYstatic BiFunction<String,ByteBuffersDataOutput,IndexInput>ByteBuffersDirectory. OUTPUT_AS_MANY_BUFFERSstatic BiFunction<String,ByteBuffersDataOutput,IndexInput>ByteBuffersDirectory. OUTPUT_AS_MANY_BUFFERS_LUCENEDeprecated.UseByteBuffersDirectory.OUTPUT_AS_MANY_BUFFERSinstead.static BiFunction<String,ByteBuffersDataOutput,IndexInput>ByteBuffersDirectory. OUTPUT_AS_ONE_BUFFERMethods in org.apache.lucene.store that return IndexInput Modifier and Type Method Description IndexInputBufferedChecksumIndexInput. clone()IndexInputByteBuffersIndexInput. clone()IndexInputIndexInput. clone()Returns a clone of this stream.IndexInputFilterIndexInput. getDelegate()Gets the delegate that was passed in on creationIndexInputByteBuffersDirectory. openInput(String name, IOContext context)abstract IndexInputDirectory. openInput(String name, IOContext context)Opens a stream for reading an existing file.IndexInputFileSwitchDirectory. openInput(String name, IOContext context)IndexInputFilterDirectory. openInput(String name, IOContext context)IndexInputMMapDirectory. openInput(String name, IOContext context)Creates an IndexInput for the file with the given name.IndexInputNIOFSDirectory. openInput(String name, IOContext context)IndexInputNRTCachingDirectory. openInput(String name, IOContext context)IndexInputBufferedChecksumIndexInput. slice(String sliceDescription, long offset, long length)IndexInputBufferedIndexInput. slice(String sliceDescription, long offset, long length)IndexInputFilterIndexInput. slice(String sliceDescription, long offset, long length)abstract IndexInputIndexInput. slice(String sliceDescription, long offset, long length)Creates a slice of this index input, with the given description, offset, and length.static IndexInputFilterIndexInput. unwrap(IndexInput in)Unwraps all FilterIndexInputs until the first non-FilterIndexInput IndexInput instance and returns itstatic IndexInputFilterIndexInput. 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 IndexInput Modifier and Type Method Description static IndexInputFilterIndexInput. unwrap(IndexInput in)Unwraps all FilterIndexInputs until the first non-FilterIndexInput IndexInput instance and returns itstatic IndexInputFilterIndexInput. unwrapOnlyTest(IndexInput in)Unwraps all test FilterIndexInputs until the first non-test FilterIndexInput IndexInput instance and returns itstatic BufferedIndexInputBufferedIndexInput. 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 IndexInput Constructor Description BufferedChecksumIndexInput(IndexInput main)Creates 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 IndexInput Constructor Description ByteBuffersDirectory(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 IndexInput Modifier and Type Method Description voidPagedBytes. 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 IndexInput Constructor Description BKDReader(IndexInput metaIn, IndexInput indexIn, IndexInput dataIn)Caller must pre-seek the providedIndexInputto 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 IndexInput Constructor Description OffHeapFSTStore(IndexInput in, long offset, FST.FSTMetadata<?> metadata) -
Uses of IndexInput in org.apache.lucene.util.hnsw
Methods in org.apache.lucene.util.hnsw that return IndexInput Modifier and Type Method Description default IndexInputRandomAccessVectorValues. getSlice()Returns a slice of the underlyingIndexInputthat contains the vector values if available -
Uses of IndexInput in org.apache.lucene.util.packed
Methods in org.apache.lucene.util.packed with parameters of type IndexInput Modifier and Type Method Description static DirectMonotonicReader.MetaDirectMonotonicReader. loadMeta(IndexInput metaIn, long numValues, int blockShift)Load metadata from the givenIndexInput.static MonotonicBlockPackedReaderMonotonicBlockPackedReader. of(IndexInput in, int packedIntsVersion, int blockSize, long valueCount)Sole constructor.
-