net.sf.joafip.store.entity.heaprecordable

Class AbstractHeapRecordableRBTNode<E>

java.lang.Object

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

net.sf.joafip.store.entity.heaprecordable.AbstractHeapRecordableRBTNode<E>

All Implemented Interfaces:

IRBTComparableNode<E>, IRBTNode<E>, IRBTVisitable<E>, IHeapRecordable

Direct Known Subclasses:

DataRecordIdentifierRBTNode, GarbageReferenceLinkRBTNode

@NotStorableClass
public abstract class AbstractHeapRecordableRBTNode<E>
extends AbstractHeapRecordable
implements IRBTNode<E>

red black tree heap recordable node

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	headerByteSize

Fields inherited from class net.sf.joafip.store.entity.heaprecordable.AbstractHeapRecordable

heapRecordableManager, helperBinaryConversion, logger

Constructor Summary

Constructors

Constructor and Description
AbstractHeapRecordableRBTNode(HeapRecordableManager heapRecordableManager, HelperBinaryConversion helperBinaryConversion)
AbstractHeapRecordableRBTNode(HelperBinaryConversion helperBinaryConversion) construct a sentinel

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(IRBTVisitor<E> visitor) accept red black tree visitor
int	byteSize()
protected abstract int	byteSize(E element)
protected void	checkNotSentinel()
int	compareTo(E element)
int	compareTo(IRBTComparableNode<E> node)
void	decrementNumberOfChild()
void	detach() detach the node from the tree
boolean	getColor() get node color color definition: RedBlackTree#BLACK and RedBlackTree#RED
E	getElement() get the element of this node
int	getIndex()
IRBTNode<E>	getLeft() get left child of this node
int	getNumberOfChild() get the number of node in right and left tree node, sentinel excluded
IRBTNode<E>	getParent() get parent node
IRBTNode<E>	getRight() get right child of this node
void	incrementNumberOfChild()
boolean	isAttached()
boolean	isBlack() to know if node is black
boolean	isColorSetted()
boolean	isRed() to know if node is red
boolean	isSentinel() to know if this node is a sentinel ( a black leaf marker ), if not a sentinel it is a valued node with right and left child
void	marshall(byte[] binary) from object state to binary form
protected abstract void	marshallElement(byte[] binary, int offset, E element)
protected abstract AbstractHeapRecordableRBTNode<E>	newNode(HeapRecordableManager heapRecordableManager)
protected abstract AbstractHeapRecordableRBTNode<E>	newSentinel()
void	setBlack() set node color to black
void	setColor(boolean color) set node color color definition: RedBlackTree#BLACK and RedBlackTree#RED
void	setElement(E element) set this node element
void	setIndex(int index)
void	setLeft(IRBTNode<E> node) set left child of this node
void	setNumberOfChild(int numberOfChild) set the number of node in right and left tree node, sentinel excluded
void	setParent(IRBTNode<E> node) set parent node
void	setRed() set node color to red
void	setRight(IRBTNode<E> node) set right child of this node
void	setStateHaveChanged() set state changed, HeapRecordableManager will save change
String	toString()
void	unmarshall(byte[] binary) from binary form to object state
protected abstract E	unmarshallElement(byte[] binary, int offset)

Methods inherited from class net.sf.joafip.store.entity.heaprecordable.AbstractHeapRecordable

checkLoaded, clear, compareTo, equals, getDataRecordIdentifier, hashCode, isStateChanged, setDataRecordIdentifier, setSynchronizedWithFile

Methods inherited from class java.lang.Object

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

Field Detail

headerByteSize

protected static final int headerByteSize

See Also:

Constant Field Values

Constructor Detail

AbstractHeapRecordableRBTNode

public AbstractHeapRecordableRBTNode(HeapRecordableManager heapRecordableManager,
                             HelperBinaryConversion helperBinaryConversion)

AbstractHeapRecordableRBTNode

public AbstractHeapRecordableRBTNode(HelperBinaryConversion helperBinaryConversion)

