org.apache.directory.mavibot.btree

Class BTreeFactory<K,V>

java.lang.Object

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

Type Parameters:

K - The B-tree key type

V - The B-tree value type

public class BTreeFactory<K,V>
extends java.lang.Object

This class construct a B-tree from a serialized version of a B-tree. We need it to avoid exposing all the methods of the B-tree class.
All its methods are static.

Constructor Summary

Constructors

Constructor and Description
BTreeFactory()

Method Summary

Modifier and Type	Method and Description
static <K,V> BTree<K,V>	createInMemoryBTree() Creates a new in-memory B-tree, with no initialization.
static <K,V> BTree<K,V>	createInMemoryBTree(InMemoryBTreeConfiguration<K,V> configuration) Creates a new in-memory B-tree using the BTreeConfiguration to initialize the B-tree
static <K,V> BTree<K,V>	createInMemoryBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer) Creates a new in-memory B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createInMemoryBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, boolean allowDuplicates) Creates a new in-memory B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createInMemoryBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, int pageSize) Creates a new in-memory B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createInMemoryBTree(java.lang.String name, java.lang.String filePath, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer) Creates a new in-memory B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createInMemoryBTree(java.lang.String name, java.lang.String filePath, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, int pageSize) Creates a new in-memory B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createInMemoryBTree(java.lang.String name, java.lang.String filePath, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, int pageSize, boolean allowDuplicates) Creates a new in-memory B-tree using the parameters to initialize the B-tree
(package private) static <K,V> Page<K,V>	createLeaf(BTree<K,V> btree, long revision, int nbElems) Create a new Leaf for the given B-tree.
(package private) static <K,V> Page<K,V>	createNode(BTree<K,V> btree, long revision, int nbElems) Create a new Node for the given B-tree.
static <K,V> BTree<K,V>	createPersistedBTree() Creates a new persisted B-tree, with no initialization.
static <K,V> BTree<K,V>	createPersistedBTree(BTreeTypeEnum type) Creates a new persisted B-tree, with no initialization.
static <K,V> BTree<K,V>	createPersistedBTree(PersistedBTreeConfiguration<K,V> configuration) Creates a new persisted B-tree using the BTreeConfiguration to initialize the B-tree
static <K,V> BTree<K,V>	createPersistedBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer) Creates a new persisted B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createPersistedBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, boolean allowDuplicates) Creates a new persisted B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createPersistedBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, boolean allowDuplicates, int cacheSize) Creates a new persisted B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createPersistedBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, int pageSize) Creates a new persisted B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createPersistedBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, int pageSize, boolean allowDuplicates) Creates a new persisted B-tree using the parameters to initialize the B-tree
static <K,V> BTree<K,V>	createPersistedBTree(java.lang.String name, ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer, int pageSize, boolean allowDuplicates, int cacheSize) Creates a new persisted B-tree using the parameters to initialize the B-tree
(package private) static <K,V> java.util.LinkedList<ParentPos<K,V>>	getPathToLeftMostLeaf(BTree<K,V> btree) Includes the intermediate nodes in the path up to and including the left most leaf of the tree
(package private) static <K,V> java.util.LinkedList<ParentPos<K,V>>	getPathToRightMostLeaf(BTree<K,V> btree) Includes the intermediate nodes in the path up to and including the right most leaf of the tree
(package private) static <K,V> Page<K,V>	getRootPage(BTree<K,V> btree) Return the B-tree root page
static <K,V> void	setBtreeHeaderOffset(PersistedBTree<K,V> btree, long btreeHeaderOffset) Sets the btreeHeader offset for a Persisted BTree
(package private) static <K,V> void	setKey(BTree<K,V> btree, Page<K,V> page, int pos, byte[] buffer) Set the key at a give position
(package private) static <K,V> void	setKey(BTree<K,V> btree, Page<K,V> page, int pos, K key) Set the key at a give position
(package private) static <K,V> void	setKeySerializer(BTree<K,V> btree, java.lang.String keySerializerFqcn) Sets the KeySerializer into the B-tree
(package private) static <K,V> void	setName(BTree<K,V> btree, java.lang.String name) Set the B-tree name
(package private) static <K,V> void	setNbElems(BTree<K,V> btree, long nbElems) Update the B-tree number of elements
(package private) static <K,V> void	setPage(BTree<K,V> btree, Page<K,V> page, int pos, Page<K,V> child) Set the page at a give position
(package private) static <K,V> void	setPageSize(BTree<K,V> btree, int pageSize) Set the maximum number of elements we can store in a page.
(package private) static <K,V> void	setRecordManager(BTree<K,V> btree, RecordManager recordManager) Set the RecordManager
(package private) static <K,V> void	setRevision(BTree<K,V> btree, long revision) Update the B-tree revision
(package private) static <K,V> void	setRootPage(BTree<K,V> btree, Page<K,V> root) Set the new root page for this tree.
(package private) static <K,V> void	setRootPageOffset(BTree<K,V> btree, long rootPageOffset) Set the rootPage offset of the B-tree
(package private) static <K,V> void	setValue(BTree<K,V> btree, Page<K,V> page, int pos, ValueHolder<V> value) Set the value at a give position
(package private) static <K,V> void	setValueSerializer(BTree<K,V> btree, java.lang.String valueSerializerFqcn) Sets the ValueSerializer into the B-tree

