AbstractHeapRBTNode (JOAFIP "Abstract" Parent Project 4.0.0b9)

java.lang.Object
- net.sf.joafip.heapfile.record.entity.AbstractHeapRBTNode<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

HeapFreeNode, HeapIdNode
```
@NotStorableClass
public abstract class AbstractHeapRBTNode<E extends Comparable<E>>
extends Object
implements IRBTNode<E>
```
heap file Red Black Tree Node for used and free heap file area management
is implementation of IRBTNode where an association is made between this node and its image in heap file

Author:

luc peuvrier

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`color` this node color: `RedBlackTree.BLACK` or `RedBlackTree.RED`.
`boolean`	`colorSetted` true if node color set. public is bad smell but this done for optimization
`protected IHeapElementManager`	`heapElementManager` heap elements manager for access to `HeapRecord`, null for sentinel node
`int`	`index`
`long`	`leftPositionInFile` position in heap file of the copy of this node left son. public is bad smell but this done for optimization
`int`	`numberOfChild` number of child of this node. public is bad smell but this done for optimization
`long`	`parentPositionInFile` position in heap file of the copy of this node parent. public is bad smell but this done for optimization
`long`	`rightPositionInFile` position in heap file of the copy of this node right son. public is bad smell but this done for optimization
`boolean`	`valueChanged` became true when value changed. public is bad smell but this done for optimization

Constructor Summary

Constructors
Constructor and Description
`AbstractHeapRBTNode(IHeapElementManager heapElementManager, long positionInFile, long parentPositionInFile, long leftPositionInFile, long rightPositionInFile, boolean colorSetted, boolean color, int numberOfChild)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(IRBTVisitor<E> visitor)` accept red black tree visitor
`void`	`decrementNumberOfChild()`
`void`	`detach()` detach the node from the tree
`boolean`	`equals(Object obj)`
`boolean`	`getColor()` get node color color definition: `RedBlackTree#BLACK` and `RedBlackTree#RED`
`HeapRecord`	`getHeapRecord()`
`int`	`getIndex()`
`IRBTNode<E>`	`getLeft()` get left child of this node
`long`	`getLeftPositionInFile()` get this node left son node mirroring in heap file position should be used only by `HeapRecord` to save it in heap file
`int`	`getNumberOfChild()` get the number of node in right and left tree node, sentinel excluded
`IRBTNode<E>`	`getParent()` get parent node
`long`	`getParentPositionInFile()` get this node parent node mirroring in heap file position should be used only by `HeapRecord` to save it in heap file
`long`	`getPositionInFile()` get this node mirroring in heap file position should be used only by heap red black tree node manager ( specialization of `AbstractHeapNodeManager`) and this
`IRBTNode<E>`	`getRight()` get right child of this node
`long`	`getRightPositionInFile()` get this node right son node mirroring in heap file position should be used only by `HeapRecord` to save it in heap file
`int`	`hashCode()`
`protected abstract AbstractHeapRBTNode<E>`	`heapNode(HeapRecord heapRecord)` get the heap node from the heap record from heap file, depending of heap tree it is not at same location on heap record.
`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
`boolean`	`isValueChanged()` to know if state of this changed
`void`	`setBlack()` set node color to black
`void`	`setColor(boolean color)` set node color color definition: `RedBlackTree#BLACK` and `RedBlackTree#RED`
`void`	`setIndex(int index)`
`void`	`setLeft(IRBTNode<E> node)` set left child of this node
`void`	`setLeftPositionInFile(long leftPositionInFile)` set this node left son node mirroring in heap file position should be used only by `HeapRecord` to load it from heap file
`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`	`setParentPositionInFile(long parentFilePosition)` set this node parent node mirroring in heap file position should be used only by `HeapRecord` to load it from heap file
`void`	`setRed()` set node color to red
`void`	`setRight(IRBTNode<E> node)` set right child of this node
`void`	`setRightPositionInFile(long rightPositionInFile)` set this node right son node mirroring in heap file position should be used only by `HeapRecord` to load it from heap file
`String`	`toString()`
`void`	`valueSetted()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.joafip.redblacktree.entity.IRBTNode
getElement, setElement

Methods inherited from interface net.sf.joafip.redblacktree.entity.IRBTComparableNode
compareTo, compareTo

- Field Detail
  - valueChanged
```
public boolean valueChanged
```
    became true when value changed. public is bad smell but this done for optimization
  - parentPositionInFile
```
public long parentPositionInFile
```
    position in heap file of the copy of this node parent. public is bad smell but this done for optimization
  - leftPositionInFile
```
public long leftPositionInFile
```
    position in heap file of the copy of this node left son. public is bad smell but this done for optimization
  - rightPositionInFile
```
public long rightPositionInFile
```
    position in heap file of the copy of this node right son. public is bad smell but this done for optimization
  - colorSetted
```
public boolean colorSetted
```
    true if node color set. public is bad smell but this done for optimization
  - color
```
public boolean color
```
    this node color: RedBlackTree.BLACK or RedBlackTree.RED. public is bad smell but this done for optimization
  - numberOfChild
```
public int numberOfChild
```
    number of child of this node. public is bad smell but this done for optimization
  - index
```
public int index
```
  - heapElementManager
```
protected IHeapElementManager heapElementManager
```
    heap elements manager for access to HeapRecord, null for sentinel node
- Constructor Detail
  - AbstractHeapRBTNode
```
public AbstractHeapRBTNode(IHeapElementManager heapElementManager,
                   long positionInFile,
                   long parentPositionInFile,
                   long leftPositionInFile,
                   long rightPositionInFile,
                   boolean colorSetted,
                   boolean color,
                   int numberOfChild)
