- java.lang.Object
-
- org.apache.lucene.store.Directory
-
- org.apache.lucene.store.BaseDirectory
-
- org.apache.lucene.store.ByteBuffersDirectory
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public final class ByteBuffersDirectory extends BaseDirectory
AByteBuffer
-basedDirectory
implementation that can be used to store index files on the heap.Important: Note that
MMapDirectory
is 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
ByteBuffersDirectory.FileEntry
-
Field Summary
Fields Modifier and Type Field Description private java.util.function.Supplier<ByteBuffersDataOutput>
bbOutputSupplier
A supplier ofByteBuffersDataOutput
instances used to buffer up the content of written files.private java.util.concurrent.ConcurrentHashMap<java.lang.String,ByteBuffersDirectory.FileEntry>
files
static java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput>
OUTPUT_AS_BYTE_ARRAY
static java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput>
OUTPUT_AS_MANY_BUFFERS
static java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput>
OUTPUT_AS_MANY_BUFFERS_LUCENE
static java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput>
OUTPUT_AS_ONE_BUFFER
private java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput>
outputToInput
Conversion between a buffered index output and the corresponding index input for a given file.private java.util.function.Function<java.lang.String,java.lang.String>
tempFileName
-
Fields inherited from class org.apache.lucene.store.BaseDirectory
isOpen, lockFactory
-
-
Constructor Summary
Constructors Constructor Description ByteBuffersDirectory()
ByteBuffersDirectory(LockFactory lockFactory)
ByteBuffersDirectory(LockFactory factory, java.util.function.Supplier<ByteBuffersDataOutput> bbOutputSupplier, java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput> outputToInput)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Closes the directory.IndexOutput
createOutput(java.lang.String name, IOContext context)
Creates a new, empty file in the directory and returns anIndexOutput
instance for appending data to this file.IndexOutput
createTempOutput(java.lang.String prefix, java.lang.String suffix, IOContext context)
Creates a new, empty, temporary file in the directory and returns anIndexOutput
instance for appending data to this file.void
deleteFile(java.lang.String name)
Removes an existing file in the directory.boolean
fileExists(java.lang.String name)
long
fileLength(java.lang.String name)
Returns the byte length of a file in the directory.java.util.Set<java.lang.String>
getPendingDeletions()
Returns a set of files currently pending deletion in this directory.java.lang.String[]
listAll()
Returns names of all files stored in this directory.IndexInput
openInput(java.lang.String name, IOContext context)
Opens a stream for reading an existing file.void
rename(java.lang.String source, java.lang.String dest)
Renamessource
file todest
file wheredest
must not already exist in the directory.void
sync(java.util.Collection<java.lang.String> names)
Ensures that any writes to these files are moved to stable storage (made durable).void
syncMetaData()
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 java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_MANY_BUFFERS
-
OUTPUT_AS_ONE_BUFFER
public static final java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_ONE_BUFFER
-
OUTPUT_AS_BYTE_ARRAY
public static final java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_BYTE_ARRAY
-
OUTPUT_AS_MANY_BUFFERS_LUCENE
public static final java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_MANY_BUFFERS_LUCENE
-
tempFileName
private final java.util.function.Function<java.lang.String,java.lang.String> tempFileName
-
files
private final java.util.concurrent.ConcurrentHashMap<java.lang.String,ByteBuffersDirectory.FileEntry> files
-
outputToInput
private final java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput> outputToInput
Conversion between a buffered index output and the corresponding index input for a given file.
-
bbOutputSupplier
private final java.util.function.Supplier<ByteBuffersDataOutput> bbOutputSupplier
A supplier ofByteBuffersDataOutput
instances used to buffer up the content of written files.
-
-
Constructor Detail
-
ByteBuffersDirectory
public ByteBuffersDirectory()
-
ByteBuffersDirectory
public ByteBuffersDirectory(LockFactory lockFactory)
-
ByteBuffersDirectory
public ByteBuffersDirectory(LockFactory factory, java.util.function.Supplier<ByteBuffersDataOutput> bbOutputSupplier, java.util.function.BiFunction<java.lang.String,ByteBuffersDataOutput,IndexInput> outputToInput)
-
-
Method Detail
-
listAll
public java.lang.String[] listAll() throws java.io.IOException
Description copied from class:Directory
Returns names of all files stored in this directory. The output must be in sorted (UTF-16, java'sString.compareTo(java.lang.String)
) order.
-
deleteFile
public void deleteFile(java.lang.String name) throws java.io.IOException
Description copied from class:Directory
Removes an existing file in the directory.This method must throw either
NoSuchFileException
orFileNotFoundException
ifname
points to a non-existing file.- Specified by:
deleteFile
in classDirectory
- Parameters:
name
- the name of an existing file.- Throws:
java.io.IOException
- in case of I/O error
-
fileLength
public long fileLength(java.lang.String name) throws java.io.IOException
Description copied from class:Directory
Returns the byte length of a file in the directory.This method must throw either
NoSuchFileException
orFileNotFoundException
ifname
points to a non-existing file.- Specified by:
fileLength
in classDirectory
- Parameters:
name
- the name of an existing file.- Throws:
java.io.IOException
- in case of I/O error
-
fileExists
public boolean fileExists(java.lang.String name)
-
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 and returns anIndexOutput
instance for appending data to this file.This method must throw
FileAlreadyExistsException
if the file already exists.- Specified by:
createOutput
in classDirectory
- Parameters:
name
- the name of the file to create.- Throws:
java.io.IOException
- in case of I/O error
-
createTempOutput
public IndexOutput createTempOutput(java.lang.String prefix, java.lang.String suffix, IOContext context) throws java.io.IOException
Description copied from class:Directory
Creates a new, empty, temporary file in the directory and returns anIndexOutput
instance for appending data to this file.The temporary file name (accessible via
IndexOutput.getName()
) will start withprefix
, end withsuffix
and have a reserved file extension.tmp
.- Specified by:
createTempOutput
in classDirectory
- Throws:
java.io.IOException
-
rename
public void rename(java.lang.String source, java.lang.String dest) throws java.io.IOException
Description copied from class:Directory
Renamessource
file todest
file wheredest
must not already exist in the directory.It is permitted for this operation to not be truly atomic, for example both
source
anddest
can be visible temporarily inDirectory.listAll()
. However, the implementation of this method must ensure the content ofdest
appears as the entiresource
atomically. So oncedest
is visible for readers, the entire content of previoussource
is visible.This method is used by IndexWriter to publish commits.
-
sync
public void sync(java.util.Collection<java.lang.String> names) throws java.io.IOException
Description copied from class:Directory
Ensures 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:
sync
in classDirectory
- Throws:
java.io.IOException
- See Also:
Directory.syncMetaData()
-
syncMetaData
public void syncMetaData() throws java.io.IOException
Description copied from class:Directory
Ensures that directory metadata, such as recent file renames, are moved to stable storage.- Specified by:
syncMetaData
in classDirectory
- Throws:
java.io.IOException
- See Also:
Directory.sync(Collection)
-
openInput
public IndexInput openInput(java.lang.String name, IOContext context) throws java.io.IOException
Description copied from class:Directory
Opens a stream for reading an existing file.This method must throw either
NoSuchFileException
orFileNotFoundException
ifname
points to a non-existing file.
-
close
public void close() throws java.io.IOException
Description copied from class:Directory
Closes the directory.
-
getPendingDeletions
public java.util.Set<java.lang.String> getPendingDeletions()
Description copied from class:Directory
Returns a set of files currently pending deletion in this directory.- Specified by:
getPendingDeletions
in classDirectory
-
-