com.ibatis.sqlmap.engine.cache
Class CacheModel

java.lang.Object
  com.ibatis.sqlmap.engine.cache.CacheModel

All Implemented Interfaces:

ExecuteListener

public class CacheModel

extends java.lang.Object

implements ExecuteListener

Wrapper for Caches.

Field Summary

static java.lang.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

CacheModel()
Default constructor

Method Summary

void	addFlushTriggerStatement(java.lang.String statementName) Adds a flushTriggerStatment.
void	configure(java.util.Properties props) Configures the cache
void	flush() Clears the cache
long	getFlushInterval() Getter for flushInterval property
long	getFlushIntervalSeconds() Getter for flushInterval property
java.util.Iterator	getFlushTriggerStatementNames() Gets an Iterator containing all flushTriggerStatment objects for this cache.
double	getHitRatio() Returns statistical information about the cache.
java.lang.String	getId() Getter for the cache model's id
protected int	getMaxObjectLogSize() Get the maximum size of an object in the log output.
java.lang.Object	getObject(CacheKey key) Get an object out of the cache.
java.lang.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(java.lang.String action, boolean addValue, java.lang.Object cacheValue) Log a cache action.
void	onExecuteStatement(MappedStatement statement) ExecuteListener event.
void	putObject(CacheKey key, java.lang.Object value) Add an object to the cache
void	setControllerClassName(java.lang.String implementation) Sets up the controller for the cache model
void	setFlushInterval(long flushInterval) Setter for flushInterval property
void	setId(java.lang.String id) Setter for the cache model's id
void	setReadOnly(boolean readOnly) Setter for read-only property
void	setResource(java.lang.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 Detail

NULL_OBJECT

public static final java.lang.Object NULL_OBJECT

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

Constructor Detail

CacheModel

public CacheModel()

Default constructor

Method Detail

getId

public java.lang.String getId()

Getter for the cache model's id

Returns:

the id

setId

public void setId(java.lang.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 java.lang.String getResource()

Getter for resource property

Returns:

the value of the resource property

setResource

public void setResource(java.lang.String resource)

Setter for resource property

Parameters:

resource - - the new value

setControllerClassName

public void setControllerClassName(java.lang.String implementation)
                            throws java.lang.ClassNotFoundException,
                                   java.lang.InstantiationException,
                                   java.lang.IllegalAccessException

Sets up the controller for the cache model

Parameters:

implementation - - the class (FQCN) for the controller

Throws:

java.lang.ClassNotFoundException - - if the class cannot be found

java.lang.InstantiationException - - if the class cannot be instantiated

java.lang.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(java.lang.String statementName)

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

Parameters:

statementName - The statement to add.

getFlushTriggerStatementNames

public java.util.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(java.util.Properties props)

Configures the cache

Parameters:

props -

flush

public void flush()

Clears the cache

getObject

public java.lang.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,
                      java.lang.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(java.lang.String action,
                   boolean addValue,
                   java.lang.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