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.
Modifier and Type | Field and Description |
---|---|
private boolean |
doClose |
private Directory |
primaryDir |
private java.util.Set<java.lang.String> |
primaryExtensions |
private Directory |
secondaryDir |
Constructor and Description |
---|
FileSwitchDirectory(java.util.Set<java.lang.String> primaryExtensions,
Directory primaryDir,
Directory secondaryDir,
boolean doClose) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the store.
|
IndexOutput |
createOutput(java.lang.String name,
IOContext context)
Creates a new, empty file in the directory with the given name.
|
IndexOutput |
createTempOutput(java.lang.String prefix,
java.lang.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(java.lang.String name)
Removes an existing file in the directory.
|
long |
fileLength(java.lang.String name)
Returns the length of a file in the directory.
|
private Directory |
getDirectory(java.lang.String name) |
static java.lang.String |
getExtension(java.lang.String name)
Utility method to return a file's extension.
|
Directory |
getPrimaryDir()
Return the primary directory
|
Directory |
getSecondaryDir()
Return the secondary directory
|
java.lang.String[] |
listAll()
Returns an array of strings, one for each entry in the directory, in sorted (UTF16, java's String.compare) order.
|
Lock |
obtainLock(java.lang.String name)
Returns an obtained
Lock . |
IndexInput |
openInput(java.lang.String name,
IOContext context)
Returns a stream reading an existing file.
|
void |
renameFile(java.lang.String source,
java.lang.String dest)
Renames
source to dest as an atomic operation,
where dest does not yet exist in the directory. |
void |
sync(java.util.Collection<java.lang.String> names)
Ensure that any writes to these files are moved to
stable storage.
|
copyFrom, ensureOpen, openChecksumInput, toString
private final Directory secondaryDir
private final Directory primaryDir
private final java.util.Set<java.lang.String> primaryExtensions
private boolean doClose
public Directory getPrimaryDir()
public Directory getSecondaryDir()
public Lock obtainLock(java.lang.String name) throws java.io.IOException
Directory
Lock
.obtainLock
in class Directory
name
- the name of the lock fileLockObtainFailedException
- (optional specific exception) if the lock could
not be obtained because it is currently held elsewhere.java.io.IOException
- if any i/o error occurs attempting to gain the lockpublic void close() throws java.io.IOException
Directory
public java.lang.String[] listAll() throws java.io.IOException
Directory
public static java.lang.String getExtension(java.lang.String name)
private Directory getDirectory(java.lang.String name)
public void deleteFile(java.lang.String name) throws java.io.IOException
Directory
deleteFile
in class Directory
java.io.IOException
public long fileLength(java.lang.String name) throws java.io.IOException
Directory
FileNotFoundException
or NoSuchFileException
if the file does not exist.
fileLength
in class Directory
name
- the name of the file for which to return the length.java.io.IOException
- if there was an IO error while retrieving the file's
length.public IndexOutput createOutput(java.lang.String name, IOContext context) throws java.io.IOException
Directory
createOutput
in class Directory
java.io.IOException
public IndexOutput createTempOutput(java.lang.String prefix, java.lang.String suffix, IOContext context) throws java.io.IOException
Directory
.tmp
. Use
IndexOutput.getName()
to see what name was used.createTempOutput
in class Directory
java.io.IOException
public void sync(java.util.Collection<java.lang.String> names) throws java.io.IOException
Directory
public void renameFile(java.lang.String source, java.lang.String dest) throws java.io.IOException
Directory
source
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 Directory
java.io.IOException
public IndexInput openInput(java.lang.String name, IOContext context) throws java.io.IOException
Directory
Throws FileNotFoundException
or NoSuchFileException
if the file does not exist.