Package com.ibatis.sqlmap.engine.cache

Class CacheModel

java.lang.Object

com.ibatis.sqlmap.engine.cache.CacheModel

All Implemented Interfaces:

ExecuteListener

public class CacheModel
extends Object
implements ExecuteListener

Wrapper for Caches.

Field Summary

Fields

Modifier and Type	Field	Description
static final Object	NULL_OBJECT	This is used to represent null objects that are returned from the cache so that they can be cached, too.

Constructor Summary

Constructors

Constructor	Description
CacheModel()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addFlushTriggerStatement(String statementName)	Adds a flushTriggerStatment.
void	configure(Properties props)	Configures the cache.
void	flush()	Clears the cache.
long	getFlushInterval()	Getter for flushInterval property.
long	getFlushIntervalSeconds()	Getter for flushInterval property.
Iterator	getFlushTriggerStatementNames()	Gets an Iterator containing all flushTriggerStatment objects for this cache.
double	getHitRatio()	Returns statistical information about the cache.
String	getId()	Getter for the cache model's id.
protected int	getMaxObjectLogSize()	Get the maximum size of an object in the log output.
Object	getObject(CacheKey key)	Get an object out of the cache.
String	getResource()	Getter for resource property.
boolean	isReadOnly()	Getter for read-only property.
boolean	isSerialize()	Getter to tell if the cache serializes.
protected void	log(String action, boolean addValue, Object cacheValue)	Log a cache action.
void	onExecuteStatement(MappedStatement statement)	ExecuteListener event.
void	putObject(CacheKey key, Object value)	Add an object to the cache.
void	setCacheController(CacheController controller)	Sets up the controller for the cache model.
void	setControllerProperties(Properties cacheProps)	Sets the controller properties.
void	setFlushInterval(long flushInterval)	Setter for flushInterval property.
void	setId(String id)	Setter for the cache model's id.
void	setReadOnly(boolean readOnly)	Setter for read-only property.
void	setResource(String resource)	Setter for resource property.
void	setSerialize(boolean serialize)	Setter to tell the cache to serialize objects.

Methods inherited from class java.lang.Object

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

Field Details

NULL_OBJECT

public static final Object NULL_OBJECT

This is used to represent null objects that are returned from the cache so that they can be cached, too.

Constructor Details

CacheModel

public CacheModel()

Default constructor.

Method Details

getId

public String getId()

Getter for the cache model's id.

Returns:

the id

setId

public void setId(String id)

Setter for the cache model's id.

Parameters:

id - - the new id

isReadOnly

public boolean isReadOnly()

Getter for read-only property.

Returns:

true if a read-only model

setReadOnly

public void setReadOnly(boolean readOnly)

Setter for read-only property.

Parameters:

readOnly - - the new setting

isSerialize

public boolean isSerialize()

Getter to tell if the cache serializes.

Returns:

true if the cache model serializes objects

setSerialize

public void setSerialize(boolean serialize)

Setter to tell the cache to serialize objects.

Parameters:

serialize - - if the cache model is to serialize objects

getResource

public String getResource()

Getter for resource property.

Returns:

the value of the resource property

setResource

public void setResource(String resource)

Setter for resource property.

Parameters:

resource - - the new value

setCacheController

public void setCacheController(CacheController controller)
                        throws ClassNotFoundException,
InstantiationException,
IllegalAccessException

Sets up the controller for the cache model.

Parameters:

controller - the new cache controller

Throws:

ClassNotFoundException - - if the class cannot be found

InstantiationException - - if the class cannot be instantiated

IllegalAccessException - - if the classes constructor is not accessible

getFlushInterval

public long getFlushInterval()

Getter for flushInterval property.

Returns:

The flushInterval (in milliseconds)

getFlushIntervalSeconds

public long getFlushIntervalSeconds()

Getter for flushInterval property.

Returns:

The flushInterval (in milliseconds)

setFlushInterval

public void setFlushInterval(long flushInterval)

Setter for flushInterval property.

Parameters:

flushInterval - The new flushInterval (in milliseconds)

addFlushTriggerStatement

public void addFlushTriggerStatement(String statementName)

Adds a flushTriggerStatment. When a flushTriggerStatment is executed, the cache is flushed (cleared).

Parameters:

statementName - The statement to add.

getFlushTriggerStatementNames

public Iterator getFlushTriggerStatementNames()

Gets an Iterator containing all flushTriggerStatment objects for this cache.

Returns:

The Iterator

onExecuteStatement

public void onExecuteStatement(MappedStatement statement)

ExecuteListener event. This will be called by a MappedStatement for which this cache is registered as a ExecuteListener. It will be called each time an executeXXXXXX method is called. In the case of the Cache class, it is registered in order to flush the cache whenever a certain statement is executed. (i.e. the flushOnExecute cache policy)

Specified by:

onExecuteStatement in interface ExecuteListener

Parameters:

statement - The statement to execute

getHitRatio

public double getHitRatio()

Returns statistical information about the cache.

Returns:

the number of cache hits divided by the total requests

configure

public void configure(Properties props)

Configures the cache.

Parameters:

props - the props

flush

public void flush()

Clears the cache.

getObject

public Object getObject(CacheKey key)

Get an object out of the cache. A side effect of this method is that is may clear the cache if it has not been cleared in the flushInterval.

Parameters:

key - The key of the object to be returned

Returns:

The cached object (or null)

putObject

public void putObject(CacheKey key,
 Object value)

Add an object to the cache.

Parameters:

key - The key of the object to be cached

value - The object to be cached

getMaxObjectLogSize

protected int getMaxObjectLogSize()

Get the maximum size of an object in the log output.

Returns:

Maximum size of a logged object in the output

log

protected void log(String action,
 boolean addValue,
 Object cacheValue)

Log a cache action. Since this method is pretty heavy weight, it's best to enclose it with a log.isDebugEnabled() when called.

Parameters:

action - String to output

addValue - Add the value being cached to the log

cacheValue - The value being logged

setControllerProperties

public void setControllerProperties(Properties cacheProps)

Sets the controller properties.

Parameters:

cacheProps - the new controller properties