org.apache.directory.mavibot.btree

Class AbstractValueHolder<V>

java.lang.Object

org.apache.directory.mavibot.btree.AbstractValueHolder<V>

Type Parameters:

V - The value type

All Implemented Interfaces:

java.lang.Cloneable, ValueHolder<V>

Direct Known Subclasses:

InMemoryValueHolder, PersistedValueHolder

abstract class AbstractValueHolder<V>
extends java.lang.Object
implements ValueHolder<V>

A holder to store the Values

Field Summary

Fields

Modifier and Type	Field and Description
protected int	nbArrayElems
protected V[]	valueArray The array storing from 1 to N values
protected BTree<V,V>	valueBtree The BTree storing multiple value, if we have more than one value
protected ElementSerializer<V>	valueSerializer The Value serializer
protected int	valueThresholdLow
protected int	valueThresholdUp The configuration for the array <-> BTree switch.

Constructor Summary

Constructors

Constructor and Description
AbstractValueHolder()

Method Summary

Modifier and Type	Method and Description
void	add(V value) Add a new value in the ValueHolder
private void	addInArray(V value) Add the value in an array
private void	addInBtree(V value) Add the value in the subBTree
private boolean	arrayContains(V value) Check if the array of values contains a given value
protected boolean	btreeContains(V value) Check if the subBtree contains a given value
ValueHolder<V>	clone() Create a clone of this instance
boolean	contains(V checkedValue) Tells if a value is contained in this ValueHolder
protected abstract void	createSubTree() Create a new Sub-BTree to store the values.
private int	findPos(V value) Find the position of a given value in the array, or the position where we would insert the element (in this case, the position will be negative).
ValueCursor<V>	getCursor()
boolean	isSubBtree()
protected abstract void	manageSubTree() Manage a new Sub-BTree .
V	replaceValueArray(V newValue) Replaces the single value present in the array.

Methods inherited from class java.lang.Object

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

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

remove, size

Field Detail

valueBtree

protected BTree<V,V> valueBtree

The BTree storing multiple value, if we have more than one value

valueArray

protected V[] valueArray

The array storing from 1 to N values

valueSerializer

protected ElementSerializer<V> valueSerializer

The Value serializer

valueThresholdUp

protected int valueThresholdUp

The configuration for the array <-> BTree switch. Default to 1

valueThresholdLow

protected int valueThresholdLow

nbArrayElems

protected int nbArrayElems

Constructor Detail

AbstractValueHolder

AbstractValueHolder()

Method Detail

isSubBtree

public boolean isSubBtree()

Specified by:

isSubBtree in interface ValueHolder<V>

Returns:

true if we store the values in a sub btree

clone

public ValueHolder<V> clone()
                     throws java.lang.CloneNotSupportedException

Create a clone of this instance

Specified by:

clone in interface ValueHolder<V>

Overrides:

clone in class java.lang.Object

Returns:

a new instance of a ValueHolder

Throws:

java.lang.CloneNotSupportedException - If we can't clone this instance

getCursor

public ValueCursor<V> getCursor()

Specified by:

getCursor in interface ValueHolder<V>

Returns:

a cursor on top of the values

findPos

private int findPos(V value)

Find the position of a given value in the array, or the position where we would insert the element (in this case, the position will be negative). As we use a 0-based array, the negative position for 0 is -1. -1 means the element can be added in position 0 -2 means the element can be added in position 1 ...

arrayContains

private boolean arrayContains(V value)

Check if the array of values contains a given value

btreeContains

protected boolean btreeContains(V value)

Check if the subBtree contains a given value

contains

public boolean contains(V checkedValue)

Tells if a value is contained in this ValueHolder

Specified by:

contains in interface ValueHolder<V>

Parameters:

checkedValue - The added to check

createSubTree

protected abstract void createSubTree()

Create a new Sub-BTree to store the values.

manageSubTree

protected abstract void manageSubTree()

Manage a new Sub-BTree .

addInArray

private void addInArray(V value)

Add the value in an array

addInBtree

private void addInBtree(V value)

Add the value in the subBTree

add

public void add(V value)

Add a new value in the ValueHolder

Specified by:

add in interface ValueHolder<V>

Parameters:

value - The added value

replaceValueArray

public V replaceValueArray(V newValue)

Replaces the single value present in the array. This is only applicable for B-Trees that don't support duplicate values.

Specified by:

replaceValueArray in interface ValueHolder<V>

Parameters:

newValue - the new value

Returns:

the value that was replaced