Package com.apple.foundationdb.record.lucene.directory

Class FDBDirectoryWrapper

java.lang.Object

com.apple.foundationdb.record.lucene.directory.FDBDirectoryWrapper

All Implemented Interfaces:

AutoCloseable

public class FDBDirectoryWrapper
extends Object
implements AutoCloseable

Wrapper containing an FDBDirectory and cached accessor objects (like IndexWriters). This object is designed to be held by the FDBDirectoryManager, with one object cached per open directory. Because the FDBDirectory contains cached information from FDB, it is important for cache coherency that all writers (etc.) accessing that directory go through the same wrapper object so that they share a common cache.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	USE_COMPOUND_FILE

Constructor Summary

Constructors

Constructor	Description
FDBDirectoryWrapper(IndexMaintainerState state, FDBDirectory directory, Tuple key, int mergeDirectoryCount, AgilityContext agilityContext, LuceneAnalyzerWrapper analyzerWrapper, Exception exceptionAtCreation)

Method Summary

Modifier and Type	Method	Description
void	close()
protected FDBDirectory	createFDBDirectory(IndexMaintainerState state, Tuple key, AgilityContext agilityContext, int blockCacheMaximumSize)
protected FDBDirectory	createFDBDirectory(Subspace subspace, Map<String,String> options, FDBDirectorySharedCacheManager sharedCacheManager, Tuple sharedCacheKey, boolean useCompoundFile, AgilityContext agilityContext, int blockCacheMaximumSize)
FDBDirectory	getDirectory()
org.apache.lucene.index.IndexReader	getReader()	An IndexReader for searching this directory.
org.apache.lucene.index.IndexWriter	getWriter()
org.apache.lucene.index.DirectoryReader	getWriterReader()	Get a DirectoryReader wrapped around the getWriter() to be able to get segments associated with documents.
void	mergeIndex()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

USE_COMPOUND_FILE

public static final boolean USE_COMPOUND_FILE

See Also:

• Constant Field Values

Constructor Details

FDBDirectoryWrapper

public FDBDirectoryWrapper(@Nonnull
 IndexMaintainerState state,
 @Nonnull
 FDBDirectory directory,
 @Nonnull
 Tuple key,
 int mergeDirectoryCount,
 @Nonnull
 AgilityContext agilityContext,
 @Nonnull
 LuceneAnalyzerWrapper analyzerWrapper,
 @Nullable
 Exception exceptionAtCreation)

Method Details

createFDBDirectory

@Nonnull
protected FDBDirectory createFDBDirectory(IndexMaintainerState state,
 Tuple key,
 AgilityContext agilityContext,
 int blockCacheMaximumSize)

createFDBDirectory

@Nonnull
protected FDBDirectory createFDBDirectory(Subspace subspace,
 Map<String,String> options,
 FDBDirectorySharedCacheManager sharedCacheManager,
 Tuple sharedCacheKey,
 boolean useCompoundFile,
 AgilityContext agilityContext,
 int blockCacheMaximumSize)

getDirectory

public FDBDirectory getDirectory()

getReader

public org.apache.lucene.index.IndexReader getReader()
                                              throws IOException

An IndexReader for searching this directory. This will wrap getWriter() if the writer has already been instantiated, but otherwise, will just create a reader against this directory. This object should be closed by callers.

Throws:

IOException

getWriterReader

public org.apache.lucene.index.DirectoryReader getWriterReader()
                                                        throws IOException

Get a DirectoryReader wrapped around the getWriter() to be able to get segments associated with documents. This resource will be closed when this is closed, and should not be closed by callers

Throws:

IOException

getWriter

@Nonnull
public org.apache.lucene.index.IndexWriter getWriter()
                                              throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

mergeIndex

public void mergeIndex()
                throws IOException

Throws:

IOException