| java.lang.Object
 org.apache.lucene.store.Directory
org.apache.lucene.store.FSDirectory
All known Subclasses: org.apache.lucene.store.MMapDirectory, org.apache.lucene.store.GCJDirectory,
| FSDirectory | | public class FSDirectory extends Directory (Code) | | Straightforward implementation of
Directory as a directory of files.
Locking implementation is by default the
SimpleFSLockFactory , but
can be changed either by passing in a
LockFactory instance to
getDirectory, or specifying the LockFactory class by setting
org.apache.lucene.store.FSDirectoryLockFactoryClass Java system
property, or by calling
FSDirectory.setLockFactory 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
author:
Doug Cutting |
| Field Summary | |
| final public static String | LOCK_DIR
Directory specified by org.apache.lucene.lockDir
or java.io.tmpdir system property. |
| Method Summary | |
| public synchronized void | close()
Closes the store to future operations. | | public IndexOutput | createOutput(String name)
Creates a new, empty file in the directory with the given name.
Returns a stream writing this file. | | public void | deleteFile(String name)
Removes an existing file in the directory. | | public boolean | fileExists(String name)
Returns true iff a file with the given name exists. | | public long | fileLength(String name)
Returns the length in bytes of a file in the directory. | | public long | fileModified(String name)
Returns the time the named file was last modified. | | public static long | fileModified(File directory, String name)
Returns the time the named file was last modified. | | public static FSDirectory | getDirectory(String path)
Returns the directory instance for the named location.
Parameters:
path - the path to the directory. | | public static FSDirectory | getDirectory(String path, LockFactory lockFactory)
Returns the directory instance for the named location.
Parameters:
path - the path to the directory.
Parameters:
lockFactory - instance of LockFactory providing thelocking implementation. | | public static FSDirectory | getDirectory(File file)
Returns the directory instance for the named location.
Parameters:
file - the path to the directory. | | public static FSDirectory | getDirectory(File file, LockFactory lockFactory)
Returns the directory instance for the named location.
Parameters:
file - the path to the directory.
Parameters:
lockFactory - instance of LockFactory providing thelocking implementation. | | public static FSDirectory | getDirectory(String path, boolean create)
Returns the directory instance for the named location.
Parameters:
path - the path to the directory.
Parameters:
create - if true, create, or erase any existing contents. | | public static FSDirectory | getDirectory(File file, boolean create)
Returns the directory instance for the named location.
Parameters:
file - the path to the directory.
Parameters:
create - if true, create, or erase any existing contents. | | public static boolean | getDisableLocks()
Returns whether Lucene's use of lock files is disabled. | | public File | getFile()
| | public String | getLockID()
| | public String[] | list()
Returns an array of strings, one for each Lucene index file in the directory. | | public IndexInput | openInput(String name)
| | public IndexInput | openInput(String name, int bufferSize)
| | public synchronized void | renameFile(String from, String to)
Renames an existing file in the directory. | | public static void | setDisableLocks(boolean doDisableLocks)
Set whether Lucene's use of lock files is disabled. | | public String | toString()
For debug output. | | public void | touchFile(String name)
Set the modified time of an existing file to now. |
| FSDirectory | | protected FSDirectory()(Code) | | |
| close | | public synchronized void close()(Code) | | Closes the store to future operations.
|
| createOutput | | public IndexOutput createOutput(String name) throws IOException(Code) | | Creates a new, empty file in the directory with the given name.
Returns a stream writing this file.
|
| fileExists | | public boolean fileExists(String name)(Code) | | Returns true iff a file with the given name exists.
|
| fileLength | | public long fileLength(String name)(Code) | | Returns the length in bytes of a file in the directory.
|
| fileModified | | public long fileModified(String name)(Code) | | Returns the time the named file was last modified.
|
| fileModified | | public static long fileModified(File directory, String name)(Code) | | Returns the time the named file was last modified.
|
| getDirectory | | public static FSDirectory getDirectory(String path) throws IOException(Code) | | Returns the directory instance for the named location.
Parameters:
path - the path to the directory. the FSDirectory for the named file. |
| getDirectory | | public static FSDirectory getDirectory(String path, LockFactory lockFactory) throws IOException(Code) | | Returns the directory instance for the named location.
Parameters:
path - the path to the directory.
Parameters:
lockFactory - instance of LockFactory providing thelocking implementation. the FSDirectory for the named file. |
| getDirectory | | public static FSDirectory getDirectory(File file) throws IOException(Code) | | Returns the directory instance for the named location.
Parameters:
file - the path to the directory. the FSDirectory for the named file. |
| getDirectory | | public static FSDirectory getDirectory(File file, LockFactory lockFactory) throws IOException(Code) | | Returns the directory instance for the named location.
Parameters:
file - the path to the directory.
Parameters:
lockFactory - instance of LockFactory providing thelocking implementation. the FSDirectory for the named file. |
| getDirectory | | public static FSDirectory getDirectory(String path, boolean create) throws IOException(Code) | | Returns the directory instance for the named location.
Parameters:
path - the path to the directory.
Parameters:
create - if true, create, or erase any existing contents. the FSDirectory for the named file. |
| getDirectory | | public static FSDirectory getDirectory(File file, boolean create) throws IOException(Code) | | Returns the directory instance for the named location.
Parameters:
file - the path to the directory.
Parameters:
create - if true, create, or erase any existing contents. the FSDirectory for the named file. |
| getDisableLocks | | public static boolean getDisableLocks()(Code) | | Returns whether Lucene's use of lock files is disabled.
true if locks are disabled, false if locks are enabled. |
| list | | public String[] list()(Code) | | Returns an array of strings, one for each Lucene index file in the directory.
|
| renameFile | | public synchronized void renameFile(String from, String to) throws IOException(Code) | | Renames an existing file in the directory.
Warning: This is not atomic.
|
| setDisableLocks | | public static void setDisableLocks(boolean doDisableLocks)(Code) | | Set whether Lucene's use of lock files is disabled. By default,
lock files are enabled. They should only be disabled if the index
is on a read-only medium like a CD-ROM.
|
| touchFile | | public void touchFile(String name)(Code) | | Set the modified time of an existing file to now.
|
|
|