public class FileSwitchDirectory extends Directory
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.
Locks with a name having the specified extensions are delegated to the primary directory; others are delegated to the secondary directory. Ideally, both Directory instances should use the same lock factory.
| Constructor and Description |
|---|
FileSwitchDirectory(Set<String> primaryExtensions,
Directory primaryDir,
Directory secondaryDir,
boolean doClose) |
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Closes the store.
|
IndexOutput |
createOutput(String name,
IOContext context)
Creates a new, empty file in the directory with the given name.
|
IndexOutput |
createTempOutput(String prefix,
String suffix,
IOContext context)
Creates a new, empty file for writing in the directory, with a
temporary file name including prefix and suffix, ending with the
reserved extension
.tmp. |
void |
deleteFile(String name)
Removes an existing file in the directory.
|
long |
fileLength(String name)
Returns the length of a file in the directory.
|
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[] |
listAll()
Returns an array of strings, one for each entry in the directory, in sorted (UTF16, java's String.compare) order.
|
Lock |
obtainLock(String name)
Returns an obtained
Lock. |
IndexInput |
openInput(String name,
IOContext context)
Returns a stream reading an existing file.
|
void |
renameFile(String source,
String dest)
Renames
source to dest as an atomic operation,
where dest does not yet exist in the directory. |
void |
sync(Collection<String> names)
Ensure that any writes to these files are moved to
stable storage.
|
copyFrom, ensureOpen, openChecksumInput, toStringpublic Directory getPrimaryDir()
public Directory getSecondaryDir()
public Lock obtainLock(String name) throws IOException
DirectoryLock.obtainLock in class Directoryname - the name of the lock fileLockObtainFailedException - (optional specific exception) if the lock could
not be obtained because it is currently held elsewhere.IOException - if any i/o error occurs attempting to gain the lockpublic void close()
throws IOException
Directoryclose in interface Closeableclose in interface AutoCloseableclose in class DirectoryIOExceptionpublic String[] listAll() throws IOException
DirectorylistAll in class DirectoryIOException - in case of IO errorpublic static String getExtension(String name)
public void deleteFile(String name) throws IOException
DirectorydeleteFile in class DirectoryIOExceptionpublic long fileLength(String name) throws IOException
DirectoryFileNotFoundException or NoSuchFileException
if the file does not exist.
fileLength in class Directoryname - the name of the file for which to return the length.IOException - if there was an IO error while retrieving the file's
length.public IndexOutput createOutput(String name, IOContext context) throws IOException
DirectorycreateOutput in class DirectoryIOExceptionpublic IndexOutput createTempOutput(String prefix, String suffix, IOContext context) throws IOException
Directory.tmp. Use
IndexOutput.getName() to see what name was used.createTempOutput in class DirectoryIOExceptionpublic void sync(Collection<String> names) throws IOException
Directorysync in class DirectoryIOExceptionpublic void renameFile(String source, String dest) throws IOException
Directorysource to dest as an atomic operation,
where dest does not yet exist in the directory.
Notes: This method is used by IndexWriter to publish commits.
It is ok if this operation is not truly atomic, for example
both source and dest can be visible temporarily.
It is just important that the contents of dest appear
atomically, or an exception is thrown.
renameFile in class DirectoryIOExceptionpublic IndexInput openInput(String name, IOContext context) throws IOException
DirectoryThrows FileNotFoundException or NoSuchFileException
if the file does not exist.
openInput in class DirectoryIOExceptionCopyright © 2000-2016 Apache Software Foundation. All Rights Reserved.