|
||||||||||
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
public class FSDirectory
Straightforward implementation of Directory
as a directory of files.
Directory
Field Summary | |
---|---|
static java.lang.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(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. |
static boolean |
getDisableLocks()
Returns whether Lucene's use of lock files is disabled. |
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. |
IndexInput |
openInput(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. |
static void |
setDisableLocks(boolean doDisableLocks)
Set whether Lucene's use of lock files is disabled. |
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 org.apache.lucene.store.Directory |
---|
createFile, openFile |
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
Constructor Detail |
---|
protected FSDirectory()
Method Detail |
---|
public static void setDisableLocks(boolean doDisableLocks)
public static boolean getDisableLocks()
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 java.lang.String[] list()
list
in class Directory
public boolean fileExists(java.lang.String name)
fileExists
in class Directory
public long fileModified(java.lang.String name)
fileModified
in class Directory
public static long fileModified(java.io.File directory, java.lang.String name)
public void touchFile(java.lang.String name)
touchFile
in class Directory
public long fileLength(java.lang.String name)
fileLength
in class Directory
public void deleteFile(java.lang.String name) throws java.io.IOException
deleteFile
in class Directory
java.io.IOException
public void renameFile(java.lang.String from, java.lang.String to) throws java.io.IOException
renameFile
in class Directory
java.io.IOException
public IndexOutput createOutput(java.lang.String name) throws java.io.IOException
createOutput
in class Directory
java.io.IOException
public IndexInput openInput(java.lang.String name) throws java.io.IOException
openInput
in class Directory
java.io.IOException
public Lock makeLock(java.lang.String name)
Lock
with the specified name. Locks are implemented
with File.createNewFile()
.
makeLock
in class Directory
name
- the name of the lock file
Lock
holding the lockpublic void close()
close
in class Directory
public java.io.File getFile()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |