File Doc Category Size Date Package
Directory.java API Doc Apache Lucene 2.0.0 2849 Fri May 26 09:54:20 BST 2006 org.apache.lucene.store

Directory

java.lang.Object

public abstract class Directory extends Object

A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.

Java's i/o APIs not used directly, but rather all i/o is through this API. This permits things such as:

implementation of RAM-based indices;
implementation indices stored in a database, via JDBC;
implementation of an index as a single file;

author: Doug Cutting

Fields Summary
Constructors Summary
Methods Summary
public abstract void close()
Closes the store.
public abstract org.apache.lucene.store.IndexOutput createOutput(java.lang.String name)
Creates a new, empty file in the directory with the given name. Returns a stream writing this file.
public abstract void deleteFile(java.lang.String name)
Removes an existing file in the directory.
public abstract boolean fileExists(java.lang.String name)
Returns true iff a file with the given name exists.
public abstract long fileLength(java.lang.String name)
Returns the length of a file in the directory.
public abstract long fileModified(java.lang.String name)
Returns the time the named file was last modified.
public abstract java.lang.String[] list()
Returns an array of strings, one for each file in the directory.
public abstract org.apache.lucene.store.Lock makeLock(java.lang.String name)
Construct a {@link Lock}.
param
name the name of the lock file
public abstract org.apache.lucene.store.IndexInput openInput(java.lang.String name)
Returns a stream reading an existing file.
public abstract void renameFile(java.lang.String from, java.lang.String to)
Renames an existing file in the directory. If a file already exists with the new name, then it is replaced. This replacement should be atomic.
public abstract void touchFile(java.lang.String name)
Set the modified time of an existing file to now.