construct a sentinel

Method Detail

byteSize

public int byteSize()
             throws HeapRecordableException

Specified by:

byteSize in interface IHeapRecordable

Returns:

byte size of binary coding of object state

Throws:

HeapRecordableException

byteSize

protected abstract int byteSize(E element)
                         throws HeapRecordableException

Throws:

HeapRecordableException

marshall

public void marshall(byte[] binary)
              throws HeapRecordableException

Description copied from interface: IHeapRecordable

from object state to binary form

Specified by:

marshall in interface IHeapRecordable

Parameters:

binary - where write the object state

Throws:

HeapRecordableException

marshallElement

protected abstract void marshallElement(byte[] binary,
                   int offset,
                   E element)
                                 throws BinaryConverterException

Throws:

BinaryConverterException

unmarshall

public void unmarshall(byte[] binary)
                throws HeapRecordableException

Description copied from interface: IHeapRecordable

from binary form to object state

Specified by:

unmarshall in interface IHeapRecordable

Parameters:

binary - where read the object state

Throws:

HeapRecordableException

newNode

protected abstract AbstractHeapRecordableRBTNode<E> newNode(HeapRecordableManager heapRecordableManager)

newSentinel

protected abstract AbstractHeapRecordableRBTNode<E> newSentinel()

unmarshallElement

protected abstract E unmarshallElement(byte[] binary,
                  int offset)
                                throws HeapRecordableException

Throws:

HeapRecordableException

checkNotSentinel

protected void checkNotSentinel()
                         throws RBTException

Throws:

RBTException

setStateHaveChanged

public void setStateHaveChanged()
                         throws HeapRecordableException

Description copied from class: AbstractHeapRecordable

set state changed, HeapRecordableManager will save change

Overrides:

setStateHaveChanged in class AbstractHeapRecordable

Throws:

HeapRecordableException

isColorSetted

public boolean isColorSetted()
                      throws RBTException

Specified by:

isColorSetted in interface IRBTNode<E>

Returns:

true if node color is set

Throws:

RBTException

getColor

public boolean getColor()
                 throws RBTException

Description copied from interface: IRBTNode

get node color
color definition: RedBlackTree#BLACK and RedBlackTree#RED

Specified by:

getColor in interface IRBTNode<E>

Returns:

the node color

Throws:

RBTException - node access error

getLeft

public IRBTNode<E> getLeft()
                    throws RBTException

Description copied from interface: IRBTNode

get left child of this node

Specified by:

getLeft in interface IRBTNode<E>

Returns:

left child of this node

Throws:

RBTException - node access error

getParent

public IRBTNode<E> getParent()
                      throws RBTException

Description copied from interface: IRBTNode

get parent node

Specified by:

getParent in interface IRBTNode<E>

Returns:

the parent node, or null if have not ( this is root node )

Throws:

RBTException - node access error

getRight

public IRBTNode<E> getRight()
                     throws RBTException

Description copied from interface: IRBTNode

get right child of this node

Specified by:

getRight in interface IRBTNode<E>

Returns:

right child of this node

Throws:

RBTException - node access error

isBlack

public boolean isBlack()
                throws RBTException

Description copied from interface: IRBTNode

to know if node is black

Specified by:

isBlack in interface IRBTNode<E>

Returns:

true if node is black

Throws:

RBTException - node access error

isRed

public boolean isRed()
              throws RBTException

Description copied from interface: IRBTNode

to know if node is red

Specified by:

isRed in interface IRBTNode<E>

Returns:

true if node is red

Throws:

RBTException - node access error

isSentinel

public boolean isSentinel()
                   throws RBTException

Description copied from interface: IRBTNode

to know if this node is a sentinel ( a black leaf marker ), if not a sentinel it is a valued node with right and left child

Specified by:

isSentinel in interface IRBTNode<E>

Returns:

true is this node is a sentinel

Throws:

RBTException - node access error

setBlack

public void setBlack()
              throws RBTException

