## Uses of Class
org.apache.lucene.store.Directory

Packages that use Directory
org.apache.lucene.codecs: Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.compressing: StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
org.apache.lucene.codecs.lucene3x: Codec to support Lucene 3.x indexes (readonly)
org.apache.lucene.codecs.lucene40: Lucene 4.0 file format.
org.apache.lucene.codecs.lucene41: Lucene 4.1 file format.
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.search: Code to search indices.
org.apache.lucene.store: Binary i/o API, used for all index data.
org.apache.lucene.util: Some utility classes.

Uses of Directory in org.apache.lucene.codecs

Methods in org.apache.lucene.codecs with parameters of type Directory
`abstract StoredFieldsReader` `StoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)` Returns a `StoredFieldsReader` to load stored fields.
`abstract StoredFieldsWriter` `StoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context)` Returns a `StoredFieldsWriter` to write stored fields.
`abstract SegmentInfo` `SegmentInfoReader.read(Directory directory, String segmentName, IOContext context)` Read `SegmentInfo` data from a directory.
`abstract FieldInfos` `FieldInfosReader.read(Directory directory, String segmentName, IOContext iocontext)` Read the `FieldInfos` previously written with `FieldInfosWriter`.
`abstract Bits` `LiveDocsFormat.readLiveDocs(Directory dir, SegmentInfoPerCommit info, IOContext context)` Read live docs bits.
`abstract TermVectorsReader` `TermVectorsFormat.vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)` Returns a `TermVectorsReader` to read term vectors.
`abstract TermVectorsWriter` `TermVectorsFormat.vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)` Returns a `TermVectorsWriter` to write term vectors.
`abstract void` `SegmentInfoWriter.write(Directory dir, SegmentInfo info, FieldInfos fis, IOContext ioContext)` Write `SegmentInfo` data.
`abstract void` `FieldInfosWriter.write(Directory directory, String segmentName, FieldInfos infos, IOContext context)` Writes the provided `FieldInfos` to the directory.
`abstract void` `LiveDocsFormat.writeLiveDocs(MutableBits bits, Directory dir, SegmentInfoPerCommit info, int newDelCount, IOContext context)` Persist live docs bits.

Constructors in org.apache.lucene.codecs with parameters of type Directory
`BlockTreeTermsReader(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 Directory
`StoredFieldsReader` `CompressingStoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
`StoredFieldsWriter` `CompressingStoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context)`
`TermVectorsReader` `CompressingTermVectorsFormat.vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)`
`TermVectorsWriter` `CompressingTermVectorsFormat.vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)`

Constructors in org.apache.lucene.codecs.compressing with parameters of type Directory
`CompressingStoredFieldsReader(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 Directory
`SegmentInfo` `Lucene3xSegmentInfoReader.read(Directory directory, String segmentName, IOContext context)` Deprecated.
`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 Directory
`StoredFieldsReader` `Lucene40StoredFieldsFormat.fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
`StoredFieldsWriter` `Lucene40StoredFieldsFormat.fieldsWriter(Directory directory, SegmentInfo si, IOContext context)`
`SegmentInfo` `Lucene40SegmentInfoReader.read(Directory dir, String segment, IOContext context)`
`Bits` `Lucene40LiveDocsFormat.readLiveDocs(Directory dir, SegmentInfoPerCommit info, IOContext context)`
`TermVectorsReader` `Lucene40TermVectorsFormat.vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)`
`TermVectorsWriter` `Lucene40TermVectorsFormat.vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)`
`void` `Lucene40SegmentInfoWriter.write(Directory dir, SegmentInfo si, FieldInfos fis, IOContext ioContext)` Save a single segment's info.
`void` `Lucene40LiveDocsFormat.writeLiveDocs(MutableBits bits, Directory dir, SegmentInfoPerCommit info, int newDelCount, IOContext context)`

Constructors in org.apache.lucene.codecs.lucene40 with parameters of type Directory
`Lucene40PostingsReader(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 Directory
`Lucene41PostingsReader(Directory dir, FieldInfos fieldInfos, SegmentInfo segmentInfo, IOContext ioContext, String segmentSuffix)` Sole constructor.

Uses of Directory in org.apache.lucene.index

Fields in org.apache.lucene.index declared as Directory
`Directory` `SegmentInfo.dir` Where this segment resides.
`protected Directory` `ConcurrentMergeScheduler.dir` `Directory` that holds the index.
`Directory` `CheckIndex.Status.dir` Directory index is in.
`Directory` `SegmentWriteState.directory` `Directory` where this segment will be written to.
`Directory` `SegmentReadState.directory` `Directory` where this segment is read from.
`protected Directory` `DirectoryReader.directory` The index directory.

Methods in org.apache.lucene.index that return Directory
`Directory` `SegmentReader.directory()` Returns the directory this index resides in.
`Directory` `DirectoryReader.directory()` Returns the directory this index resides in.
`Directory` `SnapshotDeletionPolicy.SnapshotCommitPoint.getDirectory()`
`Directory` `MergePolicy.MergeException.getDirectory()` Returns the `Directory` of the index that hit the exception.
`Directory` `IndexWriter.getDirectory()` Returns the Directory used by this index.
`abstract Directory` `IndexCommit.getDirectory()` Returns the `Directory` for the index.

Methods in org.apache.lucene.index with parameters of type Directory
`void` `IndexWriter.addIndexes(Directory... dirs)` Adds all segments from an array of indexes into this index.
`void` `MergePolicy.OneMerge.checkAborted(Directory dir)` Called periodically by `IndexWriter` while merging to see if the merge is aborted.
`Collection<String>` `SegmentInfos.files(Directory dir, boolean includeSegmentsFile)` 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)` Returns `true` if an index likely exists at the specified directory.
`static boolean` `IndexWriter.isLocked(Directory directory)` Returns `true` 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` `IndexReader.open(Directory directory)` Deprecated. Use `DirectoryReader.open(Directory)`
`static DirectoryReader` `DirectoryReader.open(Directory directory)` Returns a IndexReader reading the index in the given Directory
`static DirectoryReader` `IndexReader.open(Directory directory, int termInfosIndexDivisor)` Deprecated. Use `DirectoryReader.open(Directory,int)`
`static DirectoryReader` `DirectoryReader.open(Directory directory, int termInfosIndexDivisor)` Expert: Returns a IndexReader reading the index in the given Directory with the given termInfosIndexDivisor.
`void` `SegmentInfos.read(Directory directory)` Find the latest commit (`segments_N file`) and load all `SegmentInfoPerCommit`s.
`void` `SegmentInfos.read(Directory directory, String segmentFileName)` Read a particular segmentFileName.
`static Map<String,String>` `PersistentSnapshotDeletionPolicy.readSnapshotsInfo(Directory dir)` Reads the snapshots information from the given `Directory`.
`String` `MergePolicy.OneMerge.segString(Directory dir)` Returns a readable description of the current merge state.
`String` `MergePolicy.MergeSpecification.segString(Directory dir)` Returns a description of the merges in this specification.
`String` `SegmentInfos.toString(Directory directory)` Returns readable description of this segment.
`String` `SegmentInfoPerCommit.toString(Directory dir, int pendingDelCount)` Returns a description of this segment.
`String` `SegmentInfo.toString(Directory dir, int delCount)` Used for debugging.
`static void` `IndexWriter.unlock(Directory directory)` Forcibly unlocks the index in the named directory.
`static String` `SegmentInfos.write3xInfo(Directory dir, SegmentInfo si, IOContext context)` Deprecated.

Constructors in org.apache.lucene.index with parameters of type Directory
`CheckIndex(Directory dir)` Create a new CheckIndex on the directory.
`DirectoryReader(Directory directory, AtomicReader[] segmentReaders)` Expert: Constructs a `DirectoryReader` on the given subReaders.
`IndexUpgrader(Directory dir, IndexWriterConfig iwc, boolean deletePriorCommits)` Creates index upgrader on the given directory, using an `IndexWriter` using the given config.
`IndexUpgrader(Directory dir, Version matchVersion)` Creates index upgrader on the given directory, using an `IndexWriter` using the given `matchVersion`.
`IndexUpgrader(Directory dir, Version matchVersion, PrintStream infoStream, boolean deletePriorCommits)` Creates index upgrader on the given directory, using an `IndexWriter` using the given `matchVersion`.
`IndexWriter(Directory d, IndexWriterConfig conf)` Constructs a new IndexWriter per the settings given in `conf`.
`MergePolicy.MergeException(String message, Directory dir)` Create a `MergeException`.
`MergePolicy.MergeException(Throwable exc, Directory dir)` Create a `MergeException`.
`MergeState.CheckAbort(MergePolicy.OneMerge merge, Directory dir)` Creates a #CheckAbort instance.
`PersistentSnapshotDeletionPolicy(IndexDeletionPolicy primary, Directory dir, IndexWriterConfig.OpenMode mode, Version matchVersion)` `PersistentSnapshotDeletionPolicy` wraps another `IndexDeletionPolicy` to enable flexible snapshotting.
`ReaderManager(Directory dir)` Creates and returns a new ReaderManager from the given `Directory`.
`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.
`SegmentInfos.FindSegmentsFile(Directory directory)` Sole constructor.
`SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor)` Create a `SegmentReadState`.
`SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor, String segmentSuffix)` Create a `SegmentReadState`.
`SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, org.apache.lucene.index.BufferedDeletes segDeletes, IOContext context)` Sole constructor.

Uses of Directory in org.apache.lucene.search

Methods in org.apache.lucene.search with parameters of type Directory
`long` `NRTManager.TrackingIndexWriter.addIndexes(Directory... dirs)`

Constructors in org.apache.lucene.search with parameters of type Directory
`SearcherManager(Directory dir, SearcherFactory searcherFactory)` Creates and returns a new SearcherManager from the given `Directory`.

Uses of Directory in org.apache.lucene.store

Subclasses of Directory in org.apache.lucene.store
`class` `CompoundFileDirectory` Class for accessing a compound stream.
`class` `FileSwitchDirectory` Expert: A Directory instance that switches files between two other Directory instances.
`class` `FSDirectory` Base class for Directory implementations that store index files in the file system.
`class` `MMapDirectory` File-based `Directory` implementation that uses mmap for reading, and `FSDirectory.FSIndexOutput` for writing.
`class` `NIOFSDirectory` An `FSDirectory` implementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing.
`class` `NRTCachingDirectory` Wraps a `RAMDirectory` around any provided delegate directory, to be used during NRT search.
`class` `RAMDirectory` A memory-resident `Directory` implementation.
`class` `RateLimitedDirectoryWrapper` A `Directory` wrapper that allows `IndexOutput` rate limiting using `IO context` specific `rate limiters`.
`class` `SimpleFSDirectory` A straightforward implementation of `FSDirectory` using java.io.RandomAccessFile.
`class` `TrackingDirectoryWrapper` A delegating Directory that records which files were written to and deleted.

Methods in org.apache.lucene.store that return Directory
`Directory` `TrackingDirectoryWrapper.getDelegate()`
`Directory` `RateLimitedDirectoryWrapper.getDelegate()`
`Directory` `NRTCachingDirectory.getDelegate()`
`Directory` `CompoundFileDirectory.getDirectory()`
`Directory` `FileSwitchDirectory.getPrimaryDir()` Return the primary directory
`Directory` `FileSwitchDirectory.getSecondaryDir()` Return the secondary directory

Methods in org.apache.lucene.store with parameters of type Directory
`void` `TrackingDirectoryWrapper.copy(Directory to, String src, String dest, IOContext context)`
`void` `RateLimitedDirectoryWrapper.copy(Directory to, String src, String dest, IOContext context)`
`void` `Directory.copy(Directory to, String src, String dest, IOContext context)` Copies the file src to `Directory` to under the new file name dest.

Constructors in org.apache.lucene.store with parameters of type Directory
`CompoundFileDirectory(Directory directory, String fileName, IOContext context, boolean openForWrite)` Create a new CompoundFileDirectory.
`FileSwitchDirectory(Set<String> primaryExtensions, Directory primaryDir, Directory secondaryDir, boolean doClose)`
`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 <= maxCachedMB
`RAMDirectory(Directory dir, IOContext context)` Creates a new `RAMDirectory` instance from a different `Directory` implementation.
`RateLimitedDirectoryWrapper(Directory wrapped)`
`TrackingDirectoryWrapper(Directory other)`

Uses of Directory in org.apache.lucene.util

Methods in org.apache.lucene.util that return types with arguments of type Directory
`static Class<? extends Directory>` `CommandLineUtil.loadDirectoryClass(String clazzName)` Loads a specific Directory implementation

Methods in org.apache.lucene.util with parameters of type Directory
`static void` `IOUtils.deleteFilesIgnoringExceptions(Directory dir, String... files)` Deletes all given files, suppressing all thrown IOExceptions.

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.