org.apache.solr.store.blockcache

Class BlockDirectory

java.lang.Object

org.apache.lucene.store.Directory

org.apache.solr.store.blockcache.BlockDirectory

All Implemented Interfaces:

Closeable, AutoCloseable

public class BlockDirectory
extends Directory

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
static long	BLOCK_MOD
static long	BLOCK_SHIFT
static int	BLOCK_SIZE
static org.slf4j.Logger	LOG
static Cache	NO_CACHE

Constructor Summary

Constructors

Constructor and Description
BlockDirectory(String dirName, Directory directory, Cache cache, Set<String> blockCacheFileTypes, boolean blockCacheReadEnabled, boolean blockCacheWriteEnabled)
BlockDirectory(String dirName, Directory directory, Cache cache, Set<String> blockCacheFileTypes, boolean blockCacheReadEnabled, boolean blockCacheWriteEnabled, boolean releaseBlocksOnClose)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearLock(String name)
void	close()
void	copy(Directory to, String src, String dest, IOContext context)
IndexOutput	createOutput(String name, IOContext context)
void	deleteFile(String name)
boolean	fileExists(String name)
long	fileLength(String name)
static long	getBlock(long pos)
Cache	getCache() Expert: mostly for tests
Directory	getDirectory()
LockFactory	getLockFactory()
String	getLockID()
static long	getPosition(long pos)
static long	getRealPosition(long block, long positionInBlock)
boolean	isBlockCacheReadEnabled()
boolean	isBlockCacheWriteEnabled()
String[]	listAll()
Lock	makeLock(String name)
IndexInput	openInput(String name, IOContext context)
void	setLockFactory(LockFactory lockFactory)
void	sync(Collection<String> names)
String	toString()

Methods inherited from class org.apache.lucene.store.Directory

ensureOpen, openChecksumInput

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static org.slf4j.Logger LOG

BLOCK_SHIFT

public static final long BLOCK_SHIFT

See Also:

Constant Field Values

BLOCK_MOD

public static final long BLOCK_MOD

See Also:

Constant Field Values

BLOCK_SIZE

public static final int BLOCK_SIZE

See Also:

Constant Field Values

NO_CACHE

public static Cache NO_CACHE

Constructor Detail

BlockDirectory

public BlockDirectory(String dirName,
              Directory directory,
              Cache cache,
              Set<String> blockCacheFileTypes,
              boolean blockCacheReadEnabled,
              boolean blockCacheWriteEnabled)
               throws IOException

Throws:

IOException

BlockDirectory

public BlockDirectory(String dirName,
              Directory directory,
              Cache cache,
              Set<String> blockCacheFileTypes,
              boolean blockCacheReadEnabled,
              boolean blockCacheWriteEnabled,
              boolean releaseBlocksOnClose)
               throws IOException

Throws:

IOException

Method Detail

getBlock

public static long getBlock(long pos)

getPosition

public static long getPosition(long pos)

getRealPosition

public static long getRealPosition(long block,
                   long positionInBlock)

openInput

public IndexInput openInput(String name,
                   IOContext context)
                     throws IOException

Specified by:

openInput in class Directory

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Directory

Throws:

IOException

clearLock

public void clearLock(String name)
               throws IOException

Specified by:

clearLock in class Directory

Throws:

IOException

getCache

public Cache getCache()

Expert: mostly for tests

WARNING: This API is experimental and might change in incompatible ways in the next release.

copy

public void copy(Directory to,
        String src,
        String dest,
        IOContext context)
          throws IOException

Overrides:

copy in class Directory

Throws:

IOException

getLockFactory

public LockFactory getLockFactory()

Specified by:

getLockFactory in class Directory

getLockID

public String getLockID()

Overrides:

getLockID in class Directory

makeLock

public Lock makeLock(String name)

Specified by:

makeLock in class Directory

setLockFactory

public void setLockFactory(LockFactory lockFactory)
                    throws IOException

Specified by:

setLockFactory in class Directory

Throws:

IOException

sync

public void sync(Collection<String> names)
          throws IOException

Specified by:

sync in class Directory

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Directory

createOutput

public IndexOutput createOutput(String name,
                       IOContext context)
                         throws IOException

Specified by:

createOutput in class Directory

Throws:

IOException

deleteFile

public void deleteFile(String name)
                throws IOException

Specified by:

deleteFile in class Directory

Throws:

IOException

fileExists

public boolean fileExists(String name)
                   throws IOException

Specified by:

fileExists in class Directory

Throws:

IOException

fileLength

public long fileLength(String name)
                throws IOException

Specified by:

fileLength in class Directory

Throws:

IOException

listAll

public String[] listAll()
                 throws IOException

Specified by:

listAll in class Directory

Throws:

IOException

getDirectory

public Directory getDirectory()

isBlockCacheReadEnabled

public boolean isBlockCacheReadEnabled()

isBlockCacheWriteEnabled

public boolean isBlockCacheWriteEnabled()