net.sf.joafip.heapfile.service

Class HeapFileDataManager

java.lang.Object

net.sf.joafip.kvstore.service.AbstractHeapDataManager

net.sf.joafip.heapfile.service.HeapFileDataManager

All Implemented Interfaces:

Serializable, IHeapRecordFactory, IHeapDataManager

Direct Known Subclasses:

AutoSaveHeapFileDataManager

@NotStorableClass
public class HeapFileDataManager
extends AbstractHeapDataManager
implements IHeapRecordFactory

Data management on heap file implementation

Author:

luc peuvrier

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IHeapElementManager	heapElementManager the heap element manager, data record are accessible by position in file

Fields inherited from class net.sf.joafip.kvstore.service.AbstractHeapDataManager

CLEAR_STANDBY_MODIFICATION_FAILED, FAILED_READ_DATA_RECORD, FLUSH_FAILED, logger

Constructor Summary

Constructors

Constructor and Description
HeapFileDataManager(HeapFileSetup setup, boolean manageNodeIndex)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(IRBTVisitor<DataRecordIdentifier> visitor)
String	backup(long identifier, int maxBackup)
protected DataRecordIdentifier	ceilingDataRecordIdentifierImpl(DataRecordIdentifier identifier)
protected void	clearImpl()
protected void	clearStandbyModificationImpl()
protected void	closeHeapManagerAfterException() close heap element manager after exception
IFileStorable	createHeapRecord(IHeapElementManager heapElementManager, long positionInFile) creation for reading
protected Iterator<DataRecordIdentifier>	dataRecordIteratorImpl()
boolean	deleteDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
protected DataRecordIdentifier	firstDataRecordIdentifierImpl()
protected DataRecordIdentifier	floorDataRecordIdentifierImpl(DataRecordIdentifier identifier)
protected void	flushImp() implement all flush action after call to #updateHeapRecordImpl(DataRecordIdentifier, IHeapDataRecord)
protected long	freeSizeImpl()
protected Set<DataRecordIdentifier>	getDataRecordIdentifierSetImpl()
RedBlackTree<Integer>	getFreeNodeTree()
IHeapElementManager	getHeapElementManager()
RedBlackTree<DataRecordIdentifier>	getIdNodeTree()
long	getLastRecordPositionInFile() for test purpose
protected DataRecordIdentifier	getNewDataRecordIdentifierImpl() to get a new data identifier for future data record creation
protected DataRecordIdentifier	getNextFreeDataRecordIdentifierImpl()
protected int	getNumberOfDataRecordImpl()
protected int	getNumberOfFreeRecordImpl()
long	getRecordPositionInfile(DataRecordIdentifier identifier) for test purpose
String	getStorageFileName()
protected boolean	hasDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
protected long	heapSizeImpl()
protected DataRecordIdentifier	higherDataRecordIdentifierImpl(DataRecordIdentifier identifier)
boolean	isDataLost() return true if data lost after file stable state reconstruction.
protected DataRecordIdentifier	lastDataRecordIdentifierImpl()
protected DataRecordIdentifier	lowerDataRecordIdentifierImpl(DataRecordIdentifier identifier)
DataRecordIdentifier	nextDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
byte[]	readDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
protected void	removeFiles() remove existing files
protected DataRecordIdentifier	removeFirstDataRecordImpl()
void	setDataRecordKeyManager(IDataRecordKeyManager dataRecordKeyComparator)
protected void	setNextFreeDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
protected void	startServiceImpl(boolean removeFiles) to implement open actions
protected void	stopServiceImpl(boolean removeFiles) to implement close actions
protected long	usedSizeImpl()
boolean	writeDataRecordImpl(DataRecordIdentifier dataRecordIdentifier, byte[] data)

Methods inherited from class net.sf.joafip.kvstore.service.AbstractHeapDataManager

ceilingDataRecordIdentifier, clear, clearStandbyModification, dataRecordIterator, deleteDataRecord, firstDataRecordIdentifier, floorDataRecordIdentifier, flush, freeSize, getDataRecordIdentifierSet, getNewDataRecordIdentifier, getNextFreeDataRecordIdentifier, getNumberOfDataRecord, getNumberOfFreeRecord, hasDataRecord, heapSize, higherDataRecordIdentifier, isServiceStarted, lastDataRecordIdentifier, lowerDataRecordIdentifier, nextDataRecordIdentifierImpl, readDataRecord, removeFirstDataRecord, setNextFreeDataRecordIdentifier, startService, stopService, stopService, usedSize, writeDataRecord

