com.ibatis.sqlmap.engine.cache
Class CacheModel

java.lang.Object
  extended bycom.ibatis.sqlmap.engine.cache.CacheModel
All Implemented Interfaces:
ExecuteListener

public class CacheModel
extends java.lang.Object
implements ExecuteListener


Field Summary
private  CacheController controller
           
private  long flushInterval
           
private  long flushIntervalSeconds
           
private  java.util.Set flushTriggerStatements
           
private  int hits
           
private  java.lang.String id
           
private  long lastFlush
           
private static java.util.Map lockMap
           
private static long NO_FLUSH_INTERVAL
          Constant to turn off periodic cache flushes
static java.lang.Object NULL_OBJECT
           
private  boolean readOnly
           
private  int requests
           
private  java.lang.String resource
           
private  boolean serialize
           
private  java.lang.Object STATS_LOCK
           
 
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
 java.lang.Object getLock(CacheKey key)
           
 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
 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

lockMap

private static final java.util.Map lockMap

NULL_OBJECT

public static final java.lang.Object NULL_OBJECT

STATS_LOCK

private java.lang.Object STATS_LOCK

requests

private int requests

hits

private int hits

NO_FLUSH_INTERVAL

private static final long NO_FLUSH_INTERVAL
Constant to turn off periodic cache flushes

See Also:
Constant Field Values

id

private java.lang.String id

readOnly

private boolean readOnly

serialize

private boolean serialize

lastFlush

private long lastFlush

flushInterval

private long flushInterval

flushIntervalSeconds

private long flushIntervalSeconds

flushTriggerStatements

private java.util.Set flushTriggerStatements

controller

private CacheController controller

resource

private java.lang.String resource
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

getLock

public final java.lang.Object getLock(CacheKey key)