Package org.apache.lucene.store

Class FileSwitchDirectory

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class FileSwitchDirectory
extends BaseDirectory
    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.

    • Constructor Detail

      • FileSwitchDirectory

        public FileSwitchDirectory​(java.util.Set<java.lang.String> primaryExtensions,
                           Directory primaryDir,
                           Directory secondaryDir,
                           boolean doClose)

    • Method Detail

      • getPrimaryDir

        public Directory getPrimaryDir()
        Return the primary directory

      • getSecondaryDir

        public Directory getSecondaryDir()
        Return the secondary directory

      • close

        public void close()
           throws java.io.IOException
        Description copied from class: Directory
        Closes the store.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class Directory
        Throws:
        java.io.IOException

      • getExtension

        public static java.lang.String getExtension​(java.lang.String name)
        Utility method to return a file's extension.

      • fileExists

        public boolean fileExists​(java.lang.String name)
                   throws java.io.IOException
        Description copied from class: Directory
        Returns true iff a file with the given name exists.
        Specified by:
        fileExists in class Directory
        Throws:
        java.io.IOException

      • deleteFile

        public void deleteFile​(java.lang.String name)
                throws java.io.IOException
        Description copied from class: Directory
        Removes an existing file in the directory.
        Specified by:
        deleteFile in class Directory
        Throws:
        java.io.IOException

      • fileLength

        public long fileLength​(java.lang.String name)
                throws java.io.IOException
        Description copied from class: Directory
        Returns the length of a file in the directory. This method follows the following contract:
        • Must throw FileNotFoundException if the file does not exist (not java.nio.file.NoSuchFileException of Java 7).
        • Returns a value ≥0 if the file exists, which specifies its length.
        Specified by:
        fileLength in class Directory
        Parameters:
        name - the name of the file for which to return the length.
        Throws:
        java.io.IOException - if there was an IO error while retrieving the file's length.

      • createOutput

        public IndexOutput createOutput​(java.lang.String name,
                                IOContext context)
                         throws java.io.IOException
        Description copied from class: Directory
        Creates a new, empty file in the directory with the given name. Returns a stream writing this file.
        Specified by:
        createOutput in class Directory
        Throws:
        java.io.IOException

      • sync

        public void sync​(java.util.Collection<java.lang.String> names)
          throws java.io.IOException
        Description copied from class: Directory
        Ensure that any writes to these files are moved to stable storage. Lucene uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index.

        NOTE: Clients may call this method for same files over and over again, so some impls might optimize for that. For other impls the operation can be a noop, for various reasons.
        Specified by:
        sync in class Directory
        Throws:
        java.io.IOException

      • openInput

        public IndexInput openInput​(java.lang.String name,
                            IOContext context)
                     throws java.io.IOException
        Description copied from class: Directory
        Returns a stream reading an existing file, with the specified read buffer size. The particular Directory implementation may ignore the buffer size. Currently the only Directory implementations that respect this parameter are FSDirectory and CompoundFileDirectory.
      • Must throw FileNotFoundException if the file does not exist (not java.nio.file.NoSuchFileException of Java 7).
Specified by:
openInput in class Directory
Throws:
java.io.IOException
Overrides:
createSlicer in class Directory
Throws:
java.io.IOException - if an IOException occurs