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.
StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
Codec to support Lucene 3.x indexes (readonly)
Lucene 4.0 file format.
Lucene 4.1 file format.
Lucene 4.6 file format.
Code to maintain and access indices.
Code to search indices.
Binary i/o API, used for all index data.
Some utility classes.
-
Uses of Directory in org.apache.lucene.codecs
Methods in org.apache.lucene.codecs with parameters of type DirectoryModifier and TypeMethodDescriptionabstract StoredFieldsReader
StoredFieldsFormat.fieldsReader
(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Returns aStoredFieldsReader
to load stored fields.abstract StoredFieldsWriter
StoredFieldsFormat.fieldsWriter
(Directory directory, SegmentInfo si, IOContext context) Returns aStoredFieldsWriter
to write stored fields.abstract FieldInfos
FieldInfosReader.read
(Directory directory, String segmentName, String segmentSuffix, IOContext iocontext) Read theFieldInfos
previously written withFieldInfosWriter
.abstract SegmentInfo
ReadSegmentInfo
data from a directory.abstract Bits
LiveDocsFormat.readLiveDocs
(Directory dir, SegmentCommitInfo info, IOContext context) Read live docs bits.abstract TermVectorsReader
TermVectorsFormat.vectorsReader
(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) Returns aTermVectorsReader
to read term vectors.abstract TermVectorsWriter
TermVectorsFormat.vectorsWriter
(Directory directory, SegmentInfo segmentInfo, IOContext context) Returns aTermVectorsWriter
to write term vectors.abstract void
FieldInfosWriter.write
(Directory directory, String segmentName, String segmentSuffix, FieldInfos infos, IOContext context) Writes the providedFieldInfos
to the directory.abstract void
SegmentInfoWriter.write
(Directory dir, SegmentInfo info, FieldInfos fis, IOContext ioContext) WriteSegmentInfo
data.abstract void
LiveDocsFormat.writeLiveDocs
(MutableBits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Persist live docs bits.Constructors in org.apache.lucene.codecs with parameters of type DirectoryModifierConstructorDescriptionBlockTreeTermsReader
(Directory dir, FieldInfos fieldInfos, SegmentInfo info, PostingsReaderBase postingsReader, IOContext ioContext, String segmentSuffix, int indexDivisor) Sole constructor. -
Uses of Directory in org.apache.lucene.codecs.compressing
Methods in org.apache.lucene.codecs.compressing with parameters of type DirectoryModifier and TypeMethodDescriptionCompressingStoredFieldsFormat.fieldsReader
(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) CompressingStoredFieldsFormat.fieldsWriter
(Directory directory, SegmentInfo si, IOContext context) final TermVectorsReader
CompressingTermVectorsFormat.vectorsReader
(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) final TermVectorsWriter
CompressingTermVectorsFormat.vectorsWriter
(Directory directory, SegmentInfo segmentInfo, IOContext context) Constructors in org.apache.lucene.codecs.compressing with parameters of type DirectoryModifierConstructorDescriptionCompressingStoredFieldsReader
(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor.CompressingStoredFieldsWriter
(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize) Sole constructor.CompressingTermVectorsReader
(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor.CompressingTermVectorsWriter
(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize) Sole constructor. -
Uses of Directory in org.apache.lucene.codecs.lucene3x
Methods in org.apache.lucene.codecs.lucene3x with parameters of type DirectoryModifier and TypeMethodDescriptionDeprecated.static void
Lucene3xSegmentInfoReader.readLegacyInfos
(SegmentInfos infos, Directory directory, IndexInput input, int format) Deprecated. -
Uses of Directory in org.apache.lucene.codecs.lucene40
Methods in org.apache.lucene.codecs.lucene40 with parameters of type DirectoryModifier and TypeMethodDescriptionLucene40StoredFieldsFormat.fieldsReader
(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene40StoredFieldsFormat.fieldsWriter
(Directory directory, SegmentInfo si, IOContext context) Deprecated.Lucene40LiveDocsFormat.readLiveDocs
(Directory dir, SegmentCommitInfo info, IOContext context) Lucene40TermVectorsFormat.vectorsReader
(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) Lucene40TermVectorsFormat.vectorsWriter
(Directory directory, SegmentInfo segmentInfo, IOContext context) void
Lucene40SegmentInfoWriter.write
(Directory dir, SegmentInfo si, FieldInfos fis, IOContext ioContext) Deprecated.Save a single segment's info.void
Lucene40LiveDocsFormat.writeLiveDocs
(MutableBits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Constructors in org.apache.lucene.codecs.lucene40 with parameters of type DirectoryModifierConstructorDescriptionLucene40PostingsReader
(Directory dir, FieldInfos fieldInfos, SegmentInfo segmentInfo, IOContext ioContext, String segmentSuffix) Deprecated.Sole constructor.Lucene40StoredFieldsReader
(Directory d, SegmentInfo si, FieldInfos fn, IOContext context) Sole constructor.Lucene40StoredFieldsWriter
(Directory directory, String segment, IOContext context) Sole constructor.Lucene40TermVectorsReader
(Directory d, SegmentInfo si, FieldInfos fieldInfos, IOContext context) Sole constructor.Lucene40TermVectorsWriter
(Directory directory, String segment, IOContext context) Sole constructor. -
Uses of Directory in org.apache.lucene.codecs.lucene41
Constructors in org.apache.lucene.codecs.lucene41 with parameters of type DirectoryModifierConstructorDescriptionLucene41PostingsReader
(Directory dir, FieldInfos fieldInfos, SegmentInfo segmentInfo, IOContext ioContext, String segmentSuffix) Sole constructor. -
Uses of Directory in org.apache.lucene.codecs.lucene46
Methods in org.apache.lucene.codecs.lucene46 with parameters of type DirectoryModifier and TypeMethodDescriptionvoid
Lucene46SegmentInfoWriter.write
(Directory dir, SegmentInfo si, FieldInfos fis, IOContext ioContext) Save a single segment's info. -
Uses of Directory in org.apache.lucene.index
Fields in org.apache.lucene.index declared as DirectoryModifier and TypeFieldDescriptionCheckIndex.Status.dir
Directory index is in.protected Directory
ConcurrentMergeScheduler.dir
Directory
that holds the index.final Directory
SegmentInfo.dir
Where this segment resides.protected final Directory
DirectoryReader.directory
The index directory.final Directory
SegmentReadState.directory
Directory
where this segment is read from.final Directory
SegmentWriteState.directory
Directory
where this segment will be written to.Methods in org.apache.lucene.index that return DirectoryModifier and TypeMethodDescriptionfinal Directory
DirectoryReader.directory()
Returns the directory this index resides in.SegmentReader.directory()
Returns the directory this index resides in.abstract Directory
IndexCommit.getDirectory()
Returns theDirectory
for the index.IndexWriter.getDirectory()
Returns the Directory used by this index.MergePolicy.MergeException.getDirectory()
Returns theDirectory
of the index that hit the exception.Methods in org.apache.lucene.index with parameters of type DirectoryModifier and TypeMethodDescriptionvoid
IndexWriter.addIndexes
(Directory... dirs) Adds all segments from an array of indexes into this index.long
TrackingIndexWriter.addIndexes
(Directory... dirs) CallsIndexWriter.addIndexes(Directory...)
and returns the generation that reflects this change.void
MergePolicy.OneMerge.checkAborted
(Directory dir) Called periodically byIndexWriter
while merging to see if the merge is aborted.Returns all file names referenced by SegmentInfo instances matching the provided Directory (ie files associated with any "external" segments are skipped).static long
SegmentInfos.getLastCommitGeneration
(Directory directory) Get the generation of the most recent commit to the index in this directory (N in the segments_N file).static String
SegmentInfos.getLastCommitSegmentsFileName
(Directory directory) Get the filename of the segments_N file for the most recent commit to the index in this Directory.static boolean
DirectoryReader.indexExists
(Directory directory) Returnstrue
if an index likely exists at the specified directory.static boolean
Returnstrue
iff the index in the named directory is currently locked.static List<IndexCommit>
DirectoryReader.listCommits
(Directory dir) Returns all commit points that exist in the Directory.static DirectoryReader
Returns a IndexReader reading the index in the given Directorystatic DirectoryReader
Expert: Returns a IndexReader reading the index in the given Directory with the given termInfosIndexDivisor.static DirectoryReader
Deprecated.static DirectoryReader
Deprecated.final void
Find the latest commit (segments_N file
) and load allSegmentCommitInfo
s.final void
Read a particular segmentFileName.Returns a description of the merges in this specification.Returns a readable description of the current merge state.Returns a description of this segment.Used for debugging.Returns readable description of this segment.static void
Forcibly unlocks the index in the named directory.static String
SegmentInfos.write3xInfo
(Directory dir, SegmentInfo si, IOContext context) Deprecated.static void
SegmentInfos.writeSegmentsGen
(Directory dir, long generation) A utility for writing theIndexFileNames.SEGMENTS_GEN
file to aDirectory
.Constructors in org.apache.lucene.index with parameters of type DirectoryModifierConstructorDescriptionCheckAbort
(MergePolicy.OneMerge merge, Directory dir) Creates a #CheckAbort instance.CheckIndex
(Directory dir) Create a new CheckIndex on the directory.protected
DirectoryReader
(Directory directory, AtomicReader[] segmentReaders) Expert: Constructs aDirectoryReader
on the given subReaders.FindSegmentsFile
(Directory directory) Sole constructor.IndexUpgrader
(Directory dir, IndexWriterConfig iwc, boolean deletePriorCommits) Creates index upgrader on the given directory, using anIndexWriter
using the given config.IndexUpgrader
(Directory dir, Version matchVersion) Creates index upgrader on the given directory, using anIndexWriter
using the givenmatchVersion
.IndexUpgrader
(Directory dir, Version matchVersion, PrintStream infoStream, boolean deletePriorCommits) Creates index upgrader on the given directory, using anIndexWriter
using the givenmatchVersion
.IndexWriter
(Directory d, IndexWriterConfig conf) Constructs a new IndexWriter per the settings given inconf
.MergeException
(String message, Directory dir) Create aMergeException
.MergeException
(Throwable exc, Directory dir) Create aMergeException
.PersistentSnapshotDeletionPolicy
(IndexDeletionPolicy primary, Directory dir) PersistentSnapshotDeletionPolicy
wraps anotherIndexDeletionPolicy
to enable flexible snapshotting, passingIndexWriterConfig.OpenMode.CREATE_OR_APPEND
by default.PersistentSnapshotDeletionPolicy
(IndexDeletionPolicy primary, Directory dir, IndexWriterConfig.OpenMode mode) PersistentSnapshotDeletionPolicy
wraps anotherIndexDeletionPolicy
to enable flexible snapshotting.ReaderManager
(Directory dir) Creates and returns a new ReaderManager from the givenDirectory
.SegmentInfo
(Directory dir, String version, String name, int docCount, boolean isCompoundFile, Codec codec, Map<String, String> diagnostics) Construct a new complete SegmentInfo instance from input.SegmentInfo
(Directory dir, String version, String name, int docCount, boolean isCompoundFile, Codec codec, Map<String, String> diagnostics, Map<String, String> attributes) Construct a new complete SegmentInfo instance from input.SegmentReadState
(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor) Create aSegmentReadState
.SegmentReadState
(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor, String segmentSuffix) Create aSegmentReadState
.SegmentWriteState
(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context) Sole constructor.SegmentWriteState
(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, 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 TypeClassDescriptionclass
Base implementation for a concreteDirectory
.final class
Class for accessing a compound stream.class
Expert: A Directory instance that switches files between two other Directory instances.class
Directory implementation that delegates calls to another directory.class
Base class for Directory implementations that store index files in the file system.class
File-basedDirectory
implementation that uses mmap for reading, andFSDirectory.FSIndexOutput
for writing.class
AnFSDirectory
implementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing.class
Wraps aRAMDirectory
around any provided delegate directory, to be used during NRT search.class
A memory-residentDirectory
implementation.final class
class
A straightforward implementation ofFSDirectory
using java.io.RandomAccessFile.final class
A 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 Directory
FilterDirectory.getDelegate()
Return the wrappedDirectory
.NRTCachingDirectory.getDelegate()
CompoundFileDirectory.getDirectory()
FileSwitchDirectory.getPrimaryDir()
Return the primary directoryFileSwitchDirectory.getSecondaryDir()
Return the secondary directoryMethods in org.apache.lucene.store with parameters of type DirectoryModifier and TypeMethodDescriptionvoid
Copies the file src toDirectory
to under the new file name dest.void
void
Constructors in org.apache.lucene.store with parameters of type DirectoryModifierConstructorDescriptionCompoundFileDirectory
(Directory directory, String fileName, IOContext context, boolean openForWrite) Create a new CompoundFileDirectory.FileSwitchDirectory
(Set<String> primaryExtensions, Directory primaryDir, Directory secondaryDir, boolean doClose) protected
Sole constructor, typically called from sub-classes.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 <= maxCachedMBRAMDirectory
(Directory dir, IOContext context) Creates a newRAMDirectory
instance from a differentDirectory
implementation.RateLimitedDirectoryWrapper
(Directory wrapped) -
Uses of Directory in org.apache.lucene.util
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 void
IOUtils.deleteFilesIgnoringExceptions
(Directory dir, String... files) Deletes all given files, suppressing all thrown IOExceptions.
DirectoryReader.open(Directory)