org.apache.lucene.store
Class Directory
java.lang.Object
org.apache.lucene.store.Directory
public abstract class Directory
extends java.lang.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;
- Doug Cutting
void | close() - Closes the store.
|
OutputStream | createFile(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 of a file in the directory.
|
long | fileModified(String name) - Returns the time the named file was last modified.
|
String[] | list() - Returns an array of strings, one for each file in the directory.
|
Lock | makeLock(String name) - Construct a
Lock .
|
InputStream | openFile(String name) - Returns a stream reading an existing file.
|
void | renameFile(String from, String to) - Renames an existing file in the directory.
|
void | touchFile(String name) - Set the modified time of an existing file to now.
|
close
public void close()
throws IOException
Closes the store.
createFile
public OutputStream createFile(String name)
throws IOException
Creates a new, empty file in the directory with the given name.
Returns a stream writing this file.
deleteFile
public void deleteFile(String name)
throws IOException
Removes an existing file in the directory.
fileExists
public boolean fileExists(String name)
throws IOException
Returns true iff a file with the given name exists.
fileLength
public long fileLength(String name)
throws IOException
Returns the length of a file in the directory.
fileModified
public long fileModified(String name)
throws IOException
Returns the time the named file was last modified.
list
public String[] list()
throws IOException
Returns an array of strings, one for each file in the directory.
makeLock
public Lock makeLock(String name)
name
- the name of the lock file
openFile
public InputStream openFile(String name)
throws IOException
Returns a stream reading an existing file.
renameFile
public void renameFile(String from,
String to)
throws IOException
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.
touchFile
public void touchFile(String name)
throws IOException
Set the modified time of an existing file to now.
Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.