Description copied from interface: IRBTNode

set node color to black

Specified by:

setBlack in interface IRBTNode<E>

Throws:

RBTException

setColor

public void setColor(boolean color)
              throws RBTException

Description copied from interface: IRBTNode

set node color
color definition: RedBlackTree#BLACK and RedBlackTree#RED

Specified by:

setColor in interface IRBTNode<E>

Parameters:

color - the node color

Throws:

RBTException - node access error

setLeft

public void setLeft(IRBTNode<E> node)
             throws RBTException

Description copied from interface: IRBTNode

set left child of this node

Specified by:

setLeft in interface IRBTNode<E>

Parameters:

node - the left child of this node

Throws:

RBTException - node access error

setNumberOfChild

public void setNumberOfChild(int numberOfChild)
                      throws RBTException

Description copied from interface: IRBTNode

set the number of node in right and left tree node, sentinel excluded

Specified by:

setNumberOfChild in interface IRBTNode<E>

Parameters:

numberOfChild - the number of children

Throws:

RBTException

getNumberOfChild

public int getNumberOfChild()
                     throws RBTException

Description copied from interface: IRBTNode

get the number of node in right and left tree node, sentinel excluded

Specified by:

getNumberOfChild in interface IRBTNode<E>

Returns:

the number of children

Throws:

RBTException - node access error

setIndex

public void setIndex(int index)

Specified by:

setIndex in interface IRBTNode<E>

getIndex

public int getIndex()

Specified by:

getIndex in interface IRBTNode<E>

decrementNumberOfChild

public void decrementNumberOfChild()
                            throws RBTException

Specified by:

decrementNumberOfChild in interface IRBTNode<E>

Throws:

RBTException

incrementNumberOfChild

public void incrementNumberOfChild()
                            throws RBTException

Specified by:

incrementNumberOfChild in interface IRBTNode<E>

Throws:

RBTException

setParent

public void setParent(IRBTNode<E> node)
               throws RBTException

Description copied from interface: IRBTNode

set parent node

Specified by:

setParent in interface IRBTNode<E>

Parameters:

node - the parent node

Throws:

RBTException - node access error

setRed

public void setRed()
            throws RBTException

Description copied from interface: IRBTNode

set node color to red

Specified by:

setRed in interface IRBTNode<E>

Throws:

RBTException - node access error

setRight

public void setRight(IRBTNode<E> node)
              throws RBTException

Description copied from interface: IRBTNode

set right child of this node

Specified by:

setRight in interface IRBTNode<E>

Parameters:

node - the right child of this node

Throws:

RBTException - node access error

compareTo

public int compareTo(IRBTComparableNode<E> node)
              throws RBTException

Specified by:

compareTo in interface IRBTComparableNode<E>

Throws:

RBTException

compareTo

public int compareTo(E element)
              throws RBTException

Specified by:

compareTo in interface IRBTComparableNode<E>

Throws:

RBTException

accept

public void accept(IRBTVisitor<E> visitor)
            throws RBTException

Description copied from interface: IRBTVisitable

accept red black tree visitor

Specified by:

accept in interface IRBTVisitable<E>

Parameters:

visitor - the red black tree visitor

Throws:

RBTException - node access error

getElement

public E getElement()
             throws RBTException

Description copied from interface: IRBTNode

get the element of this node

Specified by:

getElement in interface IRBTNode<E>

Returns:

the element of this node

Throws:

RBTException

setElement

public void setElement(E element)
                throws RBTException

Description copied from interface: IRBTNode

set this node element

Specified by:

setElement in interface IRBTNode<E>

Parameters:

element - the element to set for this node

Throws:

RBTException

detach

public void detach()

Description copied from interface: IRBTNode

detach the node from the tree

Specified by:

detach in interface IRBTNode<E>

isAttached

public boolean isAttached()

Specified by:

isAttached in interface IRBTNode<E>

toString

public String toString()

Overrides:

toString in class AbstractHeapRecordable