net.sf.joafip.kvstore.service

Class AbstractHeapDataManager

java.lang.Object

net.sf.joafip.kvstore.service.AbstractHeapDataManager

All Implemented Interfaces:

Serializable, IHeapDataManager

Direct Known Subclasses:

BtreePlusDataManager, HeapFileDataManager

@NotStorableClass
public abstract class AbstractHeapDataManager
extends Object
implements IHeapDataManager, Serializable

Author:

luc peuvrier

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLEAR_STANDBY_MODIFICATION_FAILED
protected static String	FAILED_READ_DATA_RECORD
protected static String	FLUSH_FAILED
protected JoafipLogger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractHeapDataManager()

Method Summary

Methods

Modifier and Type	Method and Description
DataRecordIdentifier	ceilingDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
protected DataRecordIdentifier	ceilingDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
void	clear() clear the heap content.
protected abstract void	clearImpl()
void	clearStandbyModification() clear creation, modification, and deletion to do on the heap.
protected abstract void	clearStandbyModificationImpl()
protected abstract void	closeHeapManagerAfterException() close heap element manager after exception
Iterator<DataRecordIdentifier>	dataRecordIterator()
protected abstract Iterator<DataRecordIdentifier>	dataRecordIteratorImpl()
boolean	deleteDataRecord(DataRecordIdentifier dataRecordIdentifier) delete an existing data record knowing its identifier.
protected abstract boolean	deleteDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
DataRecordIdentifier	firstDataRecordIdentifier()
protected DataRecordIdentifier	firstDataRecordIdentifierImpl()
DataRecordIdentifier	floorDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
protected DataRecordIdentifier	floorDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
void	flush() flush creation, modification, and deletion to the heap the heap is updated.
protected abstract void	flushImp() implement all flush action after call to #updateHeapRecordImpl(DataRecordIdentifier, IHeapDataRecord)
long	freeSize() get heap total free size in bytes.
protected abstract long	freeSizeImpl()
Set<DataRecordIdentifier>	getDataRecordIdentifierSet() for test purpose
protected abstract Set<DataRecordIdentifier>	getDataRecordIdentifierSetImpl()
DataRecordIdentifier	getNewDataRecordIdentifier() to get a new data identifier for data record creation: return the next free data record identifier and internally increment the next free data record identifier when created #readHeapDataRecord(DataRecordIdentifier) can be used for the data record identifier IHeapDataManager.flush() must be call to store the modification.
protected abstract DataRecordIdentifier	getNewDataRecordIdentifierImpl() to get a new data identifier for future data record creation
DataRecordIdentifier	getNextFreeDataRecordIdentifier() get the next free data record identifier
protected abstract DataRecordIdentifier	getNextFreeDataRecordIdentifierImpl()
int	getNumberOfDataRecord() get number of data record in heap file.
protected abstract int	getNumberOfDataRecordImpl()
int	getNumberOfFreeRecord() get number of free record in heap file.
protected abstract int	getNumberOfFreeRecordImpl()
boolean	hasDataRecord(DataRecordIdentifier dataRecordIdentifier) to check if have data record for a data record identifier.
protected abstract boolean	hasDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
long	heapSize() get heap total size in bytes.
protected abstract long	heapSizeImpl()
DataRecordIdentifier	higherDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
protected DataRecordIdentifier	higherDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
boolean	isServiceStarted()
DataRecordIdentifier	lastDataRecordIdentifier()
protected DataRecordIdentifier	lastDataRecordIdentifierImpl()
DataRecordIdentifier	lowerDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
protected DataRecordIdentifier	lowerDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
DataRecordIdentifier	nextDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
protected DataRecordIdentifier	nextDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
byte[]	readDataRecord(DataRecordIdentifier dataRecordIdentifier) read data for a data record.
protected abstract byte[]	readDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
protected abstract void	removeFiles() remove existing files
DataRecordIdentifier	removeFirstDataRecord() remove first data record and return its data record identifier.
protected abstract DataRecordIdentifier	removeFirstDataRecordImpl()
void	setNextFreeDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier) set the next free data record identifier.
protected abstract void	setNextFreeDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
void	startService(boolean removeFiles) start heap data manager service.
protected abstract void	startServiceImpl(boolean removeFiles) to implement open actions
void	stopService() stop heap data manager service, do not flush in file any modification.
void	stopService(boolean removeFiles)
protected abstract void	stopServiceImpl(boolean removeFiles) to implement close actions
long	usedSize() get heap total used size in bytes.
protected abstract long	usedSizeImpl()
boolean	writeDataRecord(DataRecordIdentifier dataRecordIdentifier, byte[] data) write data record.
protected abstract boolean	writeDataRecordImpl(DataRecordIdentifier dataRecordIdentifier, byte[] data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.joafip.kvstore.service.IHeapDataManager

backup, getLastRecordPositionInFile, getRecordPositionInfile, getStorageFileName, isDataLost, setDataRecordKeyManager

Field Detail

logger

protected final JoafipLogger logger

FLUSH_FAILED

protected static final String FLUSH_FAILED

See Also:

Constant Field Values

FAILED_READ_DATA_RECORD

protected static final String FAILED_READ_DATA_RECORD

See Also:

Constant Field Values

CLEAR_STANDBY_MODIFICATION_FAILED

protected static final String CLEAR_STANDBY_MODIFICATION_FAILED

See Also:

Constant Field Values

Constructor Detail

AbstractHeapDataManager

public AbstractHeapDataManager()

Method Detail

startService

public final void startService(boolean removeFiles)
                        throws HeapException

Description copied from interface: IHeapDataManager

start heap data manager service.

Specified by:

startService in interface IHeapDataManager

Parameters:

removeFiles - true if remove files before open common initialization at construction

Throws:

HeapException - read/write error, file restored from stable backup, file management is not opened, no file in stable state

removeFiles

protected abstract void removeFiles()
                             throws HeapException

remove existing files

Throws:

HeapException

startServiceImpl

protected abstract void startServiceImpl(boolean removeFiles)
                                  throws HeapException

to implement open actions

Parameters:

removeFiles -

Throws:

HeapException

stopService

public final void stopService()
                       throws HeapException

Description copied from interface: IHeapDataManager

stop heap data manager service, do not flush in file any modification. modification are lost, files not removed.

Specified by:

stopService in interface IHeapDataManager

Throws:

HeapException

stopService

public void stopService(boolean removeFiles)
                 throws HeapException

Specified by:

stopService in interface IHeapDataManager

Throws:

HeapException

stopServiceImpl

protected abstract void stopServiceImpl(boolean removeFiles)
                                 throws HeapException

to implement close actions

Throws:

HeapException

isServiceStarted

public boolean isServiceStarted()

Specified by:

isServiceStarted in interface IHeapDataManager

Returns:

true if service started

clear

public void clear()
           throws HeapException

Description copied from interface: IHeapDataManager

clear the heap content.
service must be started.

Specified by:

clear in interface IHeapDataManager

Throws:

HeapException

clearImpl

protected abstract void clearImpl()
                           throws HeapException

Throws:

HeapException

flush

public void flush()
           throws HeapException

Description copied from interface: IHeapDataManager

flush creation, modification, and deletion to the heap
the heap is updated.
service must be started.

Specified by:

flush in interface IHeapDataManager

Throws:

HeapException

flushImp

protected abstract void flushImp()
                          throws HeapException

implement all flush action after call to #updateHeapRecordImpl(DataRecordIdentifier, IHeapDataRecord)

Throws:

HeapException

clearStandbyModification

public void clearStandbyModification()
                              throws HeapException

Description copied from interface: IHeapDataManager

clear creation, modification, and deletion to do on the heap.
the heap remains unchanged and modifications ares lost.
service must be started.

Specified by:

clearStandbyModification in interface IHeapDataManager

Throws:

HeapException

clearStandbyModificationImpl

protected abstract void clearStandbyModificationImpl()
                                              throws HeapException

Throws:

HeapException

getNextFreeDataRecordIdentifier

public DataRecordIdentifier getNextFreeDataRecordIdentifier()
                                                     throws HeapException

Description copied from interface: IHeapDataManager

get the next free data record identifier

Specified by:

getNextFreeDataRecordIdentifier in interface IHeapDataManager

Returns:

the next free data record identifier.
service must be started.

Throws:

HeapException

getNextFreeDataRecordIdentifierImpl

protected abstract DataRecordIdentifier getNextFreeDataRecordIdentifierImpl()
                                                                     throws HeapException

Throws:

HeapException

setNextFreeDataRecordIdentifier

public void setNextFreeDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                     throws HeapException

Description copied from interface: IHeapDataManager

set the next free data record identifier.
IHeapDataManager.flush() must be call to store the modification.
service must be started.

Specified by:

setNextFreeDataRecordIdentifier in interface IHeapDataManager

Parameters:

dataRecordIdentifier - the next free data record identifier

Throws:

HeapException

setNextFreeDataRecordIdentifierImpl

protected abstract void setNextFreeDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
                                                     throws HeapException

Throws:

HeapException

getNewDataRecordIdentifier

public DataRecordIdentifier getNewDataRecordIdentifier()
                                                throws HeapException

Description copied from interface: IHeapDataManager

to get a new data identifier for data record creation: return the next free data record identifier and internally increment the next free data record identifier
when created #readHeapDataRecord(DataRecordIdentifier) can be used for the data record identifier
IHeapDataManager.flush() must be call to store the modification.
service must be started.

Specified by:

getNewDataRecordIdentifier in interface IHeapDataManager

Returns:

a new data record identifier

Throws:

HeapException

getNewDataRecordIdentifierImpl

protected abstract DataRecordIdentifier getNewDataRecordIdentifierImpl()
                                                                throws HeapException

to get a new data identifier for future data record creation

Returns:

the new data record identifier

Throws:

HeapException

deleteDataRecord

public boolean deleteDataRecord(DataRecordIdentifier dataRecordIdentifier)
                         throws HeapException

Description copied from interface: IHeapDataManager

delete an existing data record knowing its identifier.
IHeapDataManager.flush() must be call to store the modification.
service must be started.

Specified by:

deleteDataRecord in interface IHeapDataManager

Parameters:

dataRecordIdentifier - data record to delete identifier

Returns:

true if record existed and then deleted

Throws:

HeapException

deleteDataRecordImpl

protected abstract boolean deleteDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
                                         throws HeapException

Throws:

HeapException

readDataRecord

public byte[] readDataRecord(DataRecordIdentifier dataRecordIdentifier)
                      throws HeapException

Description copied from interface: IHeapDataManager

read data for a data record.
service must be started.

Specified by:

readDataRecord in interface IHeapDataManager

Parameters:

dataRecordIdentifier - data record to read identifier

Returns:

the data of the record, null if no data record for identifier

Throws:

HeapException

readDataRecordImpl

protected abstract byte[] readDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
                                      throws HeapException

Throws:

HeapException

writeDataRecord

public boolean writeDataRecord(DataRecordIdentifier dataRecordIdentifier,
                      byte[] data)
                        throws HeapException

Description copied from interface: IHeapDataManager

write data record.
IHeapDataManager.flush() must be call to store the modification.
service must be started.

Specified by:

writeDataRecord in interface IHeapDataManager

Parameters:

dataRecordIdentifier - data record to write identifier

data - the data to write

Returns:

true if data record created

Throws:

HeapException

writeDataRecordImpl

protected abstract boolean writeDataRecordImpl(DataRecordIdentifier dataRecordIdentifier,
                          byte[] data)
                                        throws HeapException

Parameters:

dataRecordIdentifier -

data -

Returns:

true if data record created

Throws:

HeapException

hasDataRecord

public boolean hasDataRecord(DataRecordIdentifier dataRecordIdentifier)
                      throws HeapException

Description copied from interface: IHeapDataManager

to check if have data record for a data record identifier.
service must be started.

Specified by:

hasDataRecord in interface IHeapDataManager

Returns:

true if have data record for a data record identifier

Throws:

HeapException

hasDataRecordImpl

protected abstract boolean hasDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
                                      throws HeapException

Throws:

HeapException

firstDataRecordIdentifier

public DataRecordIdentifier firstDataRecordIdentifier()
                                               throws HeapException

Specified by:

firstDataRecordIdentifier in interface IHeapDataManager

Returns:

first data record identifier, null if none (heap empty)

Throws:

HeapException

firstDataRecordIdentifierImpl

protected DataRecordIdentifier firstDataRecordIdentifierImpl()
                                                      throws HeapException

Throws:

HeapException

nextDataRecordIdentifier

public DataRecordIdentifier nextDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                              throws HeapException

Specified by:

nextDataRecordIdentifier in interface IHeapDataManager

Parameters:

dataRecordIdentifier - wich for next is requested

Returns:

next data record identifier, null if none

Throws:

HeapException

nextDataRecordIdentifierImpl

protected DataRecordIdentifier nextDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
                                                     throws HeapException

Throws:

HeapException

lastDataRecordIdentifier

public DataRecordIdentifier lastDataRecordIdentifier()
                                              throws HeapException

Specified by:

lastDataRecordIdentifier in interface IHeapDataManager

Returns:

last data record identifier, null if none (heap empty)

Throws:

HeapException

lastDataRecordIdentifierImpl

protected DataRecordIdentifier lastDataRecordIdentifierImpl()
                                                     throws HeapException

Throws:

HeapException

lowerDataRecordIdentifier

public DataRecordIdentifier lowerDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                               throws HeapException

Specified by:

lowerDataRecordIdentifier in interface IHeapDataManager

Parameters:

dataRecordIdentifier - the key

Returns:

the greatest key strictly less than the given key, or null if there is no such key.

Throws:

HeapException

lowerDataRecordIdentifierImpl

protected DataRecordIdentifier lowerDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
                                                      throws HeapException

Throws:

HeapException

floorDataRecordIdentifier

public DataRecordIdentifier floorDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                               throws HeapException

Specified by:

floorDataRecordIdentifier in interface IHeapDataManager

Parameters:

dataRecordIdentifier - the key

Returns:

the greatest key less than or equal to key, or null if there is no such key

Throws:

HeapException

floorDataRecordIdentifierImpl

protected DataRecordIdentifier floorDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
                                                      throws HeapException

Throws:

HeapException

ceilingDataRecordIdentifier

public DataRecordIdentifier ceilingDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                                 throws HeapException

Specified by:

ceilingDataRecordIdentifier in interface IHeapDataManager

Parameters:

dataRecordIdentifier - the key

Returns:

a key with the least key greater than or equal to key, or null if there is no such key

Throws:

HeapException

ceilingDataRecordIdentifierImpl

protected DataRecordIdentifier ceilingDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
                                                        throws HeapException

Throws:

HeapException

higherDataRecordIdentifier

public DataRecordIdentifier higherDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                                throws HeapException

Specified by:

higherDataRecordIdentifier in interface IHeapDataManager

Parameters:

dataRecordIdentifier - the key

Returns:

the least key greater than key, or null if there is no such key

Throws:

HeapException

higherDataRecordIdentifierImpl

protected DataRecordIdentifier higherDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
                                                       throws HeapException

Throws:

HeapException

removeFirstDataRecord

public DataRecordIdentifier removeFirstDataRecord()
                                           throws HeapException

Description copied from interface: IHeapDataManager

remove first data record and return its data record identifier.
IHeapDataManager.flush() must be call to store the modification.
service must be started.

Specified by:

removeFirstDataRecord in interface IHeapDataManager

Returns:

data record identifier of first data record removed

Throws:

HeapException

removeFirstDataRecordImpl

protected abstract DataRecordIdentifier removeFirstDataRecordImpl()
                                                           throws HeapException

Throws:

HeapException

getNumberOfDataRecord

public int getNumberOfDataRecord()
                          throws HeapException

Description copied from interface: IHeapDataManager

get number of data record in heap file.
service must be started.

Specified by:

getNumberOfDataRecord in interface IHeapDataManager

Returns:

number of data record in heap file

Throws:

HeapException

getNumberOfDataRecordImpl

protected abstract int getNumberOfDataRecordImpl()
                                          throws HeapException

Returns:

number of data record in heap file

Throws:

HeapException

getNumberOfFreeRecord

public int getNumberOfFreeRecord()
                          throws HeapException

Description copied from interface: IHeapDataManager

get number of free record in heap file.
service must be started.

Specified by:

getNumberOfFreeRecord in interface IHeapDataManager

Returns:

number of free record in heap file

Throws:

HeapException

getNumberOfFreeRecordImpl

protected abstract int getNumberOfFreeRecordImpl()
                                          throws HeapException

Throws:

HeapException

heapSize

public long heapSize()
              throws HeapException

Description copied from interface: IHeapDataManager

get heap total size in bytes.
service must be started.

Specified by:

heapSize in interface IHeapDataManager

Returns:

heap total size in bytes

Throws:

HeapException

heapSizeImpl

protected abstract long heapSizeImpl()
                              throws HeapException

Throws:

HeapException

freeSize

public long freeSize()
              throws HeapException

Description copied from interface: IHeapDataManager

get heap total free size in bytes.
service must be started.

Specified by:

freeSize in interface IHeapDataManager

Returns:

heap total free size in bytes

Throws:

HeapException

freeSizeImpl

protected abstract long freeSizeImpl()
                              throws HeapException

Throws:

HeapException

usedSize

public long usedSize()
              throws HeapException

Description copied from interface: IHeapDataManager

get heap total used size in bytes.
service must be started.

Specified by:

usedSize in interface IHeapDataManager

Returns:

heap total used size in bytes

Throws:

HeapException

usedSizeImpl

protected abstract long usedSizeImpl()
                              throws HeapException

Throws:

HeapException

closeHeapManagerAfterException

protected abstract void closeHeapManagerAfterException()

close heap element manager after exception

getDataRecordIdentifierSet

@Fortest
public Set<DataRecordIdentifier> getDataRecordIdentifierSet()
                                                     throws HeapException

Description copied from interface: IHeapDataManager

for test purpose

Specified by:

getDataRecordIdentifierSet in interface IHeapDataManager

Returns:

all data record identifier

Throws:

HeapException

getDataRecordIdentifierSetImpl

@Fortest
protected abstract Set<DataRecordIdentifier> getDataRecordIdentifierSetImpl()
                                                                     throws HeapException

Throws:

HeapException

dataRecordIterator

public Iterator<DataRecordIdentifier> dataRecordIterator()
                                                  throws HeapException

Specified by:

dataRecordIterator in interface IHeapDataManager

Returns:

iterator on all data record identifier

Throws:

HeapException

dataRecordIteratorImpl

protected abstract Iterator<DataRecordIdentifier> dataRecordIteratorImpl()
                                                                  throws HeapException

Throws:

HeapException