|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.store.Directory org.apache.lucene.store.FileSwitchDirectory
public class FileSwitchDirectory
Expert: A Directory instance that switches files between two other Directory instances.
Files with the specified extensions are placed in the primary directory; others are placed in the secondary directory. The provided Set must not change once passed to this class, and must allow multiple threads to call contains at once.
NOTE: this API is new and experimental and is subject to suddenly change in the next release.
Field Summary |
---|
Fields inherited from class org.apache.lucene.store.Directory |
---|
isOpen, lockFactory |
Constructor Summary | |
---|---|
FileSwitchDirectory(Set primaryExtensions,
Directory primaryDir,
Directory secondaryDir,
boolean doClose)
|
Method Summary | |
---|---|
void |
close()
Closes the store. |
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 of a file in the directory. |
long |
fileModified(String name)
Returns the time the named file was last modified. |
static String |
getExtension(String name)
Utility method to return a file's extension. |
Directory |
getPrimaryDir()
Return the primary directory |
Directory |
getSecondaryDir()
Return the secondary directory |
String[] |
list()
List the files in the directory. |
String[] |
listAll()
Returns an array of strings, one for each file in the directory. |
IndexInput |
openInput(String name)
Returns a stream reading an existing file. |
void |
renameFile(String from,
String to)
Renames an existing file in the directory. |
void |
sync(String name)
Ensure that any writes to this file are moved to stable storage. |
void |
touchFile(String name)
Set the modified time of an existing file to now. |
Methods inherited from class org.apache.lucene.store.Directory |
---|
clearLock, copy, ensureOpen, getLockFactory, getLockID, makeLock, openInput, setLockFactory, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FileSwitchDirectory(Set primaryExtensions, Directory primaryDir, Directory secondaryDir, boolean doClose)
Method Detail |
---|
public Directory getPrimaryDir()
public Directory getSecondaryDir()
public void close() throws IOException
Directory
close
in class Directory
IOException
public String[] listAll() throws IOException
Directory
Directory.list()
this method does no
filtering of the contents in a directory, and it will
never return null (throws IOException instead).
Currently this method simply falls back to Directory.list()
for Directory impls outside of Lucene's core &
contrib, but in 3.0 that method will be removed and
this method will become abstract.
listAll
in class Directory
IOException
public String[] list() throws IOException
Directory
list
in class Directory
IOException
public static String getExtension(String name)
public boolean fileExists(String name) throws IOException
Directory
fileExists
in class Directory
IOException
public long fileModified(String name) throws IOException
Directory
fileModified
in class Directory
IOException
public void touchFile(String name) throws IOException
Directory
touchFile
in class Directory
IOException
public void deleteFile(String name) throws IOException
Directory
deleteFile
in class Directory
IOException
public void renameFile(String from, String to) throws IOException
Directory
renameFile
in class Directory
IOException
public long fileLength(String name) throws IOException
Directory
fileLength
in class Directory
IOException
public IndexOutput createOutput(String name) throws IOException
Directory
createOutput
in class Directory
IOException
public void sync(String name) throws IOException
Directory
sync
in class Directory
IOException
public IndexInput openInput(String name) throws IOException
Directory
openInput
in class Directory
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |