Package org.apache.lucene.codecs
Class CompoundDirectory
- java.lang.Object
-
- org.apache.lucene.store.Directory
-
- org.apache.lucene.codecs.CompoundDirectory
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public abstract class CompoundDirectory extends Directory
A read-onlyDirectorythat consists of a view over a compound file.- See Also:
CompoundFormat- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCompoundDirectory()Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidcheckIntegrity()Checks consistency of this directory.IndexOutputcreateOutput(String name, IOContext context)Creates a new, empty file in the directory and returns anIndexOutputinstance for appending data to this file.IndexOutputcreateTempOutput(String prefix, String suffix, IOContext context)Creates a new, empty, temporary file in the directory and returns anIndexOutputinstance for appending data to this file.voiddeleteFile(String name)Not implementedLockobtainLock(String name)Acquires and returns aLockfor a file with the given name.voidrename(String from, String to)Not implementedvoidsync(Collection<String> names)Ensures that any writes to these files are moved to stable storage (made durable).voidsyncMetaData()Ensures that directory metadata, such as recent file renames, are moved to stable storage.-
Methods inherited from class org.apache.lucene.store.Directory
close, copyFrom, ensureOpen, fileLength, getPendingDeletions, getTempFileName, listAll, openChecksumInput, openInput, toString
-
-
-
-
Method Detail
-
checkIntegrity
public abstract void checkIntegrity() throws IOExceptionChecks consistency of this directory.Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.
- Throws:
IOException
-
deleteFile
public final void deleteFile(String name)
Not implemented- Specified by:
deleteFilein classDirectory- Parameters:
name- the name of an existing file.- Throws:
UnsupportedOperationException- always: not supported by CFS
-
rename
public final void rename(String from, String to)
Not implemented- Specified by:
renamein classDirectory- Throws:
UnsupportedOperationException- always: not supported by CFS
-
syncMetaData
public final void syncMetaData()
Description copied from class:DirectoryEnsures that directory metadata, such as recent file renames, are moved to stable storage.- Specified by:
syncMetaDatain classDirectory- See Also:
Directory.sync(Collection)
-
createOutput
public final IndexOutput createOutput(String name, IOContext context) throws IOException
Description copied from class:DirectoryCreates a new, empty file in the directory and returns anIndexOutputinstance for appending data to this file.This method must throw
FileAlreadyExistsExceptionif the file already exists.- Specified by:
createOutputin classDirectory- Parameters:
name- the name of the file to create.- Throws:
IOException- in case of I/O error
-
createTempOutput
public final IndexOutput createTempOutput(String prefix, String suffix, IOContext context) throws IOException
Description copied from class:DirectoryCreates a new, empty, temporary file in the directory and returns anIndexOutputinstance for appending data to this file.The temporary file name (accessible via
IndexOutput.getName()) will start withprefix, end withsuffixand have a reserved file extension.tmp.- Specified by:
createTempOutputin classDirectory- Throws:
IOException
-
sync
public final void sync(Collection<String> names)
Description copied from class:DirectoryEnsures that any writes to these files are moved to stable storage (made durable).Lucene uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index.
- Specified by:
syncin classDirectory- See Also:
Directory.syncMetaData()
-
-