Methods inherited from class java.lang.Object

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

Field Detail

heapElementManager

protected final IHeapElementManager heapElementManager

the heap element manager, data record are accessible by position in file

Constructor Detail

HeapFileDataManager

public HeapFileDataManager(HeapFileSetup setup,
                   boolean manageNodeIndex)
                    throws HeapException

Throws:

HeapException

Method Detail

startServiceImpl

protected final void startServiceImpl(boolean removeFiles)
                               throws HeapException

Description copied from class: AbstractHeapDataManager

to implement open actions

Specified by:

startServiceImpl in class AbstractHeapDataManager

Throws:

HeapException

clearImpl

protected void clearImpl()
                  throws HeapException

Specified by:

clearImpl in class AbstractHeapDataManager

Throws:

HeapException

removeFiles

protected void removeFiles()
                    throws HeapException

Description copied from class: AbstractHeapDataManager

remove existing files

Specified by:

removeFiles in class AbstractHeapDataManager

Throws:

HeapException

stopServiceImpl

protected void stopServiceImpl(boolean removeFiles)
                        throws HeapException

Description copied from class: AbstractHeapDataManager

to implement close actions

Specified by:

stopServiceImpl in class AbstractHeapDataManager

Throws:

HeapException

writeDataRecordImpl

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

Specified by:

writeDataRecordImpl in class AbstractHeapDataManager

Returns:

true if data record created

Throws:

HeapException

deleteDataRecordImpl

public boolean deleteDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
                             throws HeapException

Specified by:

deleteDataRecordImpl in class AbstractHeapDataManager

Throws:

HeapException

flushImp

protected void flushImp()
                 throws HeapException

Description copied from class: AbstractHeapDataManager

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

Specified by:

flushImp in class AbstractHeapDataManager

Throws:

HeapException

clearStandbyModificationImpl

protected void clearStandbyModificationImpl()
                                     throws HeapException

Specified by:

clearStandbyModificationImpl in class AbstractHeapDataManager

Throws:

HeapException

getNextFreeDataRecordIdentifierImpl

protected DataRecordIdentifier getNextFreeDataRecordIdentifierImpl()
                                                            throws HeapException

Specified by:

getNextFreeDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

setNextFreeDataRecordIdentifierImpl

protected void setNextFreeDataRecordIdentifierImpl(DataRecordIdentifier dataRecordIdentifier)
                                            throws HeapException

Specified by:

setNextFreeDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

getNewDataRecordIdentifierImpl

protected DataRecordIdentifier getNewDataRecordIdentifierImpl()
                                                       throws HeapException

Description copied from class: AbstractHeapDataManager

to get a new data identifier for future data record creation

Specified by:

getNewDataRecordIdentifierImpl in class AbstractHeapDataManager

Returns:

the new data record identifier

Throws:

HeapException

removeFirstDataRecordImpl

protected DataRecordIdentifier removeFirstDataRecordImpl()
                                                  throws HeapException

Specified by:

removeFirstDataRecordImpl in class AbstractHeapDataManager

Throws:

HeapException

readDataRecordImpl

public byte[] readDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
                          throws HeapException

Specified by:

readDataRecordImpl in class AbstractHeapDataManager

Throws:

HeapException

createHeapRecord

public IFileStorable createHeapRecord(IHeapElementManager heapElementManager,
                             long positionInFile)
                               throws HeapException

Description copied from interface: IHeapRecordFactory

creation for reading

Specified by:

createHeapRecord in interface IHeapRecordFactory

Returns:

Throws:

HeapException

hasDataRecordImpl

protected boolean hasDataRecordImpl(DataRecordIdentifier dataRecordIdentifier)
                             throws HeapException

Specified by:

hasDataRecordImpl in class AbstractHeapDataManager

Throws:

HeapException

firstDataRecordIdentifierImpl

protected DataRecordIdentifier firstDataRecordIdentifierImpl()
                                                      throws HeapException

Overrides:

firstDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

nextDataRecordIdentifier

public DataRecordIdentifier nextDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier)
                                              throws HeapException

Specified by:

nextDataRecordIdentifier in interface IHeapDataManager

Overrides:

nextDataRecordIdentifier in class AbstractHeapDataManager

Parameters:

dataRecordIdentifier - wich for next is requested

Returns:

next data record identifier, null if none

Throws:

HeapException

lastDataRecordIdentifierImpl