Methods inherited from class java.lang.Object

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

Constructor Detail

BTreeFactory

public BTreeFactory()

Method Detail

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree()

Creates a new persisted B-tree, with no initialization.

Returns:

a new B-tree instance

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(BTreeTypeEnum type)

Creates a new persisted B-tree, with no initialization.

Returns:

a new B-tree instance

setBtreeHeaderOffset

public static <K,V> void setBtreeHeaderOffset(PersistedBTree<K,V> btree,
                                              long btreeHeaderOffset)

Sets the btreeHeader offset for a Persisted BTree

Parameters:

btree - The btree to update

btreeHeaderOffset - The offset

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(PersistedBTreeConfiguration<K,V> configuration)

Creates a new persisted B-tree using the BTreeConfiguration to initialize the B-tree

Parameters:

configuration - The configuration to use

Returns:

a new B-tree instance

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(java.lang.String name,
                                                    ElementSerializer<K> keySerializer,
                                                    ElementSerializer<V> valueSerializer)

Creates a new persisted B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

Returns:

a new B-tree instance

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(java.lang.String name,
                                                    ElementSerializer<K> keySerializer,
                                                    ElementSerializer<V> valueSerializer,
                                                    boolean allowDuplicates)

Creates a new persisted B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

allowDuplicates - Tells if the B-tree allows multiple value for a given key

Returns:

a new B-tree instance

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(java.lang.String name,
                                                    ElementSerializer<K> keySerializer,
                                                    ElementSerializer<V> valueSerializer,
                                                    boolean allowDuplicates,
                                                    int cacheSize)

Creates a new persisted B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

allowDuplicates - Tells if the B-tree allows multiple value for a given key

cacheSize - The size to be used for this B-tree cache

Returns:

a new B-tree instance

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(java.lang.String name,
                                                    ElementSerializer<K> keySerializer,
                                                    ElementSerializer<V> valueSerializer,
                                                    int pageSize)

Creates a new persisted B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

pageSize - Size of the page

Returns:

a new B-tree instance

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(java.lang.String name,
                                                    ElementSerializer<K> keySerializer,
                                                    ElementSerializer<V> valueSerializer,
                                                    int pageSize,
                                                    boolean allowDuplicates)

Creates a new persisted B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

pageSize - Size of the page

allowDuplicates - Tells if the B-tree allows multiple value for a given key

Returns:

a new B-tree instance

createPersistedBTree

public static <K,V> BTree<K,V> createPersistedBTree(java.lang.String name,
                                                    ElementSerializer<K> keySerializer,
                                                    ElementSerializer<V> valueSerializer,
                                                    int pageSize,
                                                    boolean allowDuplicates,
                                                    int cacheSize)

Creates a new persisted B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

pageSize - Size of the page

allowDuplicates - Tells if the B-tree allows multiple value for a given key

cacheSize - The size to be used for this B-tree cache

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree()

Creates a new in-memory B-tree, with no initialization.

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree(InMemoryBTreeConfiguration<K,V> configuration)

Creates a new in-memory B-tree using the BTreeConfiguration to initialize the B-tree

Parameters:

configuration - The configuration to use

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree(java.lang.String name,
                                                   ElementSerializer<K> keySerializer,
                                                   ElementSerializer<V> valueSerializer)

Creates a new in-memory B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree(java.lang.String name,
                                                   ElementSerializer<K> keySerializer,
                                                   ElementSerializer<V> valueSerializer,
                                                   boolean allowDuplicates)

Creates a new in-memory B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

allowDuplicates - Tells if the B-tree allows multiple value for a given key

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree(java.lang.String name,
                                                   ElementSerializer<K> keySerializer,
                                                   ElementSerializer<V> valueSerializer,
                                                   int pageSize)

Creates a new in-memory B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

keySerializer - Key serializer

valueSerializer - Value serializer

pageSize - Size of the page

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree(java.lang.String name,
                                                   java.lang.String filePath,
                                                   ElementSerializer<K> keySerializer,
                                                   ElementSerializer<V> valueSerializer)

Creates a new in-memory B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

filePath - The name of the data directory with absolute path

keySerializer - Key serializer

valueSerializer - Value serializer

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree(java.lang.String name,
                                                   java.lang.String filePath,
                                                   ElementSerializer<K> keySerializer,
                                                   ElementSerializer<V> valueSerializer,
                                                   int pageSize)

Creates a new in-memory B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

filePath - The name of the data directory with absolute path

keySerializer - Key serializer

valueSerializer - Value serializer

pageSize - Size of the page

Returns:

a new B-tree instance

createInMemoryBTree

public static <K,V> BTree<K,V> createInMemoryBTree(java.lang.String name,
                                                   java.lang.String filePath,
                                                   ElementSerializer<K> keySerializer,
                                                   ElementSerializer<V> valueSerializer,
                                                   int pageSize,
                                                   boolean allowDuplicates)

Creates a new in-memory B-tree using the parameters to initialize the B-tree

Parameters:

name - The B-tree's name

filePath - The name of the data directory with absolute path

keySerializer - Key serializer

valueSerializer - Value serializer

pageSize - Size of the page

allowDuplicates - Tells if the B-tree allows multiple value for a given key

Returns:

a new B-tree instance

createLeaf

static <K,V> Page<K,V> createLeaf(BTree<K,V> btree,
                                  long revision,
                                  int nbElems)

Create a new Leaf for the given B-tree.

Parameters:

btree - The B-tree which will contain this leaf

revision - The Leaf's revision

nbElems - The number or elements in this leaf

Returns:

A Leaf instance

createNode

static <K,V> Page<K,V> createNode(BTree<K,V> btree,
                                  long revision,
                                  int nbElems)

Create a new Node for the given B-tree.

Parameters:

btree - The B-tree which will contain this node

revision - The Node's revision

nbElems - The number or elements in this node

Returns:

A Node instance

setKey

static <K,V> void setKey(BTree<K,V> btree,
                         Page<K,V> page,
                         int pos,
                         K key)

Set the key at a give position

Parameters:

btree - The B-tree to update

page - The page to update

pos - The position in the keys array

key - The key to inject

setValue

static <K,V> void setValue(BTree<K,V> btree,
                           Page<K,V> page,
                           int pos,
                           ValueHolder<V> value)

Set the value at a give position

Parameters:

btree - The B-tree to update

page - The page to update

pos - The position in the values array

value - the value to inject

setPage

static <K,V> void setPage(BTree<K,V> btree,
                          Page<K,V> page,
                          int pos,
                          Page<K,V> child)

Set the page at a give position

Parameters:

btree - The B-tree to update

page - The page to update

pos - The position in the values array

child - the child page to inject

setKeySerializer

static <K,V> void setKeySerializer(BTree<K,V> btree,
                                   java.lang.String keySerializerFqcn)
                            throws java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.InstantiationException,
                                   java.lang.IllegalArgumentException,
                                   java.lang.SecurityException,
                                   java.lang.NoSuchFieldException

Sets the KeySerializer into the B-tree

Parameters:

btree - The B-tree to update

keySerializerFqcn - the Key serializer FQCN to set

Throws:

java.lang.ClassNotFoundException - If the key serializer class cannot be found

java.lang.InstantiationException - If the key serializer class cannot be instanciated

java.lang.IllegalAccessException - If the key serializer class cannot be accessed

java.lang.NoSuchFieldException

java.lang.SecurityException

java.lang.IllegalArgumentException

setValueSerializer

static <K,V> void setValueSerializer(BTree<K,V> btree,
                                     java.lang.String valueSerializerFqcn)
                              throws java.lang.ClassNotFoundException,
                                     java.lang.IllegalAccessException,
                                     java.lang.InstantiationException,
                                     java.lang.IllegalArgumentException,
                                     java.lang.SecurityException,
                                     java.lang.NoSuchFieldException

Sets the ValueSerializer into the B-tree

Parameters:

btree - The B-tree to update

valueSerializerFqcn - the Value serializer FQCN to set

Throws:

java.lang.ClassNotFoundException - If the value serializer class cannot be found

java.lang.InstantiationException - If the value serializer class cannot be instanciated

java.lang.IllegalAccessException - If the value serializer class cannot be accessed

java.lang.NoSuchFieldException

java.lang.SecurityException

java.lang.IllegalArgumentException

setRootPage

static <K,V> void setRootPage(BTree<K,V> btree,
                              Page<K,V> root)

Set the new root page for this tree. Used for debug purpose only. The revision will always be 0;

Parameters:

btree - The B-tree to update

root - the new root page.

getRootPage

static <K,V> Page<K,V> getRootPage(BTree<K,V> btree)

Return the B-tree root page

Parameters:

btree - The B-tree we want to root page from

Returns:

The root page

setNbElems

static <K,V> void setNbElems(BTree<K,V> btree,
                             long nbElems)

Update the B-tree number of elements

Parameters:

btree - The B-tree to update

nbElems - the nbElems to set

setRevision

static <K,V> void setRevision(BTree<K,V> btree,
                              long revision)

Update the B-tree revision

Parameters:

btree - The B-tree to update

revision - the revision to set

setName

static <K,V> void setName(BTree<K,V> btree,
                          java.lang.String name)

Set the B-tree name

Parameters:

btree - The B-tree to update

name - the name to set

setPageSize

static <K,V> void setPageSize(BTree<K,V> btree,
                              int pageSize)

Set the maximum number of elements we can store in a page.

Parameters:

btree - The B-tree to update

pageSize - The requested page size

getPathToRightMostLeaf

static <K,V> java.util.LinkedList<ParentPos<K,V>> getPathToRightMostLeaf(BTree<K,V> btree)

Includes the intermediate nodes in the path up to and including the right most leaf of the tree

Parameters:

btree - the B-tree

Returns:

a LinkedList of all the nodes and the final leaf

setRootPageOffset

static <K,V> void setRootPageOffset(BTree<K,V> btree,
                                    long rootPageOffset)

Set the rootPage offset of the B-tree

Parameters:

btree - The B-tree to update

rootPageOffset - The rootPageOffset to set

setRecordManager

static <K,V> void setRecordManager(BTree<K,V> btree,
                                   RecordManager recordManager)

Set the RecordManager

Parameters:

btree - The B-tree to update

recordManager - The injected RecordManager

setKey

static <K,V> void setKey(BTree<K,V> btree,
                         Page<K,V> page,
                         int pos,
                         byte[] buffer)

Set the key at a give position

Parameters:

btree - The B-tree to update

page - The page to update

pos - The position of this key in the page

buffer - The byte[] containing the serialized key

getPathToLeftMostLeaf

static <K,V> java.util.LinkedList<ParentPos<K,V>> getPathToLeftMostLeaf(BTree<K,V> btree)

Includes the intermediate nodes in the path up to and including the left most leaf of the tree

Parameters:

btree - The B-tree to process

Returns:

a LinkedList of all the nodes and the final leaf