com.yahoo.bard.webservice.data.cache

Interface TupleDataCache<K,M extends Serializable,V extends Serializable>

Type Parameters:

K - The key type of the cache.

M - The metadata type of the cache.

V - The raw data type of the cache.

All Superinterfaces:

DataCache<TupleDataCache.DataEntry<K,M,V>>

All Known Implementing Classes:

MemTupleDataCache

public interface TupleDataCache<K,M extends Serializable,V extends Serializable>
extends DataCache<TupleDataCache.DataEntry<K,M,V>>

Versatile data cache interface that allows for parametrized types for the key, the metadata and the raw data value of an entry.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TupleDataCache.DataEntry<K,M,V> A data cache entry defined as a tuple consisting of key, metadata, and value fields.

Method Summary

Modifier and Type	Method and Description
TupleDataCache.DataEntry<K,M,V>	get(String key) Retrieve the complete data entry from the cache.
V	getDataValue(K key) Read the raw data from cache.
boolean	set(K key, M meta, V value) Given a key, put a complete data entry in the data cache.

Methods inherited from interface com.yahoo.bard.webservice.data.cache.DataCache

clear, set

Method Detail

get

TupleDataCache.DataEntry<K,M,V> get(String key)

Retrieve the complete data entry from the cache.

Specified by:

get in interface DataCache<TupleDataCache.DataEntry<K,M extends Serializable,V extends Serializable>>

Parameters:

key - The key associated with data entry to be retrieved

Returns:

The complete data entry containing metadata and raw data, or null if the cache contains no mapping for the key

getDataValue

V getDataValue(K key)

Read the raw data from cache.

Parameters:

key - The key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

set

boolean set(K key,
            M meta,
            V value)

Given a key, put a complete data entry in the data cache.

Parameters:

key - The key of the cache entry.

meta - The metadata associated with the raw data.

value - The raw data to store in to the cache.

Returns:

true if the entry is stored successfully; false otherwise.

Throws:

IllegalStateException - in the rare circumstance where queue is too full to accept any more requests