org.mapdb

Class Volume

java.lang.Object

org.mapdb.Volume

Direct Known Subclasses:

Volume.ByteBufferVol, Volume.FileChannelVol

public abstract class Volume
extends java.lang.Object

MapDB abstraction over raw storage (file, disk partition, memory etc...).

Implementations needs to be thread safe (especially 'ensureAvailable') operation. However updates do not have to be atomic, it is clients responsibility to ensure two threads are not writing/reading into the same location.

Author:

Jan Kotek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Volume.ByteBufferVol Abstract Volume over bunch of ByteBuffers It leaves ByteBufferVol details (allocation, disposal) on subclasses.
static interface	Volume.Factory Factory which creates two/three volumes used by each MapDB Storage Engine
static class	Volume.FileChannelVol Volume which uses FileChannel.
static class	Volume.MappedFileVol
static class	Volume.MemoryVol

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed

Constructor Summary

Constructors

Constructor and Description
Volume()

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract void	deleteFile()
void	ensureAvailable(long offset) Check space allocated by Volume is bigger or equal to given offset.
static Volume.Factory	fileFactory(java.io.File indexFile, int rafMode, boolean readOnly, long sizeLimit, int chunkShift, int sizeIncrement)
static Volume.Factory	fileFactory(java.io.File indexFile, int rafMode, boolean readOnly, long sizeLimit, int chunkShift, int sizeIncrement, java.io.File physFile, java.io.File transLogFile)
static Volume.Factory	fileFactory(java.io.File indexFile, int rafMode, boolean readOnly, long sizeLimit, int chunkShift, int sizeIncrement, java.io.File physFile, java.io.File transLogFile, boolean asyncWriteEnabled)
static Volume.Factory	fileFactory(java.io.File indexFile, int rafMode, boolean readOnly, long sizeLimit, int chunkShift, int sizeIncrement, java.io.File physFile, java.io.File transLogFile, boolean asyncWriteEnabled, boolean cleanerHackDisable)
abstract byte	getByte(long offset)
abstract java.io.DataInput	getDataInput(long offset, int size)
abstract java.io.File	getFile() returns underlying file if it exists
abstract int	getInt(long offset)
abstract long	getLong(long offset)
long	getPackedLong(long pos)
long	getSixLong(long pos) Reads a long from the indicated position
int	getUnsignedByte(long offset)
int	getUnsignedShort(long offset)
abstract boolean	isEmpty()
abstract boolean	isSliced()
static Volume.Factory	memoryFactory(boolean useDirectBuffer, long sizeLimit, int chunkShift)
abstract void	putByte(long offset, byte value)
abstract void	putData(long offset, byte[] src, int srcPos, int srcSize)
abstract void	putData(long offset, java.nio.ByteBuffer buf)
abstract void	putInt(long offset, int value)
abstract void	putLong(long offset, long value)
int	putPackedLong(long pos, long value) Writes packed long at given position and returns number of bytes used.
void	putSixLong(long pos, long value) Writes a long to the indicated position
void	putUnsignedByte(long offset, int b)
void	putUnsignedShort(long offset, int value)
abstract void	sync()
abstract void	truncate(long size)
abstract boolean	tryAvailable(long offset)
static Volume	volumeForFile(java.io.File f, boolean useRandomAccessFile, boolean readOnly, long sizeLimit, int chunkShift, int sizeIncrement)
static Volume	volumeForFile(java.io.File f, boolean useRandomAccessFile, boolean readOnly, long sizeLimit, int chunkShift, int sizeIncrement, boolean asyncWriteEnabled)
static Volume	volumeForFile(java.io.File f, boolean useRandomAccessFile, boolean readOnly, long sizeLimit, int chunkShift, int sizeIncrement, boolean asyncWriteEnabled, boolean cleanerHackDisable)
static void	volumeTransfer(long size, Volume from, Volume to) transfer data from one volume to second.

Methods inherited from class java.lang.Object

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

Field Detail

closed

protected boolean closed

Constructor Detail

Volume

public Volume()

Method Detail

ensureAvailable

public void ensureAvailable(long offset)

Check space allocated by Volume is bigger or equal to given offset. So it is safe to write into smaller offsets.

