net.sf.joafip.kvstore.service

Interface IHeapDataManager

All Known Implementing Classes:

AbstractHeapDataManager, AutoSaveHeapFileDataManager, BtreePlusDataManager, HeapFileDataManager

public interface IHeapDataManager

data management on heap file

• start the heap data manager
• create a new data record on the heap
• read existing data record from the heap
• delete existing data record from the heap
• flush modification ( create,modification,delete) on the heap file
• stop the heap data manager ( do a flush )

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
String	backup(long identifier, int maxBackup)
DataRecordIdentifier	ceilingDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
void	clear() clear the heap content.
void	clearStandbyModification() clear creation, modification, and deletion to do on the heap.
Iterator<DataRecordIdentifier>	dataRecordIterator()
boolean	deleteDataRecord(DataRecordIdentifier dataRecordIdentifier) delete an existing data record knowing its identifier.
DataRecordIdentifier	firstDataRecordIdentifier()
DataRecordIdentifier	floorDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
void	flush() flush creation, modification, and deletion to the heap the heap is updated.
long	freeSize() get heap total free size in bytes.
Set<DataRecordIdentifier>	getDataRecordIdentifierSet() for test purpose
long	getLastRecordPositionInFile() for test purpose
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 flush() must be call to store the modification.
DataRecordIdentifier	getNextFreeDataRecordIdentifier() get the next free data record identifier
int	getNumberOfDataRecord() get number of data record in heap file.
int	getNumberOfFreeRecord() get number of free record in heap file.
long	getRecordPositionInfile(DataRecordIdentifier identifier) for test purpose
String	getStorageFileName()
boolean	hasDataRecord(DataRecordIdentifier dataRecordIdentifier) to check if have data record for a data record identifier.
long	heapSize() get heap total size in bytes.
DataRecordIdentifier	higherDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
boolean	isDataLost() return true if data lost after file stable state reconstruction.
boolean	isServiceStarted()
DataRecordIdentifier	lastDataRecordIdentifier()
DataRecordIdentifier	lowerDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
DataRecordIdentifier	nextDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
byte[]	readDataRecord(DataRecordIdentifier dataRecordIdentifier) read data for a data record.
DataRecordIdentifier	removeFirstDataRecord() remove first data record and return its data record identifier.
void	setDataRecordKeyManager(IDataRecordKeyManager dataRecordKeyComparator)
void	setNextFreeDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier) set the next free data record identifier.
void	startService(boolean removeFiles) start heap data manager service.
void	stopService() stop heap data manager service, do not flush in file any modification.
void	stopService(boolean removeFiles)
long	usedSize() get heap total used size in bytes.
boolean	writeDataRecord(DataRecordIdentifier dataRecordIdentifier, byte[] data) write data record.

Method Detail

isDataLost

boolean isDataLost()

return true if data lost after file stable state reconstruction.
this check is done at heap data file construction

Returns:

true if data lost after file stable state reconstruction

startService

void startService(boolean removeFiles)
                  throws HeapException

start heap data manager service.

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

stopService

void stopService()
                 throws HeapException

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

Throws:

HeapException

stopService

void stopService(boolean removeFiles)
                 throws HeapException

Throws:

HeapException

isServiceStarted

boolean isServiceStarted()

Returns:

true if service started

clear

void clear()
           throws HeapException

clear the heap content.
service must be started.

Throws:

HeapException

getNextFreeDataRecordIdentifier

DataRecordIdentifier getNextFreeDataRecordIdentifier()
                                                     throws HeapException

get the next free data record identifier

Returns:

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

Throws:

HeapException

setNextFreeDataRecordIdentifier

void setNextFreeDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                     throws HeapException

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

Parameters:

dataRecordIdentifier - the next free data record identifier

Throws:

HeapException

getNewDataRecordIdentifier

DataRecordIdentifier getNewDataRecordIdentifier()
                                                throws HeapException

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
flush() must be call to store the modification.
service must be started.

Returns:

a new data record identifier

Throws:

HeapException

hasDataRecord

boolean hasDataRecord(DataRecordIdentifier dataRecordIdentifier)
                      throws HeapException

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

Parameters:

