Uses of Class
org.apache.lucene.store.Directory
Packages that use Directory
Package
Description
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.
Code to maintain and access indices.
Code to search indices.
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.
-
Uses of Directory in org.apache.lucene.codecs
Subclasses of Directory in org.apache.lucene.codecsModifier and TypeClassDescriptionclassA read-onlyDirectorythat consists of a view over a compound file.Methods in org.apache.lucene.codecs with parameters of type DirectoryModifier and TypeMethodDescriptionabstract 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) 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 Directory in org.apache.lucene.codecs.lucene90
Methods in org.apache.lucene.codecs.lucene90 with parameters of type DirectoryModifier 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) 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) -
Uses of Directory in org.apache.lucene.codecs.lucene90.compressing
Methods in org.apache.lucene.codecs.lucene90.compressing with parameters of type DirectoryModifier 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 DirectoryModifierConstructorDescriptionLucene90CompressingStoredFieldsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor.Lucene90CompressingTermVectorsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor. -
Uses of Directory in org.apache.lucene.codecs.lucene94
Methods in org.apache.lucene.codecs.lucene94 with parameters of type DirectoryModifier 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 Directory in org.apache.lucene.codecs.lucene99
Methods in org.apache.lucene.codecs.lucene99 with parameters of type DirectoryModifier and TypeMethodDescriptionvoidLucene99SegmentInfoFormat.write(Directory dir, SegmentInfo si, IOContext ioContext) -
Uses of Directory in org.apache.lucene.index
Fields in org.apache.lucene.index declared as DirectoryModifier and TypeFieldDescriptionCheckIndex.Status.dirDirectory index is in.final DirectorySegmentInfo.dirWhere this segment resides.protected final DirectoryDirectoryReader.directoryThe index directory.final DirectorySegmentReadState.directoryDirectorywhere this segment is read from.final DirectorySegmentWriteState.directoryDirectorywhere this segment will be written to.Methods in org.apache.lucene.index that return DirectoryModifier and TypeMethodDescriptionfinal DirectoryDirectoryReader.directory()Returns the directory this index resides in.SegmentReader.directory()Returns the directory this index resides in.abstract DirectoryIndexCommit.getDirectory()Returns theDirectoryfor the index.IndexWriter.getDirectory()Returns the Directory used by this index.ConcurrentMergeScheduler.wrapForMerge(MergePolicy.OneMerge merge, Directory in) MergeScheduler.wrapForMerge(MergePolicy.OneMerge merge, Directory in) Wraps the incomingDirectoryso that we can merge-throttle it usingRateLimitedIndexOutput.NoMergeScheduler.wrapForMerge(MergePolicy.OneMerge merge, Directory in) Methods in org.apache.lucene.index with parameters of type DirectoryModifier and TypeMethodDescriptionlongIndexWriter.addIndexes(Directory... dirs) Adds all segments from an array of indexes into this index.final voidWrites and syncs to the Directory dir, taking care to remove the segments file on exceptionstatic longSegmentInfos.getLastCommitGeneration(Directory directory) Get the generation of the most recent commit to the index in this directory (N in the segments_N file).static StringSegmentInfos.getLastCommitSegmentsFileName(Directory directory) Get the filename of the segments_N file for the most recent commit to the index in this Directory.static booleanDirectoryReader.indexExists(Directory directory) Returnstrueif an index likely exists at the specified directory.static List<IndexCommit> DirectoryReader.listCommits(Directory dir) Returns all commit points that exist in the Directory.static DirectoryReaderReturns a IndexReader reading the index in the given Directorystatic DirectoryReaderDirectoryReader.open(Directory directory, Comparator<LeafReader> leafSorter) Returns a IndexReader for the index in the given Directorystatic DirectoryReaderStandardDirectoryReader.open(Directory directory, SegmentInfos infos, List<? extends LeafReader> oldReaders, Comparator<LeafReader> leafSorter) This constructor is only used forStandardDirectoryReader.doOpenIfChanged(SegmentInfos), as well as NRT replication.static final SegmentInfosSegmentInfos.readCommit(Directory directory, String segmentFileName) Read a particular segmentFileName.static final SegmentInfosSegmentInfos.readCommit(Directory directory, String segmentFileName, int minSupportedMajorVersion) Read a particular segmentFileName, as long as the commit'sSegmentInfos.getIndexCreatedVersionMajor()is strictly greater than the provided minimum supported major version.static final SegmentInfosSegmentInfos.readCommit(Directory directory, ChecksumIndexInput input, long generation) Read the commit from the providedChecksumIndexInput.static final SegmentInfosSegmentInfos.readCommit(Directory directory, ChecksumIndexInput input, long generation, int minSupportedMajorVersion) Read the commit from the providedChecksumIndexInput.static final SegmentInfosSegmentInfos.readLatestCommit(Directory directory) Find the latest commit (segments_N file) and load allSegmentCommitInfos.static final SegmentInfosSegmentInfos.readLatestCommit(Directory directory, int minSupportedMajorVersion) Find the latest commit (segments_N file) and load allSegmentCommitInfos, as long as the commit'sSegmentInfos.getIndexCreatedVersionMajor()is strictly greater than the provided minimum supported major version.MergePolicy.OneMerge.reorder(CodecReader reader, Directory dir, Executor executor) Extend this method if you wish to renumber doc IDs.Returns a description of the merges in this specification.ConcurrentMergeScheduler.wrapForMerge(MergePolicy.OneMerge merge, Directory in) MergeScheduler.wrapForMerge(MergePolicy.OneMerge merge, Directory in) Wraps the incomingDirectoryso that we can merge-throttle it usingRateLimitedIndexOutput.NoMergeScheduler.wrapForMerge(MergePolicy.OneMerge merge, Directory in) Constructors in org.apache.lucene.index with parameters of type DirectoryModifierConstructorDescriptionCheckIndex(Directory dir) Create a new CheckIndex on the directory.CheckIndex(Directory dir, Lock writeLock) Expert: create a directory with the specified lock.protectedDirectoryReader(Directory directory, LeafReader[] segmentReaders, Comparator<LeafReader> leafSorter) Expert: Constructs aDirectoryReaderon the given subReaders.protectedFindSegmentsFile(Directory directory) Sole constructor.IndexUpgrader(Directory dir) Creates index upgrader on the given directory, using anIndexWriterusing the givenmatchVersion.IndexUpgrader(Directory dir, IndexWriterConfig iwc, boolean deletePriorCommits) Creates index upgrader on the given directory, using anIndexWriterusing the given config.IndexUpgrader(Directory dir, InfoStream infoStream, boolean deletePriorCommits) Creates index upgrader on the given directory, using anIndexWriterusing the givenmatchVersion.IndexWriter(Directory d, IndexWriterConfig conf) Constructs a new IndexWriter per the settings given inconf.PersistentSnapshotDeletionPolicy(IndexDeletionPolicy primary, Directory dir) PersistentSnapshotDeletionPolicywraps anotherIndexDeletionPolicyto enable flexible snapshotting, passingIndexWriterConfig.OpenMode.CREATE_OR_APPENDby default.PersistentSnapshotDeletionPolicy(IndexDeletionPolicy primary, Directory dir, IndexWriterConfig.OpenMode mode) PersistentSnapshotDeletionPolicywraps anotherIndexDeletionPolicyto enable flexible snapshotting.ReaderManager(Directory dir) Creates and returns a new ReaderManager from the givenDirectory.SegmentInfo(Directory dir, Version version, Version minVersion, String name, int maxDoc, boolean isCompoundFile, boolean hasBlocks, Codec codec, Map<String, String> diagnostics, byte[] id, Map<String, String> attributes, Sort indexSort) Construct a new complete SegmentInfo instance from input.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, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context) Sole constructor.SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context, String segmentSuffix) Constructor which takes segment suffix. -
Uses of Directory in org.apache.lucene.search
Constructors in org.apache.lucene.search with parameters of type DirectoryModifierConstructorDescriptionSearcherManager(Directory dir, SearcherFactory searcherFactory) Creates and returns a new SearcherManager from the givenDirectory. -
Uses of Directory in org.apache.lucene.store
Subclasses of Directory in org.apache.lucene.storeModifier and TypeClassDescriptionclassBase implementation for a concreteDirectorythat uses aLockFactoryfor locking.final classAByteBuffer-basedDirectoryimplementation that can be used to store index files on the heap.classExpert: A Directory instance that switches files between two other Directory instances.classDirectory implementation that delegates calls to another directory.classBase class for Directory implementations that store index files in the file system.final classThis class makes a best-effort check that a providedLockis valid before any destructive filesystem operation.classFile-basedDirectoryimplementation that uses mmap for reading, andFSDirectory.FSIndexOutputfor writing.classAnFSDirectoryimplementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing.classWraps a RAM-resident directory around any provided delegate directory, to be used during NRT search.final classDirectory that wraps another, and that sleeps and retries if obtaining the lock fails.final classA delegating Directory that records which files were written to and deleted.Fields in org.apache.lucene.store declared as DirectoryMethods in org.apache.lucene.store that return DirectoryModifier and TypeMethodDescriptionfinal DirectoryFilterDirectory.getDelegate()Return the wrappedDirectory.FileSwitchDirectory.getPrimaryDir()Return the primary directoryFileSwitchDirectory.getSecondaryDir()Return the secondary directorystatic DirectoryGet the wrapped instance bydiras long as this reader is an instance ofFilterDirectory.Methods in org.apache.lucene.store with parameters of type DirectoryModifier and TypeMethodDescriptionvoidCopies an existingsrcfile from directoryfromto a non-existent filedestin this directory.voidvoidfinal LockFSLockFactory.obtainLock(Directory dir, String lockName) abstract LockLockFactory.obtainLock(Directory dir, String lockName) Return a new obtained Lock instance identified by lockName.NoLockFactory.obtainLock(Directory dir, String lockName) SingleInstanceLockFactory.obtainLock(Directory dir, String lockName) VerifyingLockFactory.obtainLock(Directory dir, String lockName) static DirectoryGet the wrapped instance bydiras long as this reader is an instance ofFilterDirectory.Constructors in org.apache.lucene.store with parameters of type DirectoryModifierConstructorDescriptionFileSwitchDirectory(Set<String> primaryExtensions, Directory primaryDir, Directory secondaryDir, boolean doClose) protectedSole constructor, typically called from sub-classes.LockValidatingDirectoryWrapper(Directory in, Lock writeLock) NRTCachingDirectory(Directory delegate, double maxMergeSizeMB, double maxCachedMB) We will cache a newly created output if 1) it's a flush or a merge and the estimated size of the merged segment is<= maxMergeSizeMB, and 2) the total cached bytes is<= maxCachedMBSleepingLockWrapper(Directory delegate, long lockWaitTimeout) Create a new SleepingLockFactorySleepingLockWrapper(Directory delegate, long lockWaitTimeout, long pollInterval) Create a new SleepingLockFactory -
Uses of Directory in org.apache.lucene.util
Methods in org.apache.lucene.util that return DirectoryModifier and TypeMethodDescriptionOfflineSorter.getDirectory()Returns theDirectorywe use to create temp files.Methods in org.apache.lucene.util that return types with arguments of type DirectoryModifier and TypeMethodDescriptionCommandLineUtil.loadDirectoryClass(String clazzName) Loads a specific Directory implementationMethods in org.apache.lucene.util with parameters of type DirectoryModifier and TypeMethodDescriptionstatic voidIOUtils.deleteFiles(Directory dir, Collection<String> names) Deletes all given file names.static voidIOUtils.deleteFilesIgnoringExceptions(Directory dir, String... files) static voidIOUtils.deleteFilesIgnoringExceptions(Directory dir, Collection<String> files) Deletes all given files, suppressing all thrown IOExceptions.Constructors in org.apache.lucene.util with parameters of type DirectoryModifierConstructorDescriptionFileDeleter(Directory directory, BiConsumer<FileDeleter.MsgType, String> messenger) Create a new FileDeleter with a messenger consumes various verbose messagesOfflineSorter(Directory dir, String tempFileNamePrefix) Defaults constructor.OfflineSorter(Directory dir, String tempFileNamePrefix, Comparator<BytesRef> comparator) Defaults constructor with a custom comparator.OfflineSorter(Directory dir, String tempFileNamePrefix, Comparator<BytesRef> comparator, OfflineSorter.BufferSize ramBufferSize, int maxTempfiles, int valueLength, ExecutorService exec, int maxPartitionsInRAM) All-details constructor. -
Uses of Directory in org.apache.lucene.util.bkd
Constructors in org.apache.lucene.util.bkd with parameters of type DirectoryModifierConstructorDescriptionBKDRadixSelector(BKDConfig config, int maxPointsSortInHeap, Directory tempDir, String tempFileNamePrefix) Sole constructor.BKDWriter(int maxDoc, Directory tempDir, String tempFileNamePrefix, BKDConfig config, double maxMBSortInHeap, long totalPointCount) BKDWriter(int maxDoc, Directory tempDir, String tempFileNamePrefix, BKDConfig config, double maxMBSortInHeap, long totalPointCount, int version) This ctor should be only used for testing with older versions.OfflinePointReader(BKDConfig config, Directory tempDir, String tempFileName, long start, long length, byte[] reusableBuffer) OfflinePointWriter(BKDConfig config, Directory tempDir, String tempFileNamePrefix, String desc, long expectedCount) Create a new writer with an unknown number of incoming points