org.bluedb.api.index

Interface BlueIndex<K extends ValueKey,V extends java.io.Serializable>

Type Parameters:

K - the key type of the index or the type of data that the collection is being indexed on. It must be a concretion of ValueKey (UUIDKey, StringKey, LongKey, or IntegerKey).

V - the value type of the collection being indexed

All Known Implementing Classes:

BlueIndexOnDisk

public interface BlueIndex<K extends ValueKey,V extends java.io.Serializable>

An index on a BlueCollection that allows you to query for values faster based on specific data in those values. BlueDB extracts data from each value in the collection and creates a mapping from that data to the values that contain that data. Currently this only supports the retrieval of values using a specific index key, but could be extended in the future to provide more powerful index based queries.

Method Summary

Modifier and Type	Method and Description
java.util.List<V>	get(K key)
K	getLastKey()

Method Detail

get

java.util.List<V> get(K key)
               throws BlueDbException

Parameters:

key - a key that maps to the desired value(s)

Returns:

all the values in the collection for the given index key

Throws:

BlueDbException - if any problems occur

getLastKey

K getLastKey()

Returns:

the index key with the highest grouping number