org.compass.core.lucene.engine.store.wrapper
Interface DirectoryWrapperProvider

All Known Implementing Classes:

AsyncMemoryMirrorDirectoryWrapperProvider, SyncMemoryMirrorDirectoryWrapperProvider

public interface DirectoryWrapperProvider

A Lucene Directory wrapper provider, allows to wrap the actual created Directory with wrappers (for example to provide memory based cache).

Author:

kimchy

Method Summary

Directory

wrap(String subIndex, Directory dir) Wraps the given directory, and returns the wrapped directory instance.

Method Detail

wrap

Directory wrap(String subIndex,
               Directory dir)
               throws SearchEngineException

Wraps the given directory, and returns the wrapped directory instance.

Parameters:

subIndex - The sub index the directory is associated with

dir - The directory to wrap

Returns:

The wrapped directory

Throws:

SearchEngineException