org.fusesource.hawtdb.internal.index

Class BTreeIndex<Key,Value>

java.lang.Object

org.fusesource.hawtdb.internal.index.BTreeIndex<Key,Value>

All Implemented Interfaces:

Iterable<Map.Entry<Key,Value>>, Index<Key,Value>, SortedIndex<Key,Value>

public class BTreeIndex<Key,Value>
extends Object
implements SortedIndex<Key,Value>

A variable magnitude b+tree indexes with support for optional simple-prefix optimization.

Author:

Hiram Chirino

Constructor Summary

Constructors

Constructor and Description
BTreeIndex(Paged paged, int page, BTreeIndexFactory<Key,Value> factory)

Method Summary

Modifier and Type	Method and Description
void	clear() clear the index
boolean	containsKey(Key key)
void	create()
void	destroy() Frees any extra storage that the index created.
Value	get(Key key)
Comparator	getComparator()
Map.Entry<Key,Value>	getFirst()
int	getIndexLocation()
org.fusesource.hawtbuf.codec.Codec<Key>	getKeyMarshaller()
Map.Entry<Key,Value>	getLast()
int	getMaxLeafDepth()
int	getMinLeafDepth()
Paged	getPaged()
Prefixer<Key>	getPrefixer()
org.fusesource.hawtbuf.codec.Codec<Value>	getValueMarshaller()
boolean	isEmpty()
Iterator<Map.Entry<Key,Value>>	iterator()
Iterator<Map.Entry<Key,Value>>	iterator(Key initialKey)
Iterator<Map.Entry<Key,Value>>	iterator(Predicate<Key> predicate)
void	printStructure(OutputStream out)
void	printStructure(PrintWriter out)
Value	put(Key key, Value value) store the key, item
Value	putIfAbsent(Key key, Value value) get the value at the given key, or put it if null.
Value	remove(Key key) remove the index key
int	size()
String	toString()
void	visit(IndexVisitor<Key,Value> visitor) Traverses the visitor over the stored entries in this index.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BTreeIndex

public BTreeIndex(Paged paged,
                  int page,
                  BTreeIndexFactory<Key,Value> factory)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

create

public void create()

containsKey

public boolean containsKey(Key key)

Specified by:

containsKey in interface Index<Key,Value>

Returns:

true if it contains the key

get

public Value get(Key key)

Specified by:

get in interface Index<Key,Value>

Returns:

the entry

put

public Value put(Key key,
                 Value value)

Description copied from interface: Index

store the key, item

Specified by:

put in interface Index<Key,Value>

putIfAbsent

public Value putIfAbsent(Key key,
                         Value value)

Description copied from interface: Index

get the value at the given key, or put it if null.

Specified by:

putIfAbsent in interface Index<Key,Value>

remove

public Value remove(Key key)

Description copied from interface: Index

remove the index key

Specified by:

remove in interface Index<Key,Value>

Returns:

StoreEntry removed

size

public int size()

Specified by:

size in interface Index<Key,Value>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Index<Key,Value>

clear

public void clear()

Description copied from interface: Index

clear the index

Specified by:

clear in interface Index<Key,Value>

getMinLeafDepth

public int getMinLeafDepth()

getMaxLeafDepth

public int getMaxLeafDepth()

printStructure

public void printStructure(PrintWriter out)

printStructure

public void printStructure(OutputStream out)

iterator

public Iterator<Map.Entry<Key,Value>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<Key,Value>>

Specified by:

iterator in interface SortedIndex<Key,Value>

iterator

public Iterator<Map.Entry<Key,Value>> iterator(Predicate<Key> predicate)

Specified by:

iterator in interface SortedIndex<Key,Value>

Returns:

iterator

public Iterator<Map.Entry<Key,Value>> iterator(Key initialKey)

Specified by:

iterator in interface SortedIndex<Key,Value>

Returns:

visit

public void visit(IndexVisitor<Key,Value> visitor)

Description copied from interface: SortedIndex

Traverses the visitor over the stored entries in this index. The visitor can control which keys and values are visited.

Specified by:

visit in interface SortedIndex<Key,Value>

getFirst

public Map.Entry<Key,Value> getFirst()

Specified by:

getFirst in interface SortedIndex<Key,Value>

Returns:

the first key/value pair in the index or null if empty.

getLast

public Map.Entry<Key,Value> getLast()

Specified by:

getLast in interface SortedIndex<Key,Value>

Returns:

the last key/value pair in the index or null if empty.

getPaged

public Paged getPaged()

getIndexLocation

public int getIndexLocation()

Specified by:

getIndexLocation in interface Index<Key,Value>

Returns:

the location where index root resides on the page file.

getKeyMarshaller

public org.fusesource.hawtbuf.codec.Codec<Key> getKeyMarshaller()

getValueMarshaller

public org.fusesource.hawtbuf.codec.Codec<Value> getValueMarshaller()

getPrefixer

public Prefixer<Key> getPrefixer()

getComparator

public Comparator getComparator()

destroy

public void destroy()

Description copied from interface: Index

Frees any extra storage that the index created.

Specified by:

destroy in interface Index<Key,Value>