net.sf.joafip.heapfile.record.entity

Class HeapRecord

java.lang.Object

net.sf.joafip.kvstore.entity.AbstractFileStorable

net.sf.joafip.heapfile.record.entity.HeapRecord

All Implemented Interfaces:

IFileStorable

@NotStorableClass
public class HeapRecord
extends AbstractFileStorable

heap file record

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_RECORD_HEADER_SIZE for idNode 4+3*8+1+4+8+1 4 for dataAssociatedSize 8 for parentFilePosition 8 for leftFilePosition 8 for rightFilePosition 1 for color 4 for number of child 8 for node identification
static int	FREE_RECORD_HEADER_SIZE for freeNode 3*8+1+4 8 for parentFilePosition 8 for leftFilePosition 8 for rightFilePosition 1 for color 4 for number of child
static int	MAX_RECORD_HEADER_SIZE

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

fileForStorable, justCreated, logger, numberOfByteReadWrote, positionInFile, valueChangedToSave

Constructor Summary

Constructors

Constructor and Description
HeapRecord(IHeapElementManager heapElementManager, long positionInFile) construction for reading, unknown data associated size, and unknown node identification should be only used bye HeapElementManager
HeapRecord(IHeapElementManager heapElementManager, long positionInFile, Long previousRecordPositionInFile, DataRecordIdentifier nodeIdentifier, boolean freeRecord, int dataAssociatedSize, int recordSize) construction for node creation, it is a data record, not free should be only used by HeapElementManager

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
void	freeRecord()
byte[]	getDataAssociated()
byte[]	getDataAssociatedField()
Integer	getDataAssociatedSize()
IRBTNode<Integer>	getFreeNode()
IRBTNode<DataRecordIdentifier>	getIdNode()
long	getNextRecordFilePosition()
DataRecordIdentifier	getNodeIdentifier()
long	getPreviousRecordPositionInFile()
int	getRecordSize() get the record size
int	hashCode()
boolean	isFreeRecord() to know if is a free record, mark a free space
boolean	isHeaderRead()
protected void	marshallImpl() marshaling implementation for write #crc32 is set to zero
void	setDataAssociated(byte[] dataAssociated) set data associated to this record
void	setPreviousRecordPositionInFile(long previousRecordPositionInFile)
void	setRecordSize(int recordSize)
protected int	toMarshallSize()
String	toString()
void	unfreeRecord(int dataAssociatedSize, DataRecordIdentifier nodeIdentifier)
void	unfreeRecord(int dataAssociatedSize, int recordSize, DataRecordIdentifier nodeIdentifier, boolean manageData)
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

clear, getPositionInFile, 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

FREE_RECORD_HEADER_SIZE

public static final int FREE_RECORD_HEADER_SIZE

for freeNode 3*8+1+4
8 for parentFilePosition
8 for leftFilePosition
8 for rightFilePosition
1 for color
4 for number of child

See Also:

Constant Field Values

DATA_RECORD_HEADER_SIZE

public static final int DATA_RECORD_HEADER_SIZE

for idNode 4+3*8+1+4+8+1
4 for dataAssociatedSize
8 for parentFilePosition
8 for leftFilePosition
8 for rightFilePosition
1 for color
4 for number of child
8 for node identification

See Also:

Constant Field Values

MAX_RECORD_HEADER_SIZE

public static final int MAX_RECORD_HEADER_SIZE

See Also:

Constant Field Values

Constructor Detail

HeapRecord

public HeapRecord(IHeapElementManager heapElementManager,
          long positionInFile,
          Long previousRecordPositionInFile,
          DataRecordIdentifier nodeIdentifier,
          boolean freeRecord,
          int dataAssociatedSize,
          int recordSize)
           throws HeapException

construction for node creation, it is a data record, not free should be only used by HeapElementManager

Parameters:

heapElementManager - heap header and record manager in heap file

positionInFile - record position in file

previousRecordPositionInFile - previous record position in file

nodeIdentifier - data node identification number

freeRecord - true if free record

dataAssociatedSize - size of associated data if not a free record, else it is the free space

recordSize - area size for this record

Throws:

HeapException

HeapRecord

public HeapRecord(IHeapElementManager heapElementManager,
          long positionInFile)
           throws HeapException

construction for reading, unknown data associated size, and unknown node identification
should be only used bye HeapElementManager

Parameters:

heapElementManager - heap header and record manager in heap file

positionInFile - record position in file

Throws:

HeapException

Method Detail

valueChangedAction

protected void valueChangedAction()
                           throws HeapException

Specified by:

valueChangedAction in class AbstractFileStorable

Throws:

HeapException

freeRecord

public void freeRecord()
                throws HeapException

Throws:

HeapException

unfreeRecord

public void unfreeRecord(int dataAssociatedSize,
                int recordSize,
                DataRecordIdentifier nodeIdentifier,
                boolean manageData)
                  throws HeapException

Throws:

HeapException

unfreeRecord

public void unfreeRecord(int dataAssociatedSize,
                DataRecordIdentifier nodeIdentifier)
                  throws HeapException

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

isHeaderRead

public boolean isHeaderRead()

getNodeIdentifier

public DataRecordIdentifier getNodeIdentifier()

getIdNode

public IRBTNode<DataRecordIdentifier> getIdNode()
                                         throws HeapException

Throws:

HeapException

getFreeNode

public IRBTNode<Integer> getFreeNode()
                              throws HeapException

Throws:

HeapException

isFreeRecord

public boolean isFreeRecord()

to know if is a free record, mark a free space

Returns:

true if free record

getPreviousRecordPositionInFile

public long getPreviousRecordPositionInFile()
                                     throws HeapException

Returns:

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

Throws:

HeapException

setPreviousRecordPositionInFile

public void setPreviousRecordPositionInFile(long previousRecordPositionInFile)
                                     throws HeapException

Throws:

HeapException

getNextRecordFilePosition

public long getNextRecordFilePosition()
                               throws HeapException

Throws:

HeapException

getRecordSize

public int getRecordSize()
                  throws HeapException

Description copied from interface: IFileStorable

get the record size

Returns:

the record size

Throws:

HeapException

setRecordSize

public void setRecordSize(int recordSize)

getDataAssociatedSize

public Integer getDataAssociatedSize()
                              throws HeapException

Returns:

size of data associated to this record, null if not defined

Throws:

HeapException

getDataAssociated

public byte[] getDataAssociated()
                         throws HeapException

Throws:

HeapException

getDataAssociatedField

@Fortest
public byte[] getDataAssociatedField()

setDataAssociated

public void setDataAssociated(byte[] dataAssociated)
                       throws HeapException

set data associated to this record

Parameters:

dataAssociated - new associated data for this record

Throws:

HeapException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractFileStorable

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractFileStorable

toString

public String toString()

Overrides:

toString in class AbstractFileStorable