org.apache.directory.mavibot.btree

Class PersistedValueHolder<V>

java.lang.Object

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

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

Type Parameters:

V - The value type

All Implemented Interfaces:

java.lang.Cloneable, ValueHolder<V>

class PersistedValueHolder<V>
extends AbstractValueHolder<V>

A holder to store the Values

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isDeserialized A flag set to true when the raw value has been deserialized
private boolean	isRawUpToDate A flag to signal that the raw value represent the serialized values in their last state
protected static org.slf4j.Logger	LOG The LoggerFactory used by this class
protected PersistedBTree<V,V>	parentBtree The parent BTree
private byte[]	raw The serialized value

Fields inherited from class org.apache.directory.mavibot.btree.AbstractValueHolder

nbArrayElems, valueArray, valueBtree, valueSerializer, valueThresholdLow, valueThresholdUp

Constructor Summary

Constructors

Constructor and Description
PersistedValueHolder(BTree<?,V> parentBtree, int nbValues, byte[] raw) Creates a new instance of a ValueHolder, containing the serialized values.
PersistedValueHolder(BTree<?,V> parentBtree, V... values) Creates a new instance of a ValueHolder, containing Values.

Method Summary

Modifier and Type	Method and Description
void	add(V value) Add a new value in the ValueHolder
private BTree<V,V>	build(PersistedBTree<V,V> btree, V[] dupKeyValues) Constructs the sub-BTree using bulkload instead of performing sequential inserts.
private void	checkAndDeserialize() Check that the values are stored as raw value
ValueHolder<V>	clone() Create a clone of this instance
boolean	contains(V checkedValue) Tells if a value is contained in this ValueHolder
protected void	createSubTree() Create a new Sub-BTree to store the values.
private void	deserializeArray() Deserialize the values stored in an array
private void	deserializeSubBtree() Deserialize the values stored in a sub-btree
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()
(package private) long	getOffset()
(package private) byte[]	getRaw()
protected void	manageSubTree() Push the sub-BTree into the RecordManager
V	remove(V value)
private V	removeFromArray(V value) Remove a value from an array
private V	removeFromBtree(V removedValue) Remove the value from a sub btree
V	replaceValueArray(V newValue) Replaces the single value present in the array.
(package private) void	setSubBtree(BTree<V,V> subBtree) Set the subBtree in the ValueHolder
int	size()
java.lang.String	toString()

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

btreeContains, isSubBtree

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

The LoggerFactory used by this class

parentBtree

protected PersistedBTree<V,V> parentBtree

The parent BTree

raw

private byte[] raw

The serialized value

isDeserialized

private boolean isDeserialized

A flag set to true when the raw value has been deserialized

isRawUpToDate

private boolean isRawUpToDate

A flag to signal that the raw value represent the serialized values in their last state

Constructor Detail

PersistedValueHolder

PersistedValueHolder(BTree<?,V> parentBtree,
                     int nbValues,
                     byte[] raw)

Creates a new instance of a ValueHolder, containing the serialized values.

Parameters:

parentBtree - the parent BTree

raw - The raw data containing the values

nbValues - the number of stored values

raw - the byte[] containing either the serialized array of values or the sub-btree offset

PersistedValueHolder

PersistedValueHolder(BTree<?,V> parentBtree,
                     V... values)

Creates a new instance of a ValueHolder, containing Values. This constructor is called when we need to create a new ValueHolder with deserialized values.

Parameters:

parentBtree - The parent BTree

values - The Values stored in the ValueHolder

Method Detail

getCursor

public ValueCursor<V> getCursor()

Specified by:

getCursor in interface ValueHolder<V>

Overrides:

getCursor in class AbstractValueHolder<V>

Returns:

a cursor on top of the values

getRaw

byte[] getRaw()

Returns:

the raw representation of the value holder. The serialized value will not be the same if the values are stored in an array or in a btree.
If they are stored in a BTree, the raw value will contain the offset of the btree, otherwise it will contain a byte[] which will contain each serialized value, prefixed by their length.

size

public int size()

createSubTree

protected void createSubTree()

Create a new Sub-BTree to store the values.

Specified by:

createSubTree in class AbstractValueHolder<V>

manageSubTree

protected void manageSubTree()

Push the sub-BTree into the RecordManager

Specified by:

manageSubTree in class AbstractValueHolder<V>

setSubBtree

void setSubBtree(BTree<V,V> subBtree)

Set the subBtree in the ValueHolder

checkAndDeserialize

private void checkAndDeserialize()

Check that the values are stored as raw value

add

public void add(V value)

Add a new value in the ValueHolder

Specified by:

add in interface ValueHolder<V>

Overrides:

add in class AbstractValueHolder<V>

Parameters:

value - The added value

removeFromArray

private V removeFromArray(V value)

Remove a value from an array

removeFromBtree

private V removeFromBtree(V removedValue)

Remove the value from a sub btree

remove

public V remove(V value)

contains

public boolean contains(V checkedValue)

Tells if a value is contained in this ValueHolder

Specified by:

contains in interface ValueHolder<V>

Overrides:

contains in class AbstractValueHolder<V>

Parameters:

checkedValue - The added to check

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 ...

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 AbstractValueHolder<V>

Returns:

a new instance of a ValueHolder

Throws:

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

replaceValueArray

public V replaceValueArray(V newValue)

Description copied from class: AbstractValueHolder

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>

Overrides:

replaceValueArray in class AbstractValueHolder<V>

Parameters:

newValue - the new value

Returns:

the value that was replaced

deserializeArray

private void deserializeArray()

Deserialize the values stored in an array

deserializeSubBtree

private void deserializeSubBtree()

Deserialize the values stored in a sub-btree

getOffset

long getOffset()

Returns:

The sub-btree offset

build

private BTree<V,V> build(PersistedBTree<V,V> btree,
                         V[] dupKeyValues)
                  throws java.lang.Exception

Constructs the sub-BTree using bulkload instead of performing sequential inserts.

Parameters:

btree - the sub-BTtree to be constructed

dupKeyValues - the array of values to be inserted as keys

Returns:

The created BTree

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()