org.fusesource.hawtdb.api

Interface Index<Key,Value>

All Known Subinterfaces:

SortedIndex<Key,Value>

All Known Implementing Classes:

BTreeIndex, HashIndex

public interface Index<Key,Value>

Provides Key/Value storage and retrieval.

Author:

Hiram Chirino

Method Summary

Modifier and Type	Method and Description
void	clear() clear the index
boolean	containsKey(Key key)
void	destroy() Frees any extra storage that the index created.
Value	get(Key key)
int	getIndexLocation()
boolean	isEmpty()
Value	put(Key key, Value entry) store the key, item
Value	putIfAbsent(Key key, Value entry) get the value at the given key, or put it if null.
Value	remove(Key key) remove the index key
int	size()

Method Detail

destroy

void destroy()

Frees any extra storage that the index created.

clear

void clear()

clear the index

Throws:

IOException

containsKey

boolean containsKey(Key key)

Parameters:

key -

Returns:

true if it contains the key

Throws:

IOException

remove

Value remove(Key key)

remove the index key

Parameters:

key -

Returns:

StoreEntry removed

Throws:

IOException

put

Value put(Key key,
          Value entry)

store the key, item

Parameters:

key -

entry -

Throws:

IOException

putIfAbsent

Value putIfAbsent(Key key,
                  Value entry)

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

Parameters:

key -

entry -

Throws:

IOException

get

Value get(Key key)

Parameters:

key -

Returns:

the entry

Throws:

IOException

size

int size()

isEmpty

boolean isEmpty()

getIndexLocation

int getIndexLocation()

Returns:

the location where index root resides on the page file.