org.apache.directory.mavibot.btree

Class AbstractBorrowedFromSiblingResult<K,V>

java.lang.Object

org.apache.directory.mavibot.btree.AbstractResult<K,V>

org.apache.directory.mavibot.btree.AbstractDeleteResult<K,V>

org.apache.directory.mavibot.btree.AbstractBorrowedFromSiblingResult<K,V>

Type Parameters:

K - The type for the Key

V - The type for the stored value

All Implemented Interfaces:

BorrowedFromSiblingResult<K,V>, DeleteResult<K,V>, Result<Page<K,V>>

Direct Known Subclasses:

BorrowedFromLeftResult, BorrowedFromRightResult

abstract class AbstractBorrowedFromSiblingResult<K,V>
extends AbstractDeleteResult<K,V>
implements BorrowedFromSiblingResult<K,V>

The result of a delete operation, when the child has not been merged, and when we have borrowed an element from the left sibling. It contains the reference to the modified page, and the removed element.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractBorrowedFromSiblingResult.SiblingPosition The two possible position for the sibling

Field Summary

Fields

Modifier and Type	Field and Description
private Page<K,V>	modifiedSibling The modified sibling reference
protected AbstractBorrowedFromSiblingResult.SiblingPosition	position Tells if the sibling is the left or right one

Constructor Summary

Constructors

Constructor and Description
AbstractBorrowedFromSiblingResult(java.util.List<Page<K,V>> copiedPages, Page<K,V> modifiedPage, Page<K,V> modifiedSibling, Tuple<K,V> removedElement, AbstractBorrowedFromSiblingResult.SiblingPosition position) A constructor for RemoveResult with a list of copied pages.
AbstractBorrowedFromSiblingResult(Page<K,V> modifiedPage, Page<K,V> modifiedSibling, Tuple<K,V> removedElement, AbstractBorrowedFromSiblingResult.SiblingPosition position) The default constructor for RemoveResult.

Method Summary

Modifier and Type	Method and Description
Page<K,V>	getModifiedSibling()
boolean	isFromLeft() Tells if the sibling is on the left
boolean	isFromRight() Tells if the sibling is on the right
java.lang.String	toString()

Methods inherited from class org.apache.directory.mavibot.btree.AbstractDeleteResult

getModifiedPage, getRemovedElement, setModifiedPage

Methods inherited from class org.apache.directory.mavibot.btree.AbstractResult

addCopiedPage, getCopiedPages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.mavibot.btree.DeleteResult

getModifiedPage, getRemovedElement

Methods inherited from interface org.apache.directory.mavibot.btree.Result

addCopiedPage, getCopiedPages

Field Detail

modifiedSibling

private Page<K,V> modifiedSibling

The modified sibling reference

position

protected AbstractBorrowedFromSiblingResult.SiblingPosition position

Tells if the sibling is the left or right one

Constructor Detail

AbstractBorrowedFromSiblingResult

AbstractBorrowedFromSiblingResult(Page<K,V> modifiedPage,
                                  Page<K,V> modifiedSibling,
                                  Tuple<K,V> removedElement,
                                  AbstractBorrowedFromSiblingResult.SiblingPosition position)

The default constructor for RemoveResult.

Parameters:

modifiedPage - The modified page

modifiedSibling - The modified sibling

removedElement - The removed element (can be null if the key wasn't present in the tree)

AbstractBorrowedFromSiblingResult

AbstractBorrowedFromSiblingResult(java.util.List<Page<K,V>> copiedPages,
                                  Page<K,V> modifiedPage,
                                  Page<K,V> modifiedSibling,
                                  Tuple<K,V> removedElement,
                                  AbstractBorrowedFromSiblingResult.SiblingPosition position)

A constructor for RemoveResult with a list of copied pages.

Parameters:

copiedPages - the list of copied pages

modifiedPage - The modified page

modifiedSibling - The modified sibling

removedElement - The removed element (can be null if the key wasn't present in the tree)

Method Detail

getModifiedSibling

public Page<K,V> getModifiedSibling()

Specified by:

getModifiedSibling in interface BorrowedFromSiblingResult<K,V>

Returns:

the modifiedSibling

isFromLeft

public boolean isFromLeft()

Tells if the sibling is on the left

Specified by:

isFromLeft in interface BorrowedFromSiblingResult<K,V>

Returns:

True if the sibling is on the left

isFromRight

public boolean isFromRight()

Tells if the sibling is on the right

Specified by:

isFromRight in interface BorrowedFromSiblingResult<K,V>

Returns:

True if the sibling is on the right

toString

public java.lang.String toString()

Overrides:

toString in class AbstractResult<K,V>

See Also:

Object.toString()