Class ByteBuffersDirectory
- java.lang.Object
-
- org.apache.lucene.store.Directory
-
- org.apache.lucene.store.BaseDirectory
-
- org.apache.lucene.store.ByteBuffersDirectory
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public final class ByteBuffersDirectory extends BaseDirectory
AByteBuffer-basedDirectoryimplementation that can be used to store index files on the heap.Important: Note that
MMapDirectoryis nearly always a better choice as it uses OS caches more effectively (through memory-mapped buffers). A heap-based directory like this one can have the advantage in case of ephemeral, small, short-lived indexes when disk syncs provide an additional overhead.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description static BiFunction<String,ByteBuffersDataOutput,IndexInput>OUTPUT_AS_BYTE_ARRAYstatic BiFunction<String,ByteBuffersDataOutput,IndexInput>OUTPUT_AS_MANY_BUFFERSstatic BiFunction<String,ByteBuffersDataOutput,IndexInput>OUTPUT_AS_MANY_BUFFERS_LUCENEDeprecated.UseOUTPUT_AS_MANY_BUFFERSinstead.static BiFunction<String,ByteBuffersDataOutput,IndexInput>OUTPUT_AS_ONE_BUFFER-
Fields inherited from class org.apache.lucene.store.BaseDirectory
isOpen, lockFactory
-
-
Constructor Summary
Constructors Constructor Description ByteBuffersDirectory()ByteBuffersDirectory(LockFactory lockFactory)ByteBuffersDirectory(LockFactory factory, Supplier<ByteBuffersDataOutput> bbOutputSupplier, BiFunction<String,ByteBuffersDataOutput,IndexInput> outputToInput)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes the 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)Removes an existing file in the directory.booleanfileExists(String name)longfileLength(String name)Returns the byte length of a file in the directory.Set<String>getPendingDeletions()Returns a set of files currently pending deletion in this directory.String[]listAll()Returns names of all files stored in this directory.IndexInputopenInput(String name, IOContext context)Opens a stream for reading an existing file.voidrename(String source, String dest)Renamessourcefile todestfile wheredestmust not already exist in the directory.voidsync(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.BaseDirectory
ensureOpen, obtainLock, toString
-
Methods inherited from class org.apache.lucene.store.Directory
copyFrom, getTempFileName, openChecksumInput
-
-
-
-
Field Detail
-
OUTPUT_AS_MANY_BUFFERS
public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_MANY_BUFFERS
-
OUTPUT_AS_ONE_BUFFER
public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_ONE_BUFFER
-
OUTPUT_AS_BYTE_ARRAY
public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_BYTE_ARRAY
-
OUTPUT_AS_MANY_BUFFERS_LUCENE
@Deprecated public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_MANY_BUFFERS_LUCENE
Deprecated.UseOUTPUT_AS_MANY_BUFFERSinstead.UseByteBufferIndexInputfor reading, otherwise identical toOUTPUT_AS_MANY_BUFFERS.
-
-
Constructor Detail
-
ByteBuffersDirectory
public ByteBuffersDirectory()
-
ByteBuffersDirectory
public ByteBuffersDirectory(LockFactory lockFactory)
-
ByteBuffersDirectory
public ByteBuffersDirectory(LockFactory factory, Supplier<ByteBuffersDataOutput> bbOutputSupplier, BiFunction<String,ByteBuffersDataOutput,IndexInput> outputToInput)
-
-
Method Detail
-
listAll
public String[] listAll() throws IOException
Description copied from class:DirectoryReturns names of all files stored in this directory. The output must be in sorted (UTF-16, java'sString.compareTo(java.lang.String)) order.- Specified by:
listAllin classDirectory- Throws:
IOException- in case of I/O error
-
deleteFile
public void deleteFile(String name) throws IOException
Description copied from class:DirectoryRemoves an existing file in the directory.This method must throw either
NoSuchFileExceptionorFileNotFoundExceptionifnamepoints to a non-existing file.- Specified by:
deleteFilein classDirectory- Parameters:
name- the name of an existing file.- Throws:
IOException- in case of I/O error
-
fileLength
public long fileLength(String name) throws IOException
Description copied from class:DirectoryReturns the byte length of a file in the directory.This method must throw either
NoSuchFileExceptionorFileNotFoundExceptionifnamepoints to a non-existing file.- Specified by:
fileLengthin classDirectory- Parameters:
name- the name of an existing file.- Throws:
IOException- in case of I/O error
-
fileExists
public boolean fileExists(String name)
-
createOutput
public 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 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
-
rename
public void rename(String source, String dest) throws IOException
Description copied from class:DirectoryRenamessourcefile todestfile wheredestmust not already exist in the directory.It is permitted for this operation to not be truly atomic, for example both
sourceanddestcan be visible temporarily inDirectory.listAll(). However, the implementation of this method must ensure the content ofdestappears as the entiresourceatomically. So oncedestis visible for readers, the entire content of previoussourceis visible.This method is used by IndexWriter to publish commits.
- Specified by:
renamein classDirectory- Throws:
IOException
-
sync
public void sync(Collection<String> names) throws IOException
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- Throws:
IOException- See Also:
Directory.syncMetaData()
-
syncMetaData
public void syncMetaData() throws IOExceptionDescription copied from class:DirectoryEnsures that directory metadata, such as recent file renames, are moved to stable storage.- Specified by:
syncMetaDatain classDirectory- Throws:
IOException- See Also:
Directory.sync(Collection)
-
openInput
public IndexInput openInput(String name, IOContext context) throws IOException
Description copied from class:DirectoryOpens a stream for reading an existing file.This method must throw either
NoSuchFileExceptionorFileNotFoundExceptionifnamepoints to a non-existing file.- Specified by:
openInputin classDirectory- Parameters:
name- the name of an existing file.- Throws:
IOException- in case of I/O error
-
close
public void close() throws IOExceptionDescription copied from class:DirectoryCloses the directory.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classDirectory- Throws:
IOException
-
getPendingDeletions
public Set<String> getPendingDeletions()
Description copied from class:DirectoryReturns a set of files currently pending deletion in this directory.- Specified by:
getPendingDeletionsin classDirectory
-
-