Uses of Class
org.apache.lucene.store.IOContext
Packages that use IOContext
Package
Description
Lucene 5.0 file format.
Lucene 5.0 compressing format.
Lucene 6.0 file format.
Components from the Lucene 7.0 index format.
Lucene 8.6 file format.
Lucene 8.7 file format.
Lucene 9.0 file format.
store helper
Codecs API: API for customization of the encoding and structure of the index.
Lucene 9.0 file format.
Lucene 9.0 compressing format.
Lucene 9.4 file format.
Lucene 9.9 file format.
Simpletext Codec: writes human readable postings.
Code to maintain and access indices.
Misc Directory implementations.
Binary i/o API, used for all index data.
-
Uses of IOContext in org.apache.lucene.backward_codecs.lucene50
Methods in org.apache.lucene.backward_codecs.lucene50 with parameters of type IOContextModifier and TypeMethodDescriptionfinal StoredFieldsReaderLucene50StoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene50StoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context) Lucene50CompoundFormat.getCompoundReader(Directory dir, SegmentInfo si, IOContext context) Lucene50LiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context) voidLucene50CompoundFormat.write(Directory dir, SegmentInfo si, IOContext context) voidLucene50LiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Note: although this format is only used on older versions, we need to keep the write logic in addition to the read logic.Constructors in org.apache.lucene.backward_codecs.lucene50 with parameters of type IOContextModifierConstructorDescriptionLucene50CompoundReader(Directory directory, SegmentInfo si, IOContext context) Create a new CompoundFileDirectory. -
Uses of IOContext in org.apache.lucene.backward_codecs.lucene50.compressing
Methods in org.apache.lucene.backward_codecs.lucene50.compressing with parameters of type IOContextModifier and TypeMethodDescriptionLucene50CompressingStoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene50CompressingStoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context) final TermVectorsReaderLucene50CompressingTermVectorsFormat.vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) Lucene50CompressingTermVectorsFormat.vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context) Constructors in org.apache.lucene.backward_codecs.lucene50.compressing with parameters of type IOContextModifierConstructorDescriptionLucene50CompressingStoredFieldsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor.Lucene50CompressingTermVectorsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor. -
Uses of IOContext in org.apache.lucene.backward_codecs.lucene60
Methods in org.apache.lucene.backward_codecs.lucene60 with parameters of type IOContextModifier and TypeMethodDescriptionLucene60FieldInfosFormat.read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context) voidLucene60FieldInfosFormat.write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context) Note: although this format is only used on older versions, we need to keep the write logic in addition to the read logic. -
Uses of IOContext in org.apache.lucene.backward_codecs.lucene70
Methods in org.apache.lucene.backward_codecs.lucene70 with parameters of type IOContextModifier and TypeMethodDescriptionvoidLucene70SegmentInfoFormat.write(Directory dir, SegmentInfo si, IOContext ioContext) -
Uses of IOContext in org.apache.lucene.backward_codecs.lucene86
Methods in org.apache.lucene.backward_codecs.lucene86 with parameters of type IOContextModifier and TypeMethodDescriptionvoidLucene86SegmentInfoFormat.write(Directory dir, SegmentInfo si, IOContext ioContext) -
Uses of IOContext in org.apache.lucene.backward_codecs.lucene87
Methods in org.apache.lucene.backward_codecs.lucene87 with parameters of type IOContextModifier and TypeMethodDescriptionLucene87StoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene87StoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context) -
Uses of IOContext in org.apache.lucene.backward_codecs.lucene90
Methods in org.apache.lucene.backward_codecs.lucene90 with parameters of type IOContextModifier and TypeMethodDescriptionLucene90FieldInfosFormat.read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context) voidLucene90FieldInfosFormat.write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context) voidLucene90SegmentInfoFormat.write(Directory dir, SegmentInfo si, IOContext ioContext) -
Uses of IOContext in org.apache.lucene.backward_codecs.store
Methods in org.apache.lucene.backward_codecs.store with parameters of type IOContextModifier and TypeMethodDescriptionstatic IndexOutputEndiannessReverserUtil.createOutput(Directory directory, String name, IOContext context) Open an index outputstatic IndexOutputEndiannessReverserUtil.createTempOutput(Directory directory, String prefix, String suffix, IOContext context) Open a temp index outputstatic ChecksumIndexInputEndiannessReverserUtil.openChecksumInput(Directory directory, String name, IOContext context) Open a checksum index inputstatic IndexInputOpen an index input -
Uses of IOContext in org.apache.lucene.codecs
Methods in org.apache.lucene.codecs with parameters of type IOContextModifier and TypeMethodDescriptionfinal IndexOutputCompoundDirectory.createOutput(String name, IOContext context) final IndexOutputCompoundDirectory.createTempOutput(String prefix, String suffix, IOContext context) abstract StoredFieldsReaderStoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Returns aStoredFieldsReaderto load stored fields.abstract StoredFieldsWriterStoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context) Returns aStoredFieldsWriterto write stored fields.abstract CompoundDirectoryCompoundFormat.getCompoundReader(Directory dir, SegmentInfo si, IOContext context) Returns a Directory view (read-only) for the compound files in this segmentabstract FieldInfosFieldInfosFormat.read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext iocontext) abstract SegmentInfoSegmentInfoFormat.read(Directory directory, String segmentName, byte[] segmentID, IOContext context) ReadSegmentInfodata from a directory.abstract BitsLiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context) Read live docs bits.abstract TermVectorsReaderTermVectorsFormat.vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) Returns aTermVectorsReaderto read term vectors.abstract TermVectorsWriterTermVectorsFormat.vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context) Returns aTermVectorsWriterto write term vectors.abstract voidCompoundFormat.write(Directory dir, SegmentInfo si, IOContext context) Packs the provided segment's files into a compound format.abstract voidFieldInfosFormat.write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context) Writes the providedFieldInfosto the directory.abstract voidSegmentInfoFormat.write(Directory dir, SegmentInfo info, IOContext ioContext) WriteSegmentInfodata.abstract voidLiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Persist live docs bits. -
Uses of IOContext in org.apache.lucene.codecs.lucene90
Methods in org.apache.lucene.codecs.lucene90 with parameters of type IOContextModifier and TypeMethodDescriptionLucene90StoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene90StoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context) Lucene90CompoundFormat.getCompoundReader(Directory dir, SegmentInfo si, IOContext context) Lucene90LiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context) voidLucene90CompoundFormat.write(Directory dir, SegmentInfo si, IOContext context) voidLucene90LiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Constructors in org.apache.lucene.codecs.lucene90 with parameters of type IOContextModifierConstructorDescriptionLucene90CompoundReader(Directory directory, SegmentInfo si, IOContext context) Create a new CompoundFileDirectory. -
Uses of IOContext in org.apache.lucene.codecs.lucene90.compressing
Fields in org.apache.lucene.codecs.lucene90.compressing declared as IOContextMethods in org.apache.lucene.codecs.lucene90.compressing with parameters of type IOContextModifier and TypeMethodDescriptionLucene90CompressingStoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene90CompressingStoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context) final TermVectorsReaderLucene90CompressingTermVectorsFormat.vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) final TermVectorsWriterLucene90CompressingTermVectorsFormat.vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context) Constructors in org.apache.lucene.codecs.lucene90.compressing with parameters of type IOContextModifierConstructorDescription(package private)FieldsIndexWriter(Directory dir, String name, String suffix, String extension, String codecName, byte[] id, int blockShift, IOContext ioContext) Lucene90CompressingStoredFieldsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor.(package private)Lucene90CompressingStoredFieldsWriter(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize, int maxDocsPerChunk, int blockShift) Sole constructor.Lucene90CompressingTermVectorsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor.(package private)Lucene90CompressingTermVectorsWriter(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize, int maxDocsPerChunk, int blockShift) Sole constructor. -
Uses of IOContext in org.apache.lucene.codecs.lucene94
Methods in org.apache.lucene.codecs.lucene94 with parameters of type IOContextModifier and TypeMethodDescriptionLucene94FieldInfosFormat.read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context) voidLucene94FieldInfosFormat.write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context) -
Uses of IOContext in org.apache.lucene.codecs.lucene99
Methods in org.apache.lucene.codecs.lucene99 with parameters of type IOContextModifier and TypeMethodDescriptionprivate static IndexInputLucene99FlatVectorsReader.openDataInput(SegmentReadState state, int versionMeta, String fileExtension, String codecName, IOContext context) private static IndexInputLucene99HnswVectorsReader.openDataInput(SegmentReadState state, int versionMeta, String fileExtension, String codecName, IOContext context) private static IndexInputLucene99ScalarQuantizedVectorsReader.openDataInput(SegmentReadState state, int versionMeta, String fileExtension, String codecName, IOContext context) voidLucene99SegmentInfoFormat.write(Directory dir, SegmentInfo si, IOContext ioContext) -
Uses of IOContext in org.apache.lucene.codecs.simpletext
Methods in org.apache.lucene.codecs.simpletext with parameters of type IOContextModifier and TypeMethodDescriptionSimpleTextStoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) SimpleTextStoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context) SimpleTextCompoundFormat.getCompoundReader(Directory dir, SegmentInfo si, IOContext context) SimpleTextFieldInfosFormat.read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext iocontext) SimpleTextSegmentInfoFormat.read(Directory directory, String segmentName, byte[] segmentID, IOContext context) SimpleTextLiveDocsFormat.readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context) SimpleTextTermVectorsFormat.vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) SimpleTextTermVectorsFormat.vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context) voidSimpleTextCompoundFormat.write(Directory dir, SegmentInfo si, IOContext context) voidSimpleTextFieldInfosFormat.write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context) voidSimpleTextSegmentInfoFormat.write(Directory dir, SegmentInfo si, IOContext ioContext) voidSimpleTextLiveDocsFormat.writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Constructors in org.apache.lucene.codecs.simpletext with parameters of type IOContextModifierConstructorDescriptionSimpleTextStoredFieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) SimpleTextStoredFieldsWriter(Directory directory, String segment, IOContext context) SimpleTextTermVectorsReader(Directory directory, SegmentInfo si, IOContext context) SimpleTextTermVectorsWriter(Directory directory, String segment, IOContext context) -
Uses of IOContext in org.apache.lucene.index
Fields in org.apache.lucene.index declared as IOContextModifier and TypeFieldDescriptionprivate final IOContextSegmentMerger.contextfinal IOContextSegmentReadState.contextIOContextto pass toDirectory.openInput(String,IOContext).final IOContextSegmentWriteState.contextIOContextfor all writes; you should pass this toDirectory.createOutput(String,IOContext).Methods in org.apache.lucene.index with parameters of type IOContextModifier and TypeMethodDescriptionprivate SegmentCommitInfoIndexWriter.copySegmentAsIs(SegmentCommitInfo info, String segName, IOContext context) Copies the segment files as-is into the IndexWriter's directory.(package private) static voidIndexWriter.createCompoundFile(InfoStream infoStream, TrackingDirectoryWrapper directory, SegmentInfo info, IOContext context, IOConsumer<Collection<String>> deleteFiles) NOTE: this method creates a compound file for all files returned by info.files().TrackingTmpOutputDirectoryWrapper.createOutput(String name, IOContext context) Returns aSegmentReader.(package private) MergePolicy.MergeReaderReadersAndUpdates.getReaderForMerge(IOContext context, IOConsumer<MergePolicy.MergeReader> readerConsumer) Returns a reader for merge, with the latest doc values updates and deletions.ReadersAndUpdates.getReadOnlyClone(IOContext context) Returns a ref to a clone.Constructors in org.apache.lucene.index with parameters of type IOContextModifierConstructorDescription(package private)SegmentCoreReaders(Directory dir, SegmentCommitInfo si, IOContext context) (package private)SegmentMerger(List<CodecReader> readers, SegmentInfo segmentInfo, InfoStream infoStream, Directory dir, FieldInfos.FieldNumbers fieldNumbers, IOContext context, Executor intraMergeTaskExecutor) (package private)SegmentReader(SegmentCommitInfo si, int createdVersionMajor, IOContext context) Constructs a new SegmentReader with a new core.SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context) Create aSegmentReadState.SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, String segmentSuffix) Create aSegmentReadState.SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, BufferedUpdates segUpdates, IOContext context) Sole constructor.SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, BufferedUpdates segUpdates, IOContext context, String segmentSuffix) Constructor which takes segment suffix. -
Uses of IOContext in org.apache.lucene.misc.store
Methods in org.apache.lucene.misc.store with parameters of type IOContextModifier and TypeMethodDescriptionvoidHardlinkCopyDirectoryWrapper.copyFrom(Directory from, String srcFile, String destFile, IOContext context) ByteWritesTrackingDirectoryWrapper.createOutput(String name, IOContext ioContext) DirectIODirectory.createOutput(String name, IOContext context) ByteWritesTrackingDirectoryWrapper.createTempOutput(String prefix, String suffix, IOContext ioContext) Creates an IndexInput for the file with the given name.protected booleanDirectIODirectory.useDirectIO(String name, IOContext context, OptionalLong fileLength) Determines if direct IO should be used for a file.Constructors in org.apache.lucene.misc.store with parameters of type IOContextModifierConstructorDescriptionRAFIndexInput(String resourceDesc, RandomAccessFile file, IOContext context) -
Uses of IOContext in org.apache.lucene.store
Fields in org.apache.lucene.store declared as IOContextModifier and TypeFieldDescriptionstatic final IOContextIOContext.DEFAULTstatic final IOContextIOContext.LOADstatic final IOContextIOContext.RANDOMstatic final IOContextIOContext.READstatic final IOContextIOContext.READONCEFields in org.apache.lucene.store with type parameters of type IOContextModifier and TypeFieldDescriptionstatic final BiPredicate<String, IOContext> MMapDirectory.ALL_FILESArgument forMMapDirectory.setPreload(BiPredicate)that configures all files to be preloaded upon opening them.static final BiPredicate<String, IOContext> MMapDirectory.BASED_ON_LOAD_IO_CONTEXTArgument forMMapDirectory.setPreload(BiPredicate)that configures files to be preloaded upon opening them if they use theLOADI/O context.static final BiPredicate<String, IOContext> MMapDirectory.NO_FILESArgument forMMapDirectory.setPreload(BiPredicate)that configures no files to be preloaded upon opening them.private BiPredicate<String, IOContext> MMapDirectory.preloadMethods in org.apache.lucene.store that return IOContextModifier and TypeMethodDescriptionIOContext.withRandomAccess()Return an updatedIOContextthat hasrandomAccessset to true ifcontextisIOContext.Context.READorIOContext.Context.DEFAULT.Methods in org.apache.lucene.store with parameters of type IOContextModifier and TypeMethodDescriptionstatic intBufferedIndexInput.bufferSize(IOContext context) Returns default buffer sizes for the givenIOContextvoidCopies an existingsrcfile from directoryfromto a non-existent filedestin this directory.voidvoidByteBuffersDirectory.createOutput(String name, IOContext context) abstract IndexOutputDirectory.createOutput(String name, IOContext context) Creates a new, empty file in the directory and returns anIndexOutputinstance for appending data to this file.FileSwitchDirectory.createOutput(String name, IOContext context) FilterDirectory.createOutput(String name, IOContext context) FSDirectory.createOutput(String name, IOContext context) LockValidatingDirectoryWrapper.createOutput(String name, IOContext context) NRTCachingDirectory.createOutput(String name, IOContext context) TrackingDirectoryWrapper.createOutput(String name, IOContext context) ByteBuffersDirectory.createTempOutput(String prefix, String suffix, IOContext context) abstract IndexOutputDirectory.createTempOutput(String prefix, String suffix, IOContext context) Creates a new, empty, temporary file in the directory and returns anIndexOutputinstance for appending data to this file.FileSwitchDirectory.createTempOutput(String prefix, String suffix, IOContext context) FilterDirectory.createTempOutput(String prefix, String suffix, IOContext context) FSDirectory.createTempOutput(String prefix, String suffix, IOContext context) NRTCachingDirectory.createTempOutput(String prefix, String suffix, IOContext context) TrackingDirectoryWrapper.createTempOutput(String prefix, String suffix, IOContext context) protected booleanNRTCachingDirectory.doCacheWrite(String name, IOContext context) Subclass can override this to customize logic; return true if this file should be written to the RAM-based cache first.Directory.openChecksumInput(String name, IOContext context) Opens a checksum-computing stream for reading an existing file.abstract IndexInputOpens a stream for reading an existing file.MappedByteBufferIndexInputProvider.openInput(Path path, IOContext context, int chunkSizePower, boolean preload) MMapDirectory.MMapIndexInputProvider.openInput(Path path, IOContext context, int chunkSizePower, boolean preload) Creates an IndexInput for the file with the given name.Method parameters in org.apache.lucene.store with type arguments of type IOContextModifier and TypeMethodDescriptionvoidMMapDirectory.setPreload(BiPredicate<String, IOContext> preload) Configure which files to preload in physical memory upon opening.Constructors in org.apache.lucene.store with parameters of type IOContextModifierConstructorDescriptionBufferedIndexInput(String resourceDesc, IOContext context) This constructor is used to initialize aIOContextinstance with a new value for the readOnce variable.NIOFSIndexInput(String resourceDesc, FileChannel fc, IOContext context)