org.openimaj.data.dataset.cache

Interface GroupedListCache<KEY,OBJECT>

Type Parameters:

OBJECT - Type of instances

KEY - Type of groups

All Known Implementing Classes:

InMemoryGroupedListCache

public interface GroupedListCache<KEY,OBJECT>

Definition of a cache for groups of lists.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
void	add(Collection<KEY> keys, OBJECT object) Add an object with many keys to the cache
void	add(KEY key, Collection<OBJECT> objects) Add an collection of objects with the same key to the cache
void	add(KEY key, OBJECT object) Add an object with a key to the cache
GroupedDataset<KEY,ListDataset<OBJECT>,OBJECT>	getDataset()
void	reset() Reset the cache

Method Detail

add

void add(Collection<KEY> keys,
         OBJECT object)

Add an object with many keys to the cache

Parameters:

keys - the instance's keys

object - the instance

add

void add(KEY key,
         OBJECT object)

Add an object with a key to the cache

Parameters:

key - the instance's key

object - the instance

add

void add(KEY key,
         Collection<OBJECT> objects)

Add an collection of objects with the same key to the cache

Parameters:

key - the instance's key

objects - the instances

getDataset

GroupedDataset<KEY,ListDataset<OBJECT>,OBJECT> getDataset()

Returns:

a dataset view of the cache

reset

void reset()

Reset the cache