com.ibatis.sqlmap.engine.cache
Interface CacheController

All Known Implementing Classes:

FifoCacheController, LruCacheController, MemoryCacheController, OSCacheController

public interface CacheController

Cache controller (implementation) interface

Method Summary

void	configure(java.util.Properties props) Configure a cache controller
void	flush(CacheModel cacheModel) Flush a cache model
java.lang.Object	getObject(CacheModel cacheModel, java.lang.Object key) Get an object from a cache model
void	putObject(CacheModel cacheModel, java.lang.Object key, java.lang.Object object) Put an object into a cache model
java.lang.Object	removeObject(CacheModel cacheModel, java.lang.Object key) Remove an object from a cache model

Method Detail

flush

public void flush(CacheModel cacheModel)

Flush a cache model

Parameters:

cacheModel - - the model to flush

getObject

public java.lang.Object getObject(CacheModel cacheModel,
                                  java.lang.Object key)

Get an object from a cache model

Parameters:

cacheModel - - the model

key - - the key to the object

Returns:

the object if in the cache, or null(?)

removeObject

public java.lang.Object removeObject(CacheModel cacheModel,
                                     java.lang.Object key)

Remove an object from a cache model

Parameters:

cacheModel - - the model to remove the object from

key - - the key to the object

Returns:

the removed object(?)

putObject

public void putObject(CacheModel cacheModel,
                      java.lang.Object key,
                      java.lang.Object object)

Put an object into a cache model

Parameters:

cacheModel - - the model to add the object to

key - - the key to the object

object - - the object to add

configure

public void configure(java.util.Properties props)

Configure a cache controller

Parameters:

props - - the properties object continaing configuration information