Transfer version 1.1

transfer.com.cache
Class CacheManager

WEB-INF.cftags.component
        extended by transfer.com.cache.CacheManager

public class CacheManager
extends WEB-INF.cftags.component

Manages data persistance


Constructor Summary
init(CacheFactory cacheFactory, ObjectManager objectManager, CacheConfigManager cacheConfigManager, FacadeFactory facadeFactory, JavaLoader javaLoader)
          Constructor
 
Method Summary
 void add(any softRef)
          Adds a Transfer Object to the Pool
 void appendTransactionQueue(TransferObject transfer)
          append a Transfer Objects to the transaction queue
 void discard(TransferObject transfer)
          removes a transfer from the cache
 void discardAll()
          discards everything from the cache
 TransferObject get(string class, string key)
          gets a TransferObject from the pool
private CacheConfigManager getCacheConfigManager()
 CacheMonitor getCacheMonitor()
private CacheSynchronise getCacheSynchronise()
private FacadeFactory getFacadeFactory()
private JavaLoader getJavaLoader()
private MethodInvoker getMethodInvoker()
private ObjectManager getObjectManager()
private SoftReferenceHandler getSoftReferenceHandler()
private TransactionQueue getTransactionQueue()
private ValidateCacheState getValidateCacheState()
 boolean have(string class, string key)
          Checks if the Transfer is persistent in this
 void hit(string className)
          add an extra count to this cache's value being found successfully
 boolean isTransactionScoped(TransferObject transfer)
          Is this transaction scoped or not
 void miss(string className)
          add an extra count to this cache's value not being found
 any register(TransferObject transfer)
          Registers the TransferObject for caching with a soft reference, returns java.lang.ref.SoftReference
 void removeTransactionQueue(TransferObject transfer)
          append a Transfer Objects to the transaction queue
private any retrieveCache(string class)
          Returns a com.compoundtheory.objectcache.CacheManager
private void setCacheConfigManager(CacheConfigManager CacheConfigManager)
private void setCacheMonitor(CacheMonitor CacheMonitor)
private void setCacheSynchronise(CacheSynchronise CacheSynchronise)
private void setFacadeFactory(FacadeFactory FacadeFactory)
private void setJavaLoader(JavaLoader JavaLoader)
private void setMethodInvoker(MethodInvoker MethodInvoker)
private void setObjectManager(ObjectManager ObjectManager)
private void setSoftReferenceHandler(SoftReferenceHandler SoftReferenceHandler)
private void setTransactionQueue(TransactionQueue transactionQueue)
private void setValidateCacheState(ValidateCacheState ValidateCacheState)
 TransferObject synchronise(TransferObject transfer)
          syncronises the data, and returns the cached TransferObject if there is one, otherwise returns the original TransferObject
private any throw(string type, string message, [string detail=''])
          Throws an Exception
 boolean validateIsCached(TransferObject transfer)
          validates if a TransferObject is the same one as in cache
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(CacheFactory cacheFactory, ObjectManager objectManager, CacheConfigManager cacheConfigManager, FacadeFactory facadeFactory, JavaLoader javaLoader)
Constructor

Parameters:
cacheFactory - the cache factory
objectManager - Need to object manager for making queries
cacheConfigManager - The cache config manager
facadeFactory - The facade factory to access caches
javaLoader - The JavaLoader for loading the caching objects
Method Detail

add

public void add(any softRef)
Adds a Transfer Object to the Pool

Parameters:
softRef - java.lang.ref.SoftReference: The soft ref to the transfer object to be stored

appendTransactionQueue

public void appendTransactionQueue(TransferObject transfer)
append a Transfer Objects to the transaction queue

Parameters:
transfer - the transfer object to append

discard

public void discard(TransferObject transfer)
removes a transfer from the cache

Parameters:
transfer - The transfer object to be stored

discardAll

public void discardAll()
discards everything from the cache


get

public TransferObject get(string class, string key)
gets a TransferObject from the pool

Parameters:
class - The name of the class
key - The key for the id of the data

getCacheConfigManager

private CacheConfigManager getCacheConfigManager()


getCacheMonitor

public CacheMonitor getCacheMonitor()


getCacheSynchronise

private CacheSynchronise getCacheSynchronise()


getFacadeFactory

private FacadeFactory getFacadeFactory()


getJavaLoader

private JavaLoader getJavaLoader()


getMethodInvoker

private MethodInvoker getMethodInvoker()


getObjectManager

private ObjectManager getObjectManager()


getSoftReferenceHandler

private SoftReferenceHandler getSoftReferenceHandler()


getTransactionQueue

private TransactionQueue getTransactionQueue()


getValidateCacheState

private ValidateCacheState getValidateCacheState()


have

public boolean have(string class, string key)
Checks if the Transfer is persistent in this

Parameters:
class - The name of the class
key - The key for the id of the data

hit

public void hit(string className)
add an extra count to this cache's value being found successfully

Parameters:
className - the className being hit

isTransactionScoped

public boolean isTransactionScoped(TransferObject transfer)
Is this transaction scoped or not

Parameters:
transfer - The transfer object to be stored

miss

public void miss(string className)
add an extra count to this cache's value not being found

Parameters:
className - the className being missed

register

public any register(TransferObject transfer)
Registers the TransferObject for caching with a soft reference, returns java.lang.ref.SoftReference

Parameters:
transfer - The transfer object to be registered

removeTransactionQueue

public void removeTransactionQueue(TransferObject transfer)
append a Transfer Objects to the transaction queue

Parameters:
transfer - the transfer object to append

retrieveCache

private any retrieveCache(string class)
Returns a com.compoundtheory.objectcache.CacheManager

Parameters:
class - The name of the class

setCacheConfigManager

private void setCacheConfigManager(CacheConfigManager CacheConfigManager)

Parameters:
CacheConfigManager

setCacheMonitor

private void setCacheMonitor(CacheMonitor CacheMonitor)

Parameters:
CacheMonitor

setCacheSynchronise

private void setCacheSynchronise(CacheSynchronise CacheSynchronise)

Parameters:
CacheSynchronise

setFacadeFactory

private void setFacadeFactory(FacadeFactory FacadeFactory)

Parameters:
FacadeFactory

setJavaLoader

private void setJavaLoader(JavaLoader JavaLoader)

Parameters:
JavaLoader

setMethodInvoker

private void setMethodInvoker(MethodInvoker MethodInvoker)

Parameters:
MethodInvoker

setObjectManager

private void setObjectManager(ObjectManager ObjectManager)

Parameters:
ObjectManager

setSoftReferenceHandler

private void setSoftReferenceHandler(SoftReferenceHandler SoftReferenceHandler)

Parameters:
SoftReferenceHandler

setTransactionQueue

private void setTransactionQueue(TransactionQueue transactionQueue)

Parameters:
transactionQueue

setValidateCacheState

private void setValidateCacheState(ValidateCacheState ValidateCacheState)

Parameters:
ValidateCacheState

synchronise

public TransferObject synchronise(TransferObject transfer)
syncronises the data, and returns the cached TransferObject if there is one, otherwise returns the original TransferObject

Parameters:
transfer - The transfer object to syncronise

throw

private any throw(string type, string message, [string detail=''])
Throws an Exception

Parameters:
type - The type of exception
message - The message to accompany the exception
detail - The detail message for the exception

validateIsCached

public boolean validateIsCached(TransferObject transfer)
validates if a TransferObject is the same one as in cache

Parameters:
transfer - The transfer object to syncronise

Transfer version 1.1