```
- Method Detail
  - getHeapRecord
```
public HeapRecord getHeapRecord()
                         throws HeapException
```
    Throws:
    
    HeapException
  - getPositionInFile
```
public long getPositionInFile()
```
    get this node mirroring in heap file position
    should be used only by heap red black tree node manager ( specialization of AbstractHeapNodeManager) and this
    
    Returns:
    the position of this node mirroring in heap file
  - getLeftPositionInFile
```
public long getLeftPositionInFile()
                           throws RBTException
```
    get this node left son node mirroring in heap file position
    should be used only by HeapRecord to save it in heap file
    
    Returns:
    the position of this node left son node mirroring in heap file
    
    Throws:
    
    RBTException
  - getRightPositionInFile
```
public long getRightPositionInFile()
                            throws RBTException
```
    get this node right son node mirroring in heap file position
    should be used only by HeapRecord to save it in heap file
    
    Returns:
    the position of this node right son node mirroring in heap file
    
    Throws:
    
    RBTException
  - getParentPositionInFile
```
public long getParentPositionInFile()
```
    get this node parent node mirroring in heap file position
    should be used only by HeapRecord to save it in heap file
    
    Returns:
    the position of this node parent node mirroring in heap file
  - setLeftPositionInFile
```
public void setLeftPositionInFile(long leftPositionInFile)
                           throws RBTException
```
    set this node left son node mirroring in heap file position
    should be used only by HeapRecord to load it from heap file
    
    Parameters:
    leftPositionInFile - the position of this node left son node mirroring in heap file
    
    Throws:
    
    RBTException
  - setRightPositionInFile
```
public void setRightPositionInFile(long rightPositionInFile)
                            throws RBTException
```
    set this node right son node mirroring in heap file position
    should be used only by HeapRecord to load it from heap file
    
    Parameters:
    leftPositionInFile - the position of this node right son node mirroring in heap file
    
    Throws:
    
    RBTException
  - setParentPositionInFile
```
public void setParentPositionInFile(long parentFilePosition)
```
    set this node parent node mirroring in heap file position
    should be used only by HeapRecord to load it from heap file
    
    Parameters:
    leftPositionInFile - the position of this node parent node mirroring in heap file
  - setParent
```
public void setParent(IRBTNode<E> node)
               throws RBTException
```
    Description copied from interface: IRBTNode
    
    set parent node
    
    Specified by:
    
    setParent in interface IRBTNode<E extends Comparable<E>>
    
    Parameters:
    node - the parent node
    
    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 extends Comparable<E>>
    
    Parameters:
    node - the left child of this node
    
    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 extends Comparable<E>>
    
    Parameters:
    node - the right 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 extends Comparable<E>>
    
    Returns:
    the parent node, or null if have not ( this is root node )
    
    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 extends Comparable<E>>
    
    Returns:
    left child of this 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 extends Comparable<E>>
    
    Returns:
    right child of this node
    
    Throws:
    
    RBTException - node access error
  - heapNode
```
protected abstract AbstractHeapRBTNode<E> heapNode(HeapRecord heapRecord)
                                                                  throws RBTException
```
    get the heap node from the heap record from heap file, depending of heap tree it is not at same location on heap record.
    
    Parameters:
    heapRecord - the heap record
    
    Returns:
    the heap file Red Black Tree Node
    
    Throws:
    
    RBTException
  - isSentinel
```
public boolean isSentinel()
```
    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 extends Comparable<E>>
    
    Returns:
    true is this node is a sentinel
  - isColorSetted
```
public boolean isColorSetted()
```
    Specified by:
    
    isColorSetted in interface IRBTNode<E extends Comparable<E>>
    
    Returns:
    true if node color is set
  - isBlack
```
public boolean isBlack()
                throws RBTException
```
    Description copied from interface: IRBTNode
    
    to know if node is black
    
    Specified by:
    
    isBlack in interface IRBTNode<E extends Comparable<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 extends Comparable<E>>
    
    Returns:
    true if node is red
    
    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 extends Comparable<E>>
    
    Throws:
    
    RBTException
  - setRed
```
public void setRed()
            throws RBTException
```
    Description copied from interface: IRBTNode
    
    set node color to red
    
    Specified by:
    
    setRed in interface IRBTNode<E extends Comparable<E>>
    
    Throws:
    
    RBTException - node access error
  - 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 extends Comparable<E>>
    
    Parameters:
    color - the node color
    
    Throws:
    
    RBTException - node access error
  - 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 extends Comparable<E>>
    
    Returns:
    the node color
    
    Throws:
    
    RBTException - node access error
  - 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 extends Comparable<E>>
    
    Returns:
    the number of children
    
    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 extends Comparable<E>>
    
    Parameters:
    numberOfChild - the number of children
    
    Throws:
    
    RBTException
  - setIndex
```
public void setIndex(int index)
```
    Specified by:
    
    setIndex in interface IRBTNode<E extends Comparable<E>>
  - getIndex
```
public int getIndex()
```
    Specified by:
    
    getIndex in interface IRBTNode<E extends Comparable<E>>
  - decrementNumberOfChild
```
public void decrementNumberOfChild()
                            throws RBTException
```
    Specified by:
    
    decrementNumberOfChild in interface IRBTNode<E extends Comparable<E>>
    
    Throws:
    
    RBTException
  - incrementNumberOfChild
```
public void incrementNumberOfChild()
                            throws RBTException
```
    Specified by:
    
    incrementNumberOfChild in interface IRBTNode<E extends Comparable<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 extends Comparable<E>>
    
    Parameters:
    visitor - the red black tree visitor
    
    Throws:
    
    RBTException - node access error
  - isValueChanged
```
public boolean isValueChanged()
                       throws RBTException
```
    to know if state of this changed
    
    Returns:
    true if value changed
    
    Throws:
    
    RBTException
  - valueSetted
```
public void valueSetted()
                 throws RBTException
```
    Throws:
    
    RBTException
  - detach
```
public void detach()
```
    Description copied from interface: IRBTNode
    
    detach the node from the tree
    
    Specified by:
    
    detach in interface IRBTNode<E extends Comparable<E>>
  - isAttached
```
public boolean isAttached()
```
    Specified by:
    
    isAttached in interface IRBTNode<E extends Comparable<E>>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class AbstractHeapRBTNode<E extends Comparable<E>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.joafip.redblacktree.entity.IRBTNode

Methods inherited from interface net.sf.joafip.redblacktree.entity.IRBTComparableNode

Field Detail

valueChanged

parentPositionInFile

leftPositionInFile

rightPositionInFile

colorSetted

color

numberOfChild

index

heapElementManager

Constructor Detail

AbstractHeapRBTNode

Method Detail

getHeapRecord

getPositionInFile

getLeftPositionInFile

getRightPositionInFile

getParentPositionInFile

setLeftPositionInFile

setRightPositionInFile

setParentPositionInFile

setParent

setLeft

setRight

getParent

getLeft

getRight

heapNode

isSentinel

isColorSetted

isBlack

isRed

setBlack

setRed

setColor

getColor

getNumberOfChild

setNumberOfChild

setIndex

getIndex

decrementNumberOfChild

incrementNumberOfChild

accept

isValueChanged

valueSetted

detach

isAttached

toString

hashCode

equals