Parameters:

offset -

Throws:

java.io.IOError - if Volume can not be expanded beyond given offset

tryAvailable

public abstract boolean tryAvailable(long offset)

truncate

public abstract void truncate(long size)

putLong

public abstract void putLong(long offset,
                             long value)

putInt

public abstract void putInt(long offset,
                            int value)

putByte

public abstract void putByte(long offset,
                             byte value)

putData

public abstract void putData(long offset,
                             byte[] src,
                             int srcPos,
                             int srcSize)

putData

public abstract void putData(long offset,
                             java.nio.ByteBuffer buf)

getLong

public abstract long getLong(long offset)

getInt

public abstract int getInt(long offset)

getByte

public abstract byte getByte(long offset)

getDataInput

public abstract java.io.DataInput getDataInput(long offset,
                                               int size)

close

public abstract void close()

sync

public abstract void sync()

isEmpty

public abstract boolean isEmpty()

deleteFile

public abstract void deleteFile()

isSliced

public abstract boolean isSliced()

putUnsignedShort

public void putUnsignedShort(long offset,
                             int value)

getUnsignedShort

public int getUnsignedShort(long offset)

getUnsignedByte

public int getUnsignedByte(long offset)

putUnsignedByte

public void putUnsignedByte(long offset,
                            int b)

getSixLong

public long getSixLong(long pos)

Reads a long from the indicated position

putSixLong

public void putSixLong(long pos,
                       long value)

Writes a long to the indicated position

putPackedLong

public int putPackedLong(long pos,
                         long value)

Writes packed long at given position and returns number of bytes used.

getFile

public abstract java.io.File getFile()

returns underlying file if it exists

getPackedLong

public long getPackedLong(long pos)

volumeForFile

public static Volume volumeForFile(java.io.File f,
                                   boolean useRandomAccessFile,
                                   boolean readOnly,
                                   long sizeLimit,
                                   int chunkShift,
                                   int sizeIncrement)

volumeForFile

public static Volume volumeForFile(java.io.File f,
                                   boolean useRandomAccessFile,
                                   boolean readOnly,
                                   long sizeLimit,
                                   int chunkShift,
                                   int sizeIncrement,
                                   boolean asyncWriteEnabled)

volumeForFile

public static Volume volumeForFile(java.io.File f,
                                   boolean useRandomAccessFile,
                                   boolean readOnly,
                                   long sizeLimit,
                                   int chunkShift,
                                   int sizeIncrement,
                                   boolean asyncWriteEnabled,
                                   boolean cleanerHackDisable)

fileFactory

public static Volume.Factory fileFactory(java.io.File indexFile,
                                         int rafMode,
                                         boolean readOnly,
                                         long sizeLimit,
                                         int chunkShift,
                                         int sizeIncrement)

fileFactory

public static Volume.Factory fileFactory(java.io.File indexFile,
                                         int rafMode,
                                         boolean readOnly,
                                         long sizeLimit,
                                         int chunkShift,
                                         int sizeIncrement,
                                         java.io.File physFile,
                                         java.io.File transLogFile)

fileFactory

public static Volume.Factory fileFactory(java.io.File indexFile,
                                         int rafMode,
                                         boolean readOnly,
                                         long sizeLimit,
                                         int chunkShift,
                                         int sizeIncrement,
                                         java.io.File physFile,
                                         java.io.File transLogFile,
                                         boolean asyncWriteEnabled)

fileFactory

public static Volume.Factory fileFactory(java.io.File indexFile,
                                         int rafMode,
                                         boolean readOnly,
                                         long sizeLimit,
                                         int chunkShift,
                                         int sizeIncrement,
                                         java.io.File physFile,
                                         java.io.File transLogFile,
                                         boolean asyncWriteEnabled,
                                         boolean cleanerHackDisable)

memoryFactory

public static Volume.Factory memoryFactory(boolean useDirectBuffer,
                                           long sizeLimit,
                                           int chunkShift)

volumeTransfer

public static void volumeTransfer(long size,
                                  Volume from,
                                  Volume to)

transfer data from one volume to second. Second volume will be expanded if needed