|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.store.Directory
org.apache.lucene.store.FSDirectory
Straightforward implementation of Directory
as a directory of files.
If the system property 'disableLuceneLocks' has the String value of "true", lock creation will be disabled.
Directory
Field Summary | |
static java.lang.String |
LOCK_DIR
Directory specified by org.apache.lucene.lockdir
or java.io.tmpdir system property |
Method Summary | |
void |
close()
Closes the store to future operations. |
OutputStream |
createFile(java.lang.String name)
Creates a new, empty file in the directory with the given name. |
void |
deleteFile(java.lang.String name)
Removes an existing file in the directory. |
boolean |
fileExists(java.lang.String name)
Returns true iff a file with the given name exists. |
long |
fileLength(java.lang.String name)
Returns the length in bytes of a file in the directory. |
static long |
fileModified(java.io.File directory,
java.lang.String name)
Returns the time the named file was last modified. |
long |
fileModified(java.lang.String name)
Returns the time the named file was last modified. |
static FSDirectory |
getDirectory(java.io.File file,
boolean create)
Returns the directory instance for the named location. |
static FSDirectory |
getDirectory(java.lang.String path,
boolean create)
Returns the directory instance for the named location. |
java.io.File |
getFile()
|
java.lang.String[] |
list()
Returns an array of strings, one for each file in the directory. |
Lock |
makeLock(java.lang.String name)
Constructs a Lock with the specified name. |
InputStream |
openFile(java.lang.String name)
Returns a stream reading an existing file. |
void |
renameFile(java.lang.String from,
java.lang.String to)
Renames an existing file in the directory. |
java.lang.String |
toString()
For debug output. |
void |
touchFile(java.lang.String name)
Set the modified time of an existing file to now. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String LOCK_DIR
org.apache.lucene.lockdir
or java.io.tmpdir
system property
Method Detail |
public static FSDirectory getDirectory(java.lang.String path, boolean create) throws java.io.IOException
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.
java.io.IOException
public static FSDirectory getDirectory(java.io.File file, boolean create) throws java.io.IOException
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.
java.io.IOException
public final java.lang.String[] list() throws java.io.IOException
list
in class Directory
java.io.IOException
public final boolean fileExists(java.lang.String name) throws java.io.IOException
fileExists
in class Directory
java.io.IOException
public final long fileModified(java.lang.String name) throws java.io.IOException
fileModified
in class Directory
java.io.IOException
public static final long fileModified(java.io.File directory, java.lang.String name) throws java.io.IOException
java.io.IOException
public void touchFile(java.lang.String name) throws java.io.IOException
touchFile
in class Directory
java.io.IOException
public final long fileLength(java.lang.String name) throws java.io.IOException
fileLength
in class Directory
java.io.IOException
public final void deleteFile(java.lang.String name) throws java.io.IOException
deleteFile
in class Directory
java.io.IOException
public final void renameFile(java.lang.String from, java.lang.String to) throws java.io.IOException
renameFile
in class Directory
java.io.IOException
public final OutputStream createFile(java.lang.String name) throws java.io.IOException
createFile
in class Directory
java.io.IOException
public final InputStream openFile(java.lang.String name) throws java.io.IOException
openFile
in class Directory
java.io.IOException
public final Lock makeLock(java.lang.String name)
Lock
with the specified name. Locks are implemented
with File.createNewFile()
.
In JDK 1.1 or if system property disableLuceneLocks is the string "true", locks are disabled. Assigning this property any other string will not prevent creation of lock files. This is useful for using Lucene on read-only medium, such as CD-ROM.
makeLock
in class Directory
name
- the name of the lock file
Lock
holding the lockpublic final void close() throws java.io.IOException
close
in class Directory
java.io.IOException
public java.io.File getFile()
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |