org.aksw.coyotecache.cache

Class AbstractCache

java.lang.Object

org.aksw.coyotecache.cache.AbstractCache

All Implemented Interfaces:

CacheInterface

Direct Known Subclasses:

AbstractGD, Cost, Fifo, Fifo2ndChance, Lfu, Lru, SLru

public abstract class AbstractCache
extends Object
implements CacheInterface

Author:

rspeck

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log4j logger
protected Map<Object,Object>	m_cacheMap cache
protected int	m_cacheMaxSize cache size
protected int	m_evictCount evict count

Constructor Summary

Constructors

Constructor and Description
AbstractCache(int size, int evictCount)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	evict()
Object	get(Object key) Returns the value to which the specified key is cached, or null if the cache dosn't contain the key.
protected abstract void	hitAccess(Object key)
int	maxSize() Returns the cache max size.
Object	put(Object key, Object val) Associates the specified value with the specified key in the cache.
protected abstract void	putAccess(Object key)
List<Object>	removeValues(Object value) Removes all objects with the value from cache map.
int	size() Returns the cache size.
boolean	test() This method should be used for testing.
String	toString()
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Field Detail

log4j

public static org.apache.log4j.Logger log4j

logger

m_cacheMap

protected Map<Object,Object> m_cacheMap

cache

m_cacheMaxSize

protected final int m_cacheMaxSize

cache size

m_evictCount

protected final int m_evictCount

evict count

Constructor Detail

AbstractCache

public AbstractCache(int size,
             int evictCount)

Parameters:

size -

evictCount -

Method Detail

values

public Collection<Object> values()

Specified by:

values in interface CacheInterface

get

public Object get(Object key)

Description copied from interface: CacheInterface

Returns the value to which the specified key is cached, or null if the cache dosn't contain the key.

Specified by:

get in interface CacheInterface

Parameters:

key - the key whose associated value is to be returned

Returns:

value the value to which the specified key is cached, or null if the cache dosn't contain the key

hitAccess

protected abstract void hitAccess(Object key)

maxSize

public int maxSize()

Description copied from interface: CacheInterface

Returns the cache max size.

Specified by:

maxSize in interface CacheInterface

Returns:

the max size of the cache

put

public Object put(Object key,
         Object val)

Description copied from interface: CacheInterface

Associates the specified value with the specified key in the cache. If the cache previously contained the key, the old value is replaced.

Specified by:

put in interface CacheInterface

Parameters:

key - with which the specified value is to be associated

val - to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no caching for key

evict

protected abstract void evict()

putAccess

protected abstract void putAccess(Object key)

removeValues

public List<Object> removeValues(Object value)

Description copied from interface: CacheInterface

Removes all objects with the value from cache map.

Specified by:

removeValues in interface CacheInterface

Returns:

removed objects

size

public int size()

Description copied from interface: CacheInterface

Returns the cache size.

Specified by:

size in interface CacheInterface

Returns:

the size of the cache

test

public boolean test()

Description copied from interface: CacheInterface

This method should be used for testing. Returns false on an error.

Specified by:

test in interface CacheInterface

Returns:

true if the cache works fine

toString

public String toString()

Overrides:

toString in class Object