protected DataRecordIdentifier lastDataRecordIdentifierImpl()
                                                     throws HeapException

Overrides:

lastDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

lowerDataRecordIdentifierImpl

protected DataRecordIdentifier lowerDataRecordIdentifierImpl(DataRecordIdentifier identifier)
                                                      throws HeapException

Overrides:

lowerDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

floorDataRecordIdentifierImpl

protected DataRecordIdentifier floorDataRecordIdentifierImpl(DataRecordIdentifier identifier)
                                                      throws HeapException

Overrides:

floorDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

ceilingDataRecordIdentifierImpl

protected DataRecordIdentifier ceilingDataRecordIdentifierImpl(DataRecordIdentifier identifier)
                                                        throws HeapException

Overrides:

ceilingDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

higherDataRecordIdentifierImpl

protected DataRecordIdentifier higherDataRecordIdentifierImpl(DataRecordIdentifier identifier)
                                                       throws HeapException

Overrides:

higherDataRecordIdentifierImpl in class AbstractHeapDataManager

Throws:

HeapException

closeHeapManagerAfterException

protected void closeHeapManagerAfterException()

Description copied from class: AbstractHeapDataManager

close heap element manager after exception

Specified by:

closeHeapManagerAfterException in class AbstractHeapDataManager

isDataLost

public boolean isDataLost()

Description copied from interface: IHeapDataManager

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

Specified by:

isDataLost in interface IHeapDataManager

Returns:

true if data lost after file stable state reconstruction

getDataRecordIdentifierSetImpl

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

Specified by:

getDataRecordIdentifierSetImpl in class AbstractHeapDataManager

Throws:

HeapException

getNumberOfDataRecordImpl

protected int getNumberOfDataRecordImpl()
                                 throws HeapException

Specified by:

getNumberOfDataRecordImpl in class AbstractHeapDataManager

Returns:

number of data record in heap file

Throws:

HeapException

getNumberOfFreeRecordImpl

protected int getNumberOfFreeRecordImpl()
                                 throws HeapException

Specified by:

getNumberOfFreeRecordImpl in class AbstractHeapDataManager

Throws:

HeapException

heapSizeImpl

protected long heapSizeImpl()
                     throws HeapException

Specified by:

heapSizeImpl in class AbstractHeapDataManager

Throws:

HeapException

freeSizeImpl

protected long freeSizeImpl()
                     throws HeapException

Specified by:

freeSizeImpl in class AbstractHeapDataManager

Throws:

HeapException

usedSizeImpl

protected long usedSizeImpl()
                     throws HeapException

Specified by:

usedSizeImpl in class AbstractHeapDataManager

Throws:

HeapException

backup

public String backup(long identifier,
            int maxBackup)
              throws HeapException

Specified by:

backup in interface IHeapDataManager

Throws:

HeapException

getStorageFileName

public String getStorageFileName()
                          throws HeapException

Specified by:

getStorageFileName in interface IHeapDataManager

Returns:

data storage file name

Throws:

HeapException

dataRecordIteratorImpl

protected Iterator<DataRecordIdentifier> dataRecordIteratorImpl()

Specified by:

dataRecordIteratorImpl in class AbstractHeapDataManager

setDataRecordKeyManager

public void setDataRecordKeyManager(IDataRecordKeyManager dataRecordKeyComparator)

Specified by:

setDataRecordKeyManager in interface IHeapDataManager

getLastRecordPositionInFile

@Fortest
public long getLastRecordPositionInFile()
                                 throws HeapException

Description copied from interface: IHeapDataManager

for test purpose

Specified by:

getLastRecordPositionInFile in interface IHeapDataManager

Returns:

last record in file position

Throws:

HeapException

getRecordPositionInfile

@Fortest
public long getRecordPositionInfile(DataRecordIdentifier identifier)
                             throws HeapException

Description copied from interface: IHeapDataManager

for test purpose

Specified by:

getRecordPositionInfile in interface IHeapDataManager

Returns:

Throws:

HeapException

accept

@Fortest
public void accept(IRBTVisitor<DataRecordIdentifier> visitor)
            throws HeapException

Parameters:

visitor -

Throws:

HeapException

getHeapElementManager

@Fortest
public IHeapElementManager getHeapElementManager()

getFreeNodeTree

@Fortest
public RedBlackTree<Integer> getFreeNodeTree()

getIdNodeTree

@Fortest
public RedBlackTree<DataRecordIdentifier> getIdNodeTree()