org.apache.lucene.store

Class FSDirectory

public class FSDirectory extends Directory

Straightforward implementation of Directory as a directory of files.

Author: Doug Cutting

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, 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[]	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.

Field Detail

LOCK_DIR

public static final String LOCK_DIR

Directory specified by org.apache.lucene.lockDir or java.io.tmpdir system property

Constructor Detail

FSDirectory

protected FSDirectory()

Method Detail

close

public void close()

Closes the store to future operations.

createOutput

public IndexOutput createOutput(String name)

Creates a new, empty file in the directory with the given name. Returns a stream writing this file.

deleteFile

public void deleteFile(String name)

Removes an existing file in the directory.

fileExists

public boolean fileExists(String name)

Returns true iff a file with the given name exists.

fileLength

public long fileLength(String name)

Returns the length in bytes of a file in the directory.

fileModified

public long fileModified(String name)

Returns the time the named file was last modified.

fileModified

public static long fileModified(File directory, String name)

Returns the time the named file was last modified.

getDirectory

public static FSDirectory getDirectory(String path, boolean create)

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.

Parameters: path the path to the directory. create if true, create, or erase any existing contents.

Returns: the FSDirectory for the named file.

getDirectory

public static FSDirectory getDirectory(File file, boolean create)

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.

Parameters: file the path to the directory. create if true, create, or erase any existing contents.

Returns: the FSDirectory for the named file.

getDisableLocks

public static boolean getDisableLocks()

Returns whether Lucene's use of lock files is disabled.

Returns: 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.

makeLock

public Lock makeLock(String name)

Constructs a Lock with the specified name. Locks are implemented with File#createNewFile().

Parameters: name the name of the lock file

Returns: an instance of Lock holding the lock

openInput

public IndexInput openInput(String name)

Returns a stream reading an existing file.

renameFile

public void renameFile(String from, String to)

Renames an existing file in the 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.