io.appform.dropwizard.sharding.caching

Interface RelationalCache<V>

public interface RelationalCache<V>

A simple cache interface which allows plugging in any caching framework or infrastructure to enable write through caching

Method Summary

Modifier and Type	Method and Description
boolean	exists(String parentKey, Object key) Read through exists method that will be called if cache enabled RelationalDao.exists(String, Object) is used
V	get(String parentKey, Object key) Read through method that will be called if a cache enabled CacheableRelationalDao.get(String, Object) is used
void	put(String parentKey, int first, int numResults, List<V> entities) Write through method that will be called if cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used
void	put(String parentKey, List<V> entities) Write through method that will be called if cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used
void	put(String parentKey, Object key, V entity) Write through method that will be called if cache enabled CacheableRelationalDao.save(String, Object) is used
List<V>	select(String parentKey) Read through method that will be called if a cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used
List<V>	select(String parentKey, int first, int numResults) Read through method that will be called if a cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used

Method Detail

put

void put(String parentKey,
         Object key,
         V entity)

Write through method that will be called if cache enabled CacheableRelationalDao.save(String, Object) is used

Parameters:

parentKey - The key of the parent that the entity is related to

key - The key that needs to be used to write this element to cache

entity - Entity that needs to be written into cache

put

void put(String parentKey,
         List<V> entities)

Write through method that will be called if cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used

Parameters:

parentKey - The key of the parent that the entity is related to

entities - List of entities that needs to be written into cache

put

void put(String parentKey,
         int first,
         int numResults,
         List<V> entities)

Write through method that will be called if cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used

Parameters:

parentKey - The key of the parent that the entity is related to

entities - List of entities that needs to be written into cache

exists

boolean exists(String parentKey,
               Object key)

Read through exists method that will be called if cache enabled RelationalDao.exists(String, Object) is used

Parameters:

parentKey - The key of the parent that the entity is related to

key - The key that needs to be used to write this element to cache

Returns:

Whether the entity exists or not.

get

V get(String parentKey,
      Object key)

Read through method that will be called if a cache enabled CacheableRelationalDao.get(String, Object) is used

Parameters:

parentKey - The key of the parent the entity is related to

key - The key of the entity that needs to be read

Returns:

entity Entity that was read through the cache

select

List<V> select(String parentKey)

Read through method that will be called if a cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used

Parameters:

parentKey - The key of the parent the entity is related to

Returns:

Entities that was read through the cache

select

List<V> select(String parentKey,
               int first,
               int numResults)

Read through method that will be called if a cache enabled RelationalDao.select(String, DetachedCriteria, int, int, Function) is used

Parameters:

parentKey - The key of the parent the entity is related to

Returns:

Entities that was read through the cache