net.sf.joafip.store.entity.heaprecordable

Class AbstractHeapRecordable

java.lang.Object

net.sf.joafip.store.entity.heaprecordable.AbstractHeapRecordable

All Implemented Interfaces:

IHeapRecordable

Direct Known Subclasses:

AbstractHeapRecordableRBTNode, ClassNameRecord, StoreHeader

@NotStorableClass
public abstract class AbstractHeapRecordable
extends Object
implements IHeapRecordable

common for object recordable in heap

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
protected HeapRecordableManager	heapRecordableManager manager of read and write of IHeapRecordable
protected HelperBinaryConversion	helperBinaryConversion
protected JoafipLogger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractHeapRecordable(HeapRecordableManager heapRecordableManager, HelperBinaryConversion helperBinaryConversion)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkLoaded()
void	clear() clear to put in same state as for construction
int	compareTo(IHeapRecordable heapRecordable)
boolean	equals(Object obj)
DataRecordIdentifier	getDataRecordIdentifier() get the identifier of the data record storing this object state
int	hashCode()
boolean	isStateChanged()
void	setDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier, boolean existInFile) set the identifier of the data record storing this object state
void	setStateHaveChanged() set state changed, HeapRecordableManager will save change
void	setSynchronizedWithFile() set this object state is synchronized with data in file
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.joafip.store.entity.heaprecordable.IHeapRecordable

byteSize, marshall, unmarshall

Field Detail

logger

protected final JoafipLogger logger

heapRecordableManager

protected final HeapRecordableManager heapRecordableManager

manager of read and write of IHeapRecordable

helperBinaryConversion

protected HelperBinaryConversion helperBinaryConversion

Constructor Detail

AbstractHeapRecordable

public AbstractHeapRecordable(HeapRecordableManager heapRecordableManager,
                      HelperBinaryConversion helperBinaryConversion)

Method Detail

getDataRecordIdentifier

public DataRecordIdentifier getDataRecordIdentifier()

Description copied from interface: IHeapRecordable

get the identifier of the data record storing this object state

Specified by:

getDataRecordIdentifier in interface IHeapRecordable

Returns:

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

setDataRecordIdentifier

public void setDataRecordIdentifier(DataRecordIdentifier dataRecordIdentifier,
                           boolean existInFile)
                             throws HeapRecordableException

Description copied from interface: IHeapRecordable

set the identifier of the data record storing this object state

Specified by:

setDataRecordIdentifier in interface IHeapRecordable

Parameters:

dataRecordIdentifier - the data record identifier for this object

Throws:

HeapRecordableException

setStateHaveChanged

public void setStateHaveChanged()
                         throws HeapRecordableException

set state changed, HeapRecordableManager will save change

Throws:

HeapRecordableException

isStateChanged

public boolean isStateChanged()

Specified by:

isStateChanged in interface IHeapRecordable

Returns:

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

setSynchronizedWithFile

public void setSynchronizedWithFile()

Description copied from interface: IHeapRecordable

set this object state is synchronized with data in file

Specified by:

setSynchronizedWithFile in interface IHeapRecordable

clear

public void clear()

clear to put in same state as for construction

checkLoaded

protected void checkLoaded()
                    throws HeapRecordableException

Throws:

HeapRecordableException

compareTo

public int compareTo(IHeapRecordable heapRecordable)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object