net.sf.joafip.btreeplus.entity

Class HeaderPage

java.lang.Object

net.sf.joafip.kvstore.entity.AbstractFileStorable

net.sf.joafip.btreeplus.entity.AbstractPageRecord

net.sf.joafip.btreeplus.entity.HeaderPage

All Implemented Interfaces:

IPageRecordable, IStateStored, IFileStorable

@NotStorableClass
public class HeaderPage
extends AbstractPageRecord
implements IPageRecordable

Author:

luc peuvrier

Field Summary

Fields inherited from class net.sf.joafip.btreeplus.entity.AbstractPageRecord

heapElementManager

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

fileForStorable, justCreated, logger, numberOfByteReadWrote, positionInFile, valueChangedToSave

Constructor Summary

Constructors

Constructor and Description
HeaderPage(IHeapElementManager heapElementManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() initial state:no value to save since not read and not write
void	decrementNumberOfDataRecord()
void	decrementNumberOfFreeRecord()
int	getByteSize()
long	getFileSizeAsNumberOfPage()
long	getFirstFreeBlock(int blockBits)
long	getFirstLeafPagePosition()
long	getFreeDataBlockPosition(int bits)
int	getInParentIndex()
long	getLastRecordPositionInFile()
long	getNewDataRecordIdentifier()
long	getNextFreeDataRecordIdentifier()
int	getNumberOfDataRecord()
int	getNumberOfFreeRecord()
int	getNumberOfPage() the number of pages take is fix
long	getPageNumberOfFirstFreePage()
PageRecord	getPageRecord()
IPageRecordable	getParentPage()
long	getPreviousRecordPositionInFile()
int	getRecordSize() get the record size
EnumRecordType	getRecordType()
long	getRootPagePosition()
void	incrementNumberOfDataRecord()
void	incrementNumberOfFreeRecord()
void	incrementNumberOfFreeRecord(int increment)
protected void	marshallImpl() marshaling implementation for write #crc32 is set to zero
void	setFileSizeAsNumberOfPage(long fileSizeAsNumberOfPage)
void	setFirstFreeBlock(long firstFreeBlockPosition, int blockBits)
void	setFirstLeafPagePosition(long firstLeafPagePosition)
void	setFreeDataBlockPosition(int bits, long freeDataBlockPosition)
void	setLastRecordPositionInFile(long lastRecordPositionInFile)
void	setNextFreeDataRecordIdentifier(long value)
void	setNumberOfFreeRecord(int numberOfFreeRecord)
void	setPageNumberOfFirstFreePage(long pageNumberOfFirstFreePage)
void	setPageRecord(IPageRecord pageRecord)
void	setParentPage(IPageRecordable parentPage, int inParentIndex)
void	setRootPagePosition(long rootPagePosition)
protected int	toMarshallSize()
protected void	unmarshallImpl() Unmarshalling implementation for read #crc32 is set to zero
void	updateByteSize()
protected void	valueChangedAction()

Methods inherited from class net.sf.joafip.btreeplus.entity.AbstractPageRecord

readKey, readRecordType, writeByteRecordType, writeKey

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.joafip.btreeplus.entity.IStateStored

setValueIsChangedValueToSave, setValueIsNotChanged

Constructor Detail

HeaderPage

public HeaderPage(IHeapElementManager heapElementManager)

Method Detail

valueChangedAction

protected void valueChangedAction()
                           throws HeapException

Specified by:

valueChangedAction in class AbstractFileStorable

Throws:

HeapException

getFileSizeAsNumberOfPage

public long getFileSizeAsNumberOfPage()

setFileSizeAsNumberOfPage

public void setFileSizeAsNumberOfPage(long fileSizeAsNumberOfPage)
                               throws HeapException

Throws:

HeapException

getPageNumberOfFirstFreePage

public long getPageNumberOfFirstFreePage()

setPageNumberOfFirstFreePage

public void setPageNumberOfFirstFreePage(long pageNumberOfFirstFreePage)
                                  throws HeapException

Throws:

HeapException

getRootPagePosition

public long getRootPagePosition()

setRootPagePosition

public void setRootPagePosition(long rootPagePosition)
                         throws HeapException

Throws:

HeapException

setFirstFreeBlock

public void setFirstFreeBlock(long firstFreeBlockPosition,
                     int blockBits)
                       throws HeapException

Throws:

HeapException

getFirstFreeBlock

public long getFirstFreeBlock(int blockBits)

getFirstLeafPagePosition

public long getFirstLeafPagePosition()

setFirstLeafPagePosition

public void setFirstLeafPagePosition(long firstLeafPagePosition)

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

getNumberOfPage

public int getNumberOfPage()

Description copied from interface: IPageRecordable

the number of pages take is fix

Specified by:

getNumberOfPage in interface IPageRecordable

Returns:

number of page take by the record

getPreviousRecordPositionInFile

public long getPreviousRecordPositionInFile()
                                     throws HeapException

Specified by:

getPreviousRecordPositionInFile in interface IFileStorable

Returns:

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

Throws:

HeapException

getRecordType

public EnumRecordType getRecordType()

Specified by:

getRecordType in interface IPageRecordable

getRecordSize

public int getRecordSize()
                  throws HeapException

Description copied from interface: IFileStorable

get the record size

Specified by:

getRecordSize in interface IFileStorable

Returns:

the record size

Throws:

HeapException

toMarshallSize

protected int toMarshallSize()
                      throws HeapException

Specified by:

toMarshallSize in class AbstractFileStorable

Returns:

number of byte to marshal

Throws:

HeapException

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

updateByteSize

public void updateByteSize()

Specified by:

updateByteSize in interface IPageRecordable

getByteSize

public int getByteSize()

Specified by:

getByteSize in interface IPageRecordable

Returns:

byte size of the element

setPageRecord

public void setPageRecord(IPageRecord pageRecord)
                   throws HeapException

Specified by:

setPageRecord in interface IPageRecordable

Throws:

HeapException

getPageRecord

public PageRecord getPageRecord()
                         throws HeapException

Specified by:

getPageRecord in interface IPageRecordable

Throws:

HeapException

getNextFreeDataRecordIdentifier

public long getNextFreeDataRecordIdentifier()

setNextFreeDataRecordIdentifier

public void setNextFreeDataRecordIdentifier(long value)
                                     throws HeapException

Throws:

HeapException

getNewDataRecordIdentifier

public long getNewDataRecordIdentifier()
                                throws HeapException

Throws:

HeapException

getFreeDataBlockPosition

public long getFreeDataBlockPosition(int bits)

setFreeDataBlockPosition

public void setFreeDataBlockPosition(int bits,
                            long freeDataBlockPosition)
                              throws HeapException

Throws:

HeapException

setParentPage

public void setParentPage(IPageRecordable parentPage,
                 int inParentIndex)
                   throws HeapException

Specified by:

setParentPage in interface IPageRecordable

Throws:

HeapException

getParentPage

public IPageRecordable getParentPage()
                              throws HeapException

Specified by:

getParentPage in interface IPageRecordable

Throws:

HeapException

getInParentIndex

public int getInParentIndex()
                     throws HeapException

Specified by:

getInParentIndex in interface IPageRecordable

Throws:

HeapException

setLastRecordPositionInFile

public void setLastRecordPositionInFile(long lastRecordPositionInFile)

getLastRecordPositionInFile

public long getLastRecordPositionInFile()

incrementNumberOfDataRecord

public void incrementNumberOfDataRecord()
                                 throws HeapException

Throws:

HeapException

decrementNumberOfDataRecord

public void decrementNumberOfDataRecord()
                                 throws HeapException

Throws:

HeapException

getNumberOfDataRecord

public int getNumberOfDataRecord()

getNumberOfFreeRecord

public int getNumberOfFreeRecord()

setNumberOfFreeRecord

public void setNumberOfFreeRecord(int numberOfFreeRecord)

incrementNumberOfFreeRecord

public void incrementNumberOfFreeRecord()

decrementNumberOfFreeRecord

public void decrementNumberOfFreeRecord()

incrementNumberOfFreeRecord

public void incrementNumberOfFreeRecord(int increment)