org.apache.lucene.store
public class FSDirectory extends Directory
getDirectory
, or specifying the LockFactory class by setting
org.apache.lucene.store.FSDirectoryLockFactoryClass
Java system
property, or by calling FSDirectory after creating
the Directory.
Directories are cached, so that, for a given canonical
path, the same FSDirectory instance will always be
returned by getDirectory
. This permits
synchronization on directories.
See Also: Directory
Nested Class Summary | |
---|---|
protected static class | FSDirectory.FSIndexInput |
protected static class | FSDirectory.FSIndexOutput |
Field Summary | |
---|---|
static String | LOCK_DIR
Directory specified by org.apache.lucene.lockDir
or java.io.tmpdir system property. |
Constructor Summary | |
---|---|
protected | FSDirectory() |
Method Summary | |
---|---|
void | close() Closes the store to future operations. |
IndexOutput | createOutput(String name) Creates a new, empty file in the directory with the given name.
|
void | deleteFile(String name) Removes an existing file in the directory. |
boolean | fileExists(String name) Returns true iff a file with the given name exists. |
long | fileLength(String name) Returns the length in bytes of a file in the directory. |
long | fileModified(String name) Returns the time the named file was last modified. |
static long | fileModified(File directory, String name) Returns the time the named file was last modified. |
static FSDirectory | getDirectory(String path) Returns the directory instance for the named location. |
static FSDirectory | getDirectory(String path, LockFactory lockFactory) Returns the directory instance for the named location. |
static FSDirectory | getDirectory(File file) Returns the directory instance for the named location. |
static FSDirectory | getDirectory(File file, LockFactory lockFactory) Returns the directory instance for the named location. |
static FSDirectory | getDirectory(String path, boolean create) Returns the directory instance for the named location.
|
static FSDirectory | getDirectory(File file, boolean create) Returns the directory instance for the named location.
|
static boolean | getDisableLocks()
Returns whether Lucene's use of lock files is disabled. |
File | getFile() |
String | getLockID() |
String[] | list() Returns an array of strings, one for each Lucene index file in the directory. |
IndexInput | openInput(String name) |
IndexInput | openInput(String name, int bufferSize) |
void | renameFile(String from, String to) Renames an existing file in the directory.
|
static void | setDisableLocks(boolean doDisableLocks)
Set whether Lucene's use of lock files is disabled. |
String | toString() For debug output. |
void | touchFile(String name) Set the modified time of an existing file to now. |
Deprecated: As of 2.1, LOCK_DIR
is unused
because the write.lock is now stored by default in the
index directory. If you really want to store locks
elsewhere you can create your own SimpleFSLockFactory (or NativeFSLockFactory,
etc.) passing in your preferred lock directory. Then,
pass this LockFactory
instance to one of
the getDirectory
methods that take a
lockFactory
(for example, FSDirectory).
org.apache.lucene.lockDir
or java.io.tmpdir
system property.Parameters: path the path to the directory.
Returns: the FSDirectory for the named file.
Parameters: path the path to the directory. lockFactory instance of LockFactory providing the locking implementation.
Returns: the FSDirectory for the named file.
Parameters: file the path to the directory.
Returns: the FSDirectory for the named file.
Parameters: file the path to the directory. lockFactory instance of LockFactory providing the locking implementation.
Returns: the FSDirectory for the named file.
Deprecated: Use IndexWriter's create flag, instead, to create a new index.
Returns the directory instance for the named location.Parameters: path the path to the directory. create if true, create, or erase any existing contents.
Returns: the FSDirectory for the named file.
Deprecated: Use IndexWriter's create flag, instead, to create a new index.
Returns the directory instance for the named location.Parameters: file the path to the directory. create if true, create, or erase any existing contents.
Returns: the FSDirectory for the named file.
Returns: true if locks are disabled, false if locks are enabled.
Deprecated:
Renames an existing file in the directory. Warning: This is not atomic.