net.sf.joafip.kvstore.entity

Interface IFileStorable

All Known Subinterfaces:

IPageRecord

All Known Implementing Classes:

AbstractFileStorable, AbstractPageRecord, HeaderPage, HeapHeader, HeapRecord, NullFileStorable, PageRecord

public interface IFileStorable

class implementing this can be store in file using FileForStorable

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() initial state:no value to save since not read and not write
long	getPositionInFile()
long	getPreviousRecordPositionInFile()
int	getRecordSize() get the record size
boolean	isJustCreated()
boolean	isValueChangedToSave() to know if the value state change
void	readFromFile() read this file storable from file
void	setValueIsChangedValueToSave() set this record have value changed, so to save
void	setValueIsNotChanged()
void	writeToFile() write this file storable to file
byte[]	writeToFileGetWrited()

Method Detail

getPositionInFile

long getPositionInFile()

Returns:

position in file of this file storable

getPreviousRecordPositionInFile

long getPreviousRecordPositionInFile()
                                     throws HeapException

Returns:

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

Throws:

HeapException

writeToFile

void writeToFile()
                 throws HeapException

write this file storable to file

Throws:

HeapException

writeToFileGetWrited

byte[] writeToFileGetWrited()
                            throws HeapException

Throws:

HeapException

readFromFile

void readFromFile()
                  throws HeapException

read this file storable from file

Throws:

HeapException

clear

void clear()

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

setValueIsChangedValueToSave

void setValueIsChangedValueToSave()
                                  throws HeapException

set this record have value changed, so to save

Throws:

HeapException

setValueIsNotChanged

void setValueIsNotChanged()

isValueChangedToSave

boolean isValueChangedToSave()

to know if the value state change

Returns:

true if value changed

isJustCreated

boolean isJustCreated()

Returns:

true if just created ( not read from file and not setted )

getRecordSize

int getRecordSize()
                  throws HeapException

get the record size

Returns:

the record size

Throws:

HeapException