nodeIdentifier - the data record identifier

Returns:

true if have data record for a data record identifier

Throws:

HeapException

readDataRecord

byte[] readDataRecord(DataRecordIdentifier dataRecordIdentifier)
                      throws HeapException

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

Parameters:

dataRecordIdentifier - data record to read identifier

Returns:

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

Throws:

HeapException

writeDataRecord

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

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

Parameters:

dataRecordIdentifier - data record to write identifier

data - the data to write

Returns:

true if data record created

Throws:

HeapException

deleteDataRecord

boolean deleteDataRecord(DataRecordIdentifier dataRecordIdentifier)
                         throws HeapException

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

Parameters:

dataRecordIdentifier - data record to delete identifier

Returns:

true if record existed and then deleted

Throws:

HeapException

firstDataRecordIdentifier

DataRecordIdentifier firstDataRecordIdentifier()
                                               throws HeapException

Returns:

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

Throws:

HeapException

nextDataRecordIdentifier

DataRecordIdentifier nextDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                              throws HeapException

Parameters:

dataRecordIdentifier - wich for next is requested

Returns:

next data record identifier, null if none

Throws:

HeapException

lastDataRecordIdentifier

DataRecordIdentifier lastDataRecordIdentifier()
                                              throws HeapException

Returns:

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

Throws:

HeapException

lowerDataRecordIdentifier

DataRecordIdentifier lowerDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                               throws HeapException

Parameters:

dataRecordIdentifier - the key

Returns:

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

Throws:

HeapException

floorDataRecordIdentifier

DataRecordIdentifier floorDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                               throws HeapException

Parameters:

dataRecordIdentifier - the key

Returns:

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

Throws:

HeapException

ceilingDataRecordIdentifier

DataRecordIdentifier ceilingDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                                 throws HeapException

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

higherDataRecordIdentifier

DataRecordIdentifier higherDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                                throws HeapException

Parameters:

dataRecordIdentifier - the key

Returns:

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

Throws:

HeapException

removeFirstDataRecord

DataRecordIdentifier removeFirstDataRecord()
                                           throws HeapException

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

Returns:

data record identifier of first data record removed

Throws:

HeapException

flush

void flush()
           throws HeapException

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

Throws:

HeapException

clearStandbyModification

void clearStandbyModification()
                              throws HeapException

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

Throws:

HeapException

setDataRecordKeyManager

void setDataRecordKeyManager(IDataRecordKeyManager dataRecordKeyComparator)
                             throws HeapException

Throws:

HeapException

getNumberOfDataRecord

int getNumberOfDataRecord()
                          throws HeapException

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

Returns:

number of data record in heap file

Throws:

HeapException

getNumberOfFreeRecord

int getNumberOfFreeRecord()
                          throws HeapException

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

Returns:

number of free record in heap file

Throws:

HeapException

heapSize

long heapSize()
              throws HeapException

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

Returns:

heap total size in bytes

Throws:

HeapException

freeSize

long freeSize()
              throws HeapException

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

Returns:

heap total free size in bytes

Throws:

HeapException

usedSize

long usedSize()
              throws HeapException

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

Returns:

heap total used size in bytes

Throws:

HeapException

backup

String backup(long identifier,
            int maxBackup)
              throws HeapException

Throws:

HeapException

getStorageFileName

String getStorageFileName()
                          throws HeapException

Returns:

data storage file name

Throws:

HeapException

getDataRecordIdentifierSet

@Fortest
Set<DataRecordIdentifier> getDataRecordIdentifierSet()
                                                     throws HeapException

for test purpose

Returns:

all data record identifier

Throws:

HeapException

dataRecordIterator

Iterator<DataRecordIdentifier> dataRecordIterator()
                                                  throws HeapException

Returns:

iterator on all data record identifier

Throws:

HeapException

getRecordPositionInfile

@Fortest
long getRecordPositionInfile(DataRecordIdentifier identifier)
                             throws HeapException

for test purpose

Parameters:

identifier -

Returns:

Throws:

HeapException

getLastRecordPositionInFile

@Fortest
long getLastRecordPositionInFile()
                                 throws HeapException

for test purpose

Returns:

Throws:

HeapException