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.lucene84 Components from the Lucene 8.4 index format.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.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 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
.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 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 IndexInput Constructor Description MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval)
Creates aMultiLevelSkipListReader
, whereskipInterval
andskipMultiplier
are the same.MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval, int skipMultiplier)
Creates aMultiLevelSkipListReader
. -
Uses of IndexInput in org.apache.lucene.codecs.lucene84
Methods in org.apache.lucene.codecs.lucene84 with parameters of type IndexInput Modifier and Type Method Description void
Lucene84PostingsReader. init(IndexInput termsIn, SegmentReadState state)
-
Uses of IndexInput in org.apache.lucene.store
Subclasses of IndexInput in org.apache.lucene.store Modifier and Type Class Description class
BufferedChecksumIndexInput
Simple implementation ofChecksumIndexInput
that wraps another input and delegates calls.class
BufferedIndexInput
Base implementation class for bufferedIndexInput
.class
ByteBufferIndexInput
Base IndexInput implementation that uses an array of ByteBuffers to represent a file.class
ByteBuffersIndexInput
class
ChecksumIndexInput
Extension of IndexInput, computing checksum as it goes.class
RAMInputStream
Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
.Fields 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_ARRAY
static BiFunction<String,ByteBuffersDataOutput,IndexInput>
ByteBuffersDirectory. OUTPUT_AS_MANY_BUFFERS
static BiFunction<String,ByteBuffersDataOutput,IndexInput>
ByteBuffersDirectory. OUTPUT_AS_MANY_BUFFERS_LUCENE
static BiFunction<String,ByteBuffersDataOutput,IndexInput>
ByteBuffersDirectory. OUTPUT_AS_ONE_BUFFER
Methods in org.apache.lucene.store that return IndexInput Modifier and Type Method Description IndexInput
BufferedChecksumIndexInput. clone()
IndexInput
ByteBuffersIndexInput. clone()
IndexInput
IndexInput. clone()
Returns a clone of this stream.IndexInput
ByteBuffersDirectory. openInput(String name, IOContext context)
abstract IndexInput
Directory. openInput(String name, IOContext context)
Opens a stream for reading an existing file.IndexInput
FileSwitchDirectory. openInput(String name, IOContext context)
IndexInput
FilterDirectory. openInput(String name, IOContext context)
IndexInput
MMapDirectory. openInput(String name, IOContext context)
Creates an IndexInput for the file with the given name.IndexInput
NIOFSDirectory. openInput(String name, IOContext context)
IndexInput
NRTCachingDirectory. openInput(String name, IOContext context)
IndexInput
RAMDirectory. openInput(String name, IOContext context)
Deprecated.Returns a stream reading an existing file.IndexInput
SimpleFSDirectory. openInput(String name, IOContext context)
Deprecated.Creates an IndexInput for the file with the given name.IndexInput
BufferedChecksumIndexInput. slice(String sliceDescription, long offset, long length)
IndexInput
BufferedIndexInput. slice(String sliceDescription, long offset, long length)
abstract IndexInput
IndexInput. slice(String sliceDescription, long offset, long length)
Creates a slice of this index input, with the given description, offset, and length.IndexInput
RAMInputStream. slice(String sliceDescription, long offset, long sliceLength)
Deprecated.Methods in org.apache.lucene.store with parameters of type IndexInput Modifier and Type Method Description static 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 IndexInput Constructor Description BufferedChecksumIndexInput(IndexInput main)
Creates a new BufferedChecksumIndexInputConstructor 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 void
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 IndexInput Constructor Description BKDReader(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.IntersectState(IndexInput in, int numDims, int packedBytesLength, int packedIndexBytesLength, int maxPointsInLeafNode, PointValues.IntersectVisitor visitor, BKDReader.IndexTree indexVisitor)
-
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 PackedInts.Reader
PackedInts. getDirectReader(IndexInput in)
Construct a directPackedInts.Reader
from anIndexInput
.static PackedInts.Reader
PackedInts. getDirectReaderNoHeader(IndexInput in, PackedInts.Format format, int version, int valueCount, int bitsPerValue)
Expert: Construct a directPackedInts.Reader
from a stream without reading metadata at the beginning of the stream.static 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, boolean direct)
Sole constructor.Constructors in org.apache.lucene.util.packed with parameters of type IndexInput Constructor Description BlockPackedReader(IndexInput in, int packedIntsVersion, int blockSize, long valueCount, boolean direct)
Sole constructor.
-