net.thevpc.nuts.runtime.standalone.util.collections

Class NBPlusTreeImpl<K extends Comparable<K>,V>

java.lang.Object

java.util.AbstractMap<K,V>

net.thevpc.nuts.runtime.standalone.util.collections.NBPlusTreeImpl<K,V>

All Implemented Interfaces:

AutoCloseable, Map<K,V>, NBPlusTree<K,V>

public class NBPlusTreeImpl<K extends Comparable<K>,V>
extends AbstractMap<K,V>
implements NBPlusTree<K,V>

Author:

vpc from inspired from https://github.com/shandysulen/B-Plus-Tree/blob/master/bplustree.java (MIT) changed to support multiple stores and generic parameters

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface net.thevpc.nuts.util.NBPlusTree

NBPlusTree.IntermediateNode<K extends Comparable<K>,V>, NBPlusTree.LeafNode<K extends Comparable<K>,V>, NBPlusTree.Node<K extends Comparable<K>,V>, NBPlusTree.Visitor<K extends Comparable<K>,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
NBPlusTreeImpl(NBPlusTreeStore<K,V> store)

Method Summary

Modifier and Type	Method and Description
V	add(K key, V value, boolean allowDuplicate)
void	close()
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
void	dump()
void	dump(PrintStream out)
Iterator<Map.Entry<K,V>>	entryIterator()
Set<Map.Entry<K,V>>	entrySet()
V	get(K key)
NOptional<V>	getOptional(K key)
boolean	isEmpty() This is a simple method that determines if the B+ tree is empty or not.
Iterator<K>	keyIterator()
static <K extends Comparable<K>,V> NBPlusTreeImpl<K,V>	of(int m)
static <K extends Comparable<K>,V> NBPlusTreeImpl<K,V>	of(int m, boolean allowDuplicates)
V	put(K key, V value) Given an integer key and floating point value, this method inserts a dictionary pair accordingly into the B+ tree.
V	putIfAbsent(K key, V value)
boolean	remove(K key) Given a key, this method will remove the dictionary pair with the corresponding key from the B+ tree.
List<V>	search(K key)
List<V>	search(K lowerBound, K upperBound) This method traverses the doubly linked list of the B+ tree and records all values whose associated keys are within the range specified by lowerBound and upperBound.
int	size()
long	sizeLong()
void	visit(NBPlusTree.Visitor<K,V> visitor)

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, equals, get, hashCode, keySet, putAll, remove, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, compute, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, keySet, merge, putAll, remove, remove, replace, replace, replaceAll, values

Constructor Detail

NBPlusTreeImpl

public NBPlusTreeImpl(NBPlusTreeStore<K,V> store)

Method Detail

of

public static <K extends Comparable<K>,V> NBPlusTreeImpl<K,V> of(int m,
                                                                 boolean allowDuplicates)

Specified by:

of in interface NBPlusTree<K extends Comparable<K>,V>

of

public static <K extends Comparable<K>,V> NBPlusTreeImpl<K,V> of(int m)

Specified by:

of in interface NBPlusTree<K extends Comparable<K>,V>

isEmpty

public boolean isEmpty()

This is a simple method that determines if the B+ tree is empty or not.

Specified by:

isEmpty in interface Map<K extends Comparable<K>,V>

Overrides:

isEmpty in class AbstractMap<K extends Comparable<K>,V>

Returns:

a boolean indicating if the B+ tree is empty or not

size

public int size()

Specified by:

size in interface Map<K extends Comparable<K>,V>

Overrides:

size in class AbstractMap<K extends Comparable<K>,V>

sizeLong

public long sizeLong()

Specified by:

sizeLong in interface NBPlusTree<K extends Comparable<K>,V>

remove

public boolean remove(K key)

Given a key, this method will remove the dictionary pair with the corresponding key from the B+ tree.

Specified by:

remove in interface NBPlusTree<K extends Comparable<K>,V>

Parameters:

key: - an integer key that corresponds with an existing dictionary pair

put

public V put(K key,
             V value)

Given an integer key and floating point value, this method inserts a dictionary pair accordingly into the B+ tree.

Specified by:

put in interface Map<K extends Comparable<K>,V>

Overrides:

put in class AbstractMap<K extends Comparable<K>,V>

Parameters:

key: - an integer key to be used in the dictionary pair

value: - a floating point number to be used in the dictionary pair

putIfAbsent

public V putIfAbsent(K key,
                     V value)

Specified by:

putIfAbsent in interface Map<K extends Comparable<K>,V>

computeIfAbsent

public V computeIfAbsent(K key,
                         Function<? super K,? extends V> mappingFunction)

Specified by:

computeIfAbsent in interface Map<K extends Comparable<K>,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K extends Comparable<K>,V>

Specified by:

entrySet in class AbstractMap<K extends Comparable<K>,V>

add

public V add(K key,
             V value,
             boolean allowDuplicate)

Specified by:

add in interface NBPlusTree<K extends Comparable<K>,V>

entryIterator

public Iterator<Map.Entry<K,V>> entryIterator()

Specified by:

entryIterator in interface NBPlusTree<K extends Comparable<K>,V>

keyIterator

public Iterator<K> keyIterator()

Specified by:

keyIterator in interface NBPlusTree<K extends Comparable<K>,V>

search

public List<V> search(K key)

Specified by:

search in interface NBPlusTree<K extends Comparable<K>,V>

get

public V get(K key)

Specified by:

get in interface NBPlusTree<K extends Comparable<K>,V>

getOptional

public NOptional<V> getOptional(K key)

Specified by:

getOptional in interface NBPlusTree<K extends Comparable<K>,V>

search

public List<V> search(K lowerBound,
                      K upperBound)

This method traverses the doubly linked list of the B+ tree and records all values whose associated keys are within the range specified by lowerBound and upperBound.

Specified by:

search in interface NBPlusTree<K extends Comparable<K>,V>

Parameters:

lowerBound: - (int) the lower bound of the range

upperBound: - (int) the upper bound of the range

Returns:

a List that holds all values of dictionary pairs whose keys are within the specified range

dump

public void dump()

dump

public void dump(PrintStream out)

visit

public void visit(NBPlusTree.Visitor<K,V> visitor)

Specified by:

visit in interface NBPlusTree<K extends Comparable<K>,V>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NBPlusTree<K extends Comparable<K>,V>