Package de.caluga.morphium.cache

Class MorphiumCacheImpl

java.lang.Object

de.caluga.morphium.cache.MorphiumCacheImpl

All Implemented Interfaces:

MorphiumCache

public class MorphiumCacheImpl
extends Object
implements MorphiumCache

User: Stephan Bösebeck Date: 07.03.13 Time: 10:56

The Cache implementation for morphium.

Constructor Summary

Constructors

Constructor	Description
MorphiumCacheImpl()

Method Summary

Modifier and Type	Method	Description
void	addCacheListener(CacheListener cl)
<T> void	addToCache(String k, Class<? extends T> type, List<T> ret)	adds some list of objects to the cache manually...
void	clearCachefor(Class<?> cls)
void	clearCacheIfNecessary(Class cls)
void	close()
Map<Class<?>,Map<String,CacheEntry>>	getCache()
Set<Class<?>>	getCachedTypes()
String	getCacheKey(Query q)	create unique cache key for queries, also honoring skip invalid input: '&' limit and sorting
String	getCacheKey(Class type, Map<String,Object> qo, Map<String,Integer> sort, Map<String,Object> projection, String collection, int skip, int limit)
javax.cache.CacheManager	getCacheManager()
<T> List<T>	getFromCache(Class<? extends T> type, String k)	return object by from cache.
<T> T	getFromIDCache(Class<? extends T> type, Object id)
Map<String,Integer>	getSizes()
boolean	isCached(Class<?> type, String k)
boolean	isListenerRegistered(CacheListener cl)
void	removeCacheListener(CacheListener cl)
void	removeEntryFromCache(Class cls, Object id)
void	removeEntryFromIdCache(Class cls, Object id)
void	resetCache()
void	setAnnotationAndReflectionHelper(AnnotationAndReflectionHelper hlp)
void	setCache(Map<Class<?>,Map<String,CacheEntry>> cache)
void	setCacheManager(javax.cache.CacheManager cacheManager)
void	setDefaultCacheTime(Class type)	reset cache time settings to default, if settings were cahnged using setValidCacheTime
void	setGlobalCacheTimeout(int tm)
void	setHouskeepingIntervalPause(int p)
void	setValidCacheTime(Class type, int time)	override the settings given in @Cache annotation with this value this is useful to change cache behaviour during runtime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MorphiumCacheImpl

public MorphiumCacheImpl()

Method Details

setGlobalCacheTimeout

public void setGlobalCacheTimeout(int tm)

Specified by:

setGlobalCacheTimeout in interface MorphiumCache

setHouskeepingIntervalPause

public void setHouskeepingIntervalPause(int p)

Specified by:

setHouskeepingIntervalPause in interface MorphiumCache

setAnnotationAndReflectionHelper

public void setAnnotationAndReflectionHelper(AnnotationAndReflectionHelper hlp)

Specified by:

setAnnotationAndReflectionHelper in interface MorphiumCache

addCacheListener

public void addCacheListener(CacheListener cl)

Specified by:

addCacheListener in interface MorphiumCache

isListenerRegistered

public boolean isListenerRegistered(CacheListener cl)

Specified by:

isListenerRegistered in interface MorphiumCache

removeCacheListener

public void removeCacheListener(CacheListener cl)

Specified by:

removeCacheListener in interface MorphiumCache

addToCache

public <T> void addToCache(String k,
 Class<? extends T> type,
 List<T> ret)

adds some list of objects to the cache manually... is being used internally, and should be used with care

Specified by:

addToCache in interface MorphiumCache

Type Parameters:

T - - Type of record

Parameters:

k - - Key, usually the mongodb query string - should be created by createCacheKey

type - - class type

ret - - list of results

clearCacheIfNecessary

public void clearCacheIfNecessary(Class cls)

Specified by:

clearCacheIfNecessary in interface MorphiumCache

isCached

public boolean isCached(Class<?> type,
 String k)

Specified by:

isCached in interface MorphiumCache

getFromCache

public <T> List<T> getFromCache(Class<? extends T> type,
 String k)

return object by from cache. Cache key usually is the string-representation of the search query.toQueryObject()

Specified by:

getFromCache in interface MorphiumCache

Type Parameters:

T - - type param

Parameters:

type - - type

k - - cache key

Returns:

resulting list

getCache

public Map<Class<?>,Map<String,CacheEntry>> getCache()

setCache

public void setCache(Map<Class<?>,Map<String,CacheEntry>> cache)

getFromIDCache

public <T> T getFromIDCache(Class<? extends T> type,
 Object id)

Specified by:

getFromIDCache in interface MorphiumCache

setValidCacheTime

public void setValidCacheTime(Class type,
 int time)

Description copied from interface: MorphiumCache

override the settings given in @Cache annotation with this value this is useful to change cache behaviour during runtime

Specified by:

setValidCacheTime in interface MorphiumCache

setDefaultCacheTime

public void setDefaultCacheTime(Class type)

Description copied from interface: MorphiumCache

reset cache time settings to default, if settings were cahnged using setValidCacheTime

Specified by:

setDefaultCacheTime in interface MorphiumCache

getCacheKey

public String getCacheKey(Class type,
 Map<String,Object> qo,
 Map<String,Integer> sort,
 Map<String,Object> projection,
 String collection,
 int skip,
 int limit)

Specified by:

getCacheKey in interface MorphiumCache

getCacheKey

public String getCacheKey(Query q)

create unique cache key for queries, also honoring skip invalid input: '&' limit and sorting

Specified by:

getCacheKey in interface MorphiumCache

Parameters:

q - the query

Returns:

the resulting cache key

clearCachefor

public void clearCachefor(Class<?> cls)

Specified by:

clearCachefor in interface MorphiumCache

getCachedTypes

public Set<Class<?>> getCachedTypes()

Specified by:

getCachedTypes in interface MorphiumCache

resetCache

public void resetCache()

Specified by:

resetCache in interface MorphiumCache

close

public void close()

Specified by:

close in interface MorphiumCache

removeEntryFromIdCache

public void removeEntryFromIdCache(Class cls,
 Object id)

Specified by:

removeEntryFromIdCache in interface MorphiumCache

removeEntryFromCache

public void removeEntryFromCache(Class cls,
 Object id)

Specified by:

removeEntryFromCache in interface MorphiumCache

getSizes

public Map<String,Integer> getSizes()

Specified by:

getSizes in interface MorphiumCache

setCacheManager

public void setCacheManager(javax.cache.CacheManager cacheManager)

Specified by:

setCacheManager in interface MorphiumCache

getCacheManager

public javax.cache.CacheManager getCacheManager()

Specified by:

getCacheManager in interface MorphiumCache