org.apache.lucene.store
Class FSDirectory
Straightforward implementation of
Directory
as a directory of files.
static String | LOCK_DIR - Directory specified by
org.apache.lucene.lockDir
or java.io.tmpdir system property
|
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.
|
static long | fileModified(File directory, String name) - Returns the time the named file was last modified.
|
long | fileModified(String name) - Returns the time the named file was last modified.
|
static FSDirectory | getDirectory(File file, boolean create) - Returns the directory instance for the named location.
|
static FSDirectory | getDirectory(String path, 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[] | list() - Returns an array of strings, one for each file in the directory.
|
Lock | makeLock(String name) - Constructs a
Lock with the specified name.
|
IndexInput | openInput(String name) - Returns a stream reading an existing file.
|
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.
|
close , createFile , createOutput , deleteFile , fileExists , fileLength , fileModified , list , makeLock , openFile , openInput , renameFile , touchFile |
LOCK_DIR
public static final String LOCK_DIR
Directory specified by org.apache.lucene.lockDir
or java.io.tmpdir
system property
FSDirectory
protected FSDirectory()
close
public void close()
Closes the store to future operations.
- close in interface Directory
createOutput
public IndexOutput createOutput(String name)
throws IOException
Creates a new, empty file in the directory with the given name.
Returns a stream writing this file.
- createOutput in interface Directory
deleteFile
public void deleteFile(String name)
throws IOException
Removes an existing file in the directory.
- deleteFile in interface Directory
fileExists
public boolean fileExists(String name)
Returns true iff a file with the given name exists.
- fileExists in interface Directory
fileLength
public long fileLength(String name)
Returns the length in bytes of a file in the directory.
- fileLength in interface Directory
fileModified
public static long fileModified(File directory,
String name)
Returns the time the named file was last modified.
fileModified
public long fileModified(String name)
Returns the time the named file was last modified.
- fileModified in interface Directory
getDirectory
public static FSDirectory getDirectory(File file,
boolean create)
throws IOException
Returns the directory instance for the named location.
Directories are cached, so that, for a given canonical path, the same
FSDirectory instance will always be returned. This permits
synchronization on directories.
file
- the path to the directory.create
- if true, create, or erase any existing contents.
- the FSDirectory for the named file.
getDirectory
public static FSDirectory getDirectory(String path,
boolean create)
throws IOException
Returns the directory instance for the named location.
Directories are cached, so that, for a given canonical path, the same
FSDirectory instance will always be returned. This permits
synchronization on directories.
path
- the path to the directory.create
- if true, create, or erase any existing contents.
- the FSDirectory for the named file.
getDisableLocks
public static boolean getDisableLocks()
Returns whether Lucene's use of lock files is disabled.
- true if locks are disabled, false if locks are enabled.
getFile
public File getFile()
list
public String[] list()
Returns an array of strings, one for each file in the directory.
- list in interface Directory
makeLock
public Lock makeLock(String name)
Constructs a
Lock
with the specified name. Locks are implemented
with
File.createNewFile()
.
- makeLock in interface Directory
name
- the name of the lock file
- an instance of
Lock
holding the lock
openInput
public IndexInput openInput(String name)
throws IOException
Returns a stream reading an existing file.
- openInput in interface Directory
renameFile
public void renameFile(String from,
String to)
throws IOException
Renames an existing file in the directory.
- renameFile in interface Directory
setDisableLocks
public static void setDisableLocks(boolean doDisableLocks)
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.
toString
public String toString()
For debug output.
touchFile
public void touchFile(String name)
Set the modified time of an existing file to now.
- touchFile in interface Directory
Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.