net.sf.joafip.heapfile.record.entity

Class HeapHeader

java.lang.Object

net.sf.joafip.kvstore.entity.AbstractFileStorable

net.sf.joafip.heapfile.record.entity.HeapHeader

All Implemented Interfaces:

IFileStorable

@NotStorableClass
public class HeapHeader
extends AbstractFileStorable

heap file header data

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEAP_HEADER_SIZE size of the header in heap file 8 for freeRootNodeFilePosition 8 for idRootNodeFilePosition 8 for lastRecordPositionInFile 8 for endOfRecordPositionInFile 8 for usedSize 8 for freeSize 8 for next data record identifier 4 for crc32

Fields inherited from class net.sf.joafip.kvstore.entity.AbstractFileStorable

fileForStorable, justCreated, logger, numberOfByteReadWrote, positionInFile, valueChangedToSave

Constructor Summary

Constructors

Constructor and Description
HeapHeader(IHeapElementManager heapElementManager) construct header for reading in heap file or for an empty heap

Method Summary

Methods

Modifier and Type	Method and Description
void	addFreeSize(int newFreeAreaSize) when an area is freed add to free and substract from used
void	addUsedSize(int newUsedAreaSize) when a new used area is addes when add to used
void	clear() initial state:no value to save since not read and not write
boolean	equals(Object obj)
long	getEndOfRecordPositionInFile() end of record position in file, , the position of byte after last record
long	getFreeRootNodeFilePosition()
long	getFreeSize()
long	getIdRootNodeFilePosition()
long	getLastRecordPositionInFile()
long	getNextDataRecordIdentifier()
long	getPreviousRecordPositionInFile()
int	getRecordSize() get the record size
long	getUsedSize()
protected void	marshallImpl() marshaling implementation for write #crc32 is set to zero
void	setEndOfRecordPositionInFile(long endOfRecordPositionInFile)
void	setFreeRootNodeFilePosition(long freeRootNodeFilePosition)
void	setIdRootNodeFilePosition(long idRootNodeFilePosition)
void	setLastRecordPositionInFile(long lastRecordPositionInFile)
void	setNextDataRecordIdentifier(DataRecordIdentifier nextDataRecordIdentifier)
void	setNextDataRecordIdentifier(long value)
protected int	toMarshallSize()
String	toString()
void	unfreeSize(int areaSize) when area is unfreed add to used and substract from free
protected void	unmarshallImpl() Unmarshalling implementation for read #crc32 is set to zero
protected void	valueChangedAction()

Methods inherited from class net.sf.joafip.kvstore.entity.AbstractFileStorable

getPositionInFile, hashCode, isJustCreated, isValueChangedToSave, readAndCheckCrc32, readBoolean, readByte, readBytes, readBytes, readFileAppendToIoBuffer, readFileToIoBuffer, readFromFile, readInteger, readLong, setValueIsChangedValueToSave, setValueIsNotChanged, writeBoolean, writeByte, writeBytes, writeCrc32, writeInteger, writeLong, writeToFile, writeToFileGetWrited

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HEAP_HEADER_SIZE

public static final int HEAP_HEADER_SIZE

size of the header in heap file
8 for freeRootNodeFilePosition
8 for idRootNodeFilePosition
8 for lastRecordPositionInFile
8 for endOfRecordPositionInFile
8 for usedSize
8 for freeSize
8 for next data record identifier
4 for crc32

See Also:

Constant Field Values

Constructor Detail

HeapHeader

public HeapHeader(IHeapElementManager heapElementManager)

construct header for reading in heap file or for an empty heap

Method Detail

getPreviousRecordPositionInFile

public long getPreviousRecordPositionInFile()
                                     throws HeapException

Returns:

previous record position in file, -1 if no previous record (this is the first)

Throws:

HeapException

getRecordSize

public int getRecordSize()
                  throws HeapException

Description copied from interface: IFileStorable

get the record size

Returns:

the record size

Throws:

HeapException

valueChangedAction

protected void valueChangedAction()
                           throws HeapException

Specified by:

valueChangedAction in class AbstractFileStorable

Throws:

HeapException

setFreeRootNodeFilePosition

public void setFreeRootNodeFilePosition(long freeRootNodeFilePosition)
                                 throws HeapException

Throws:

HeapException

getFreeRootNodeFilePosition

public long getFreeRootNodeFilePosition()

setIdRootNodeFilePosition

public void setIdRootNodeFilePosition(long idRootNodeFilePosition)
                               throws HeapException

Throws:

HeapException

getIdRootNodeFilePosition

public long getIdRootNodeFilePosition()

getLastRecordPositionInFile

public long getLastRecordPositionInFile()

setLastRecordPositionInFile

public void setLastRecordPositionInFile(long lastRecordPositionInFile)
                                 throws HeapException

Throws:

HeapException

getEndOfRecordPositionInFile

public long getEndOfRecordPositionInFile()

end of record position in file, , the position of byte after last record

Returns:

end of record position in file

setEndOfRecordPositionInFile

public void setEndOfRecordPositionInFile(long endOfRecordPositionInFile)
                                  throws HeapException

Throws:

HeapException

getNextDataRecordIdentifier

public long getNextDataRecordIdentifier()

setNextDataRecordIdentifier

public void setNextDataRecordIdentifier(DataRecordIdentifier nextDataRecordIdentifier)
                                 throws HeapException

Throws:

HeapException

setNextDataRecordIdentifier

public void setNextDataRecordIdentifier(long value)
                                 throws HeapException

Throws:

HeapException

toMarshallSize

protected int toMarshallSize()

Specified by:

toMarshallSize in class AbstractFileStorable

Returns:

number of byte to marshal

marshallImpl

protected void marshallImpl()
                     throws HeapException

Description copied from class: AbstractFileStorable

marshaling implementation for write
#crc32 is set to zero

Specified by:

marshallImpl in class AbstractFileStorable

Throws:

HeapException

unmarshallImpl

protected void unmarshallImpl()
                       throws HeapException

Description copied from class: AbstractFileStorable

Unmarshalling implementation for read
#crc32 is set to zero

Specified by:

unmarshallImpl in class AbstractFileStorable

Throws:

HeapException

addUsedSize

public void addUsedSize(int newUsedAreaSize)
                 throws HeapException

when a new used area is addes when add to used

Parameters:

newUsedAreaSize - to add used area size

Throws:

HeapException

unfreeSize

public void unfreeSize(int areaSize)
                throws HeapException

when area is unfreed add to used and substract from free

Parameters:

areaSize - to add to used size and substract to free size

Throws:

HeapException

addFreeSize

public void addFreeSize(int newFreeAreaSize)
                 throws HeapException

when an area is freed add to free and substract from used

Parameters:

newFreeAreaSize - to substract to used size and add to free size

Throws:

HeapException

getFreeSize

public long getFreeSize()

Returns:

total free area size in bytes

getUsedSize

public long getUsedSize()

Returns:

total used for data size

clear

public void clear()

Description copied from interface: IFileStorable

initial state:no value to save since not read and not write

Specified by:

clear in interface IFileStorable

Overrides:

clear in class AbstractFileStorable

toString

public String toString()

Overrides:

toString in class AbstractFileStorable

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractFileStorable