org.exoplatform.services.cache
Class BaseExoCache

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<K,V>
          java.util.LinkedHashMap
              org.exoplatform.services.cache.BaseExoCache

All Implemented Interfaces:

Serializable, Cloneable, Map, ExoCache

Direct Known Subclasses:

FIFOExoCache, SimpleExoCache

public abstract class BaseExoCache
extends LinkedHashMap
implements ExoCache

Created by The eXo Platform SAS Author : Tuan Nguyen tuan08@users.sourceforge.net Sat, Sep 13, 2003 @ Time: 1:12:22 PM

See Also:

Serialized Form

Constructor Summary

BaseExoCache()

BaseExoCache(int maxSize)

BaseExoCache(String name, int maxSize)

Method Summary

void	addCacheListener(CacheListener listener)
void	clearCache() Clears the cache.
protected abstract ObjectCacheInfo	createObjectCacheInfo(long expTime, Object objToCache)
Object	get(Serializable name) Performs a lookup operation.
List	getCachedObjects() Returns a list of cached object that are considered as valid when the method is called.
int	getCacheHit()
int	getCacheMiss()
int	getCacheSize()
String	getLabel()
long	getLiveTime()
int	getMaxSize()
String	getName()
boolean	isDistributed()
boolean	isLogEnabled()
boolean	isReplicated()
void	localClear()
void	localPut(Serializable key, Object obj)
Object	localRemove(Serializable key)
void	put(Serializable name, Object obj) Performs a put in the cache.
void	putMap(Map<Serializable,Object> objs) For whole put of items set
Object	remove(Serializable name) Removes an entry from the cache.
List	removeCachedObjects() Clears the cache and returns the list of cached object that are considered as valid when the method is called.
protected boolean	removeEldestEntry(Map.Entry eldest)
void	select(CachedObjectSelector selector) Selects a subset of the cache.
void	setDistributed(boolean b)
void	setLabel(String name)
void	setLiveTime(long period)
void	setLogEnabled(boolean b)
void	setMaxSize(int max)
void	setName(String s)
void	setReplicated(boolean b)

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

BaseExoCache

public BaseExoCache()

BaseExoCache

public BaseExoCache(int maxSize)

BaseExoCache

public BaseExoCache(String name,
                    int maxSize)

Method Detail

getName

public String getName()

Specified by:

getName in interface ExoCache

setName

public void setName(String s)

Specified by:

setName in interface ExoCache

getLabel

public String getLabel()

Specified by:

getLabel in interface ExoCache

setLabel

public void setLabel(String name)

Specified by:

setLabel in interface ExoCache

getCacheSize

public int getCacheSize()

Specified by:

getCacheSize in interface ExoCache

getMaxSize

public int getMaxSize()

Specified by:

getMaxSize in interface ExoCache

setMaxSize

public void setMaxSize(int max)

Specified by:

setMaxSize in interface ExoCache

getLiveTime

public long getLiveTime()

Specified by:

getLiveTime in interface ExoCache

setLiveTime

public void setLiveTime(long period)

Specified by:

setLiveTime in interface ExoCache

get

public Object get(Serializable name)
           throws Exception

Description copied from interface: ExoCache

Performs a lookup operation.

Specified by:

get in interface ExoCache

Parameters:

name - the cache key

Returns:

the cached value which may be evaluated to null

Throws:

Exception - any exception

remove

public Object remove(Serializable name)
              throws Exception

Description copied from interface: ExoCache

Removes an entry from the cache.

Specified by:

remove in interface ExoCache

Parameters:

name - the cache key

Returns:

the previously cached value or null if no entry existed or that entry value was evaluated to null

Throws:

Exception - any exception

select

public void select(CachedObjectSelector selector)
            throws Exception

Description copied from interface: ExoCache

Selects a subset of the cache.

Specified by:

select in interface ExoCache

Parameters:

selector - the selector

Throws:

Exception - any exception

put

public void put(Serializable name,
                Object obj)
         throws Exception

Description copied from interface: ExoCache

Performs a put in the cache.

Specified by:

put in interface ExoCache

Parameters:

name - the cache key

obj - the cached value

Throws:

Exception - any exception

putMap

public void putMap(Map<Serializable,Object> objs)
            throws Exception

For whole put of items set

Specified by:

putMap in interface ExoCache

Parameters:

objs - the objects to put

Throws:

Exception - any exception

clearCache

public void clearCache()
                throws Exception

Description copied from interface: ExoCache

Clears the cache.

Specified by:

clearCache in interface ExoCache

Throws:

Exception - any exception

getCacheHit

public int getCacheHit()

Specified by:

getCacheHit in interface ExoCache

getCacheMiss

public int getCacheMiss()

Specified by:

getCacheMiss in interface ExoCache

isDistributed

public boolean isDistributed()

Specified by:

isDistributed in interface ExoCache

setDistributed

public void setDistributed(boolean b)

Specified by:

setDistributed in interface ExoCache

isReplicated

public boolean isReplicated()

Specified by:

isReplicated in interface ExoCache

setReplicated

public void setReplicated(boolean b)

Specified by:

setReplicated in interface ExoCache

removeEldestEntry

protected boolean removeEldestEntry(Map.Entry eldest)

Overrides:

removeEldestEntry in class LinkedHashMap

getCachedObjects

public List getCachedObjects()

Description copied from interface: ExoCache

Returns a list of cached object that are considered as valid when the method is called. Any non valid object will not be returnted.

Specified by:

getCachedObjects in interface ExoCache

Returns:

the list of cached objects

removeCachedObjects

public List removeCachedObjects()
                         throws Exception

Description copied from interface: ExoCache

Clears the cache and returns the list of cached object that are considered as valid when the method is called. Any non valid object will not be returned.

Specified by:

removeCachedObjects in interface ExoCache

Returns:

the list of cached objects

Throws:

Exception - any exception

addCacheListener

public void addCacheListener(CacheListener listener)

Specified by:

addCacheListener in interface ExoCache

localPut

public void localPut(Serializable key,
                     Object obj)
              throws Exception

Throws:

Exception

localRemove

public Object localRemove(Serializable key)
                   throws Exception

Throws:

Exception

localClear

public void localClear()
                throws Exception

Throws:

Exception

isLogEnabled

public boolean isLogEnabled()

Specified by:

isLogEnabled in interface ExoCache

setLogEnabled

public void setLogEnabled(boolean b)

Specified by:

setLogEnabled in interface ExoCache

createObjectCacheInfo

protected abstract ObjectCacheInfo createObjectCacheInfo(long expTime,
                                                         Object objToCache)