net.sf.joafip.kvstore.record.service

Interface IHeapElementManager

All Known Implementing Classes:

HeapElementManager

public interface IHeapElementManager

Heap elements manager in heap file interface.
elements are one header and the heap records
heap element are heap header, heap record, and data block
make able to get the heap element for read and possible modification
the closing save the header and records modification

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
void	appendHeapFileRecord(IFileStorable heapRecord) append an heap file record that will be to write in file
String	backup(long identifier, int maxBackup)
void	clear() clear heap content service must be started and transaction opened
void	clearReadCache()
void	closeTransaction() close the heap file transaction management committing the modifications to the file before
void	closeTransactionDiscardChange() close the heap file transaction management without commit modification in file
void	delete(long positionInFile)
IDataRecordKeyManager	getDataRecordKeyManager()
IFileForStorable	getFileForStorable()
long	getFileSize()
IFileStorable	getHeapHeader()
IHeapRecordFactory	getHeapRecordFactory()
int	getNumberOfHeaprecordInMemory()
boolean	isCrashSafeMode()
boolean	isDataLost() the returned value is set by wasBadFileStableState()
boolean	isServiceStarted()
boolean	isTransactionOpened()
void	openTransaction() open the heap file transaction management
IFileStorable	readHeapFileDataRecord(long positionInFile) read heap record in file
void	removeFiles() removes files containing heap data transaction must be closed and service stopped
void	setDataRecordKeyManager(IDataRecordKeyManager dataRecordKeyManager)
void	setHeapHeader(IFileStorable heapHeader) set heap header
void	setHeapRecordFactory(IHeapRecordFactory heapRecordFactory)
void	startService() start heap record management service
void	stopService() stop heap record management service
boolean	wasBadFileStableState() check file stable state, restore if possible service must not be started must be called before heap file access

Method Detail

setHeapHeader

void setHeapHeader(IFileStorable heapHeader)
                   throws HeapException

set heap header

Parameters:

heapHeader -

Throws:

HeapException

isCrashSafeMode

boolean isCrashSafeMode()

getFileForStorable

IFileForStorable getFileForStorable()

Returns:

file used by heap element manager

wasBadFileStableState

boolean wasBadFileStableState()
                              throws HeapException

check file stable state, restore if possible
service must not be started
must be called before heap file access

Returns:

true if file restored ( from backup to data or data to backup )

Throws:

HeapException - no file in stable state, no files in stable state

isDataLost

boolean isDataLost()

the returned value is set by wasBadFileStableState()

Returns:

true if data loose detected by wasBadFileStableState()

removeFiles

void removeFiles()
                 throws HeapException

removes files containing heap data
transaction must be closed and service stopped

Throws:

HeapException

startService

void startService()
                  throws HeapException

start heap record management service

Throws:

HeapException - file access error file data corrupted

stopService

void stopService()
                 throws HeapException

stop heap record management service

Throws:

HeapException

isServiceStarted

boolean isServiceStarted()

Returns:

true if heap file management service is started

openTransaction

void openTransaction()
                     throws HeapException

open the heap file transaction management

Throws:

HeapException

closeTransaction

void closeTransaction()
                      throws HeapException

close the heap file transaction management committing the modifications to the file before

Throws:

HeapException

closeTransactionDiscardChange

void closeTransactionDiscardChange()
                                   throws HeapException

close the heap file transaction management without commit modification in file

Throws:

HeapException

isTransactionOpened

boolean isTransactionOpened()

Returns:

true if heap file transaction opened

clear

void clear()
           throws HeapException

clear heap content
service must be started and transaction opened

Throws:

HeapException

getHeapHeader

IFileStorable getHeapHeader()
                            throws HeapException

Returns:

the heap header in file

Throws:

HeapException

readHeapFileDataRecord

IFileStorable readHeapFileDataRecord(long positionInFile)
                                     throws HeapException

read heap record in file

Parameters:

positionInFile - heap record position in file

Returns:

heap file record

Throws:

HeapException

appendHeapFileRecord

void appendHeapFileRecord(IFileStorable heapRecord)
                          throws HeapException

append an heap file record that will be to write in file

Parameters:

heapRecord - the heap file record to append

Throws:

HeapException

delete

void delete(long positionInFile)
            throws HeapException

Parameters:

positionInFile -

Throws:

HeapException

getFileSize

long getFileSize()
                 throws HeapException

Returns:

file for storage size

Throws:

HeapException

getNumberOfHeaprecordInMemory

int getNumberOfHeaprecordInMemory()

setHeapRecordFactory

void setHeapRecordFactory(IHeapRecordFactory heapRecordFactory)

getHeapRecordFactory

IHeapRecordFactory getHeapRecordFactory()

setDataRecordKeyManager

void setDataRecordKeyManager(IDataRecordKeyManager dataRecordKeyManager)

getDataRecordKeyManager

IDataRecordKeyManager getDataRecordKeyManager()

backup

String backup(long identifier,
            int maxBackup)
              throws HeapException

Throws:

HeapException

clearReadCache

void clearReadCache()