net.sf.joafip.store.entity.heaprecordable

Interface IHeapRecordable

All Known Implementing Classes:

AbstractHeapRecordable, AbstractHeapRecordableRBTNode, ClassNameRecord, DataRecordIdentifierRBTNode, GarbageReferenceLinkRBTNode, StoreHeader

public interface IHeapRecordable

object recordable in heap file interface
all that need to be implemented to read,write,create,delete object state in heap file

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
int	byteSize()
DataRecordIdentifier	getDataRecordIdentifier() get the identifier of the data record storing this object state
boolean	isStateChanged()
void	marshall(byte[] binary) from object state to binary form
void	setDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier, boolean existInFile) set the identifier of the data record storing this object state
void	setSynchronizedWithFile() set this object state is synchronized with data in file
void	unmarshall(byte[] binary) from binary form to object state

Method Detail

setDataRecordIdentifier

void setDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier,
                           boolean existInFile)
                             throws HeapRecordableException

set the identifier of the data record storing this object state

Parameters:

dataRecordIdentifier - the data record identifier for this object

true - if data record with this object state exist in file

Throws:

HeapRecordableException

getDataRecordIdentifier

DataRecordIdentifier getDataRecordIdentifier()

get the identifier of the data record storing this object state

Returns:

the data record identifier for this object, null if not attached

byteSize

int byteSize()
             throws HeapRecordableException

Returns:

byte size of binary coding of object state

Throws:

HeapRecordableException

marshall

void marshall(byte[] binary)
              throws HeapRecordableException

from object state to binary form

Parameters:

binary - where write the object state

Throws:

HeapRecordableException

unmarshall

void unmarshall(byte[] binary)
                throws HeapRecordableException

from binary form to object state

Parameters:

binary - where read the object state

Throws:

HeapRecordableException

isStateChanged

boolean isStateChanged()

Returns:

true if this object state changed ( to save in file )

setSynchronizedWithFile

void setSynchronizedWithFile()

set this object state is synchronized with data in file