|
| |
|
| java.lang.Object
 org.apache.torque.manager.AbstractBaseManager
| AbstractBaseManager | | abstract public class AbstractBaseManager implements Serializable(Code) | | This class contains common functionality of a Manager for
instantiating OM's.
author:
John McNally
version:
$Id: AbstractBaseManager.java 571790 2007-09-01 12:40:44Z tv $ |
| cache | | protected transient GroupCacheAccess cache(Code) | | used to cache the om objects. cache is set by the region property
|
| log | | final protected static Log log(Code) | | the log
|
| addCacheListenerImpl | | public void addCacheListenerImpl(CacheListener listener)(Code) | |
Parameters:
listener - A new listener for cache events. |
| cacheGet | | protected Persistent cacheGet(Serializable key)(Code) | | Get an object from cache
Parameters:
key - the primary key of the object the object from cache |
| clearImpl | | protected void clearImpl() throws TorqueException(Code) | | Clears the cache
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| dispose | | public void dispose()(Code) | | Disposes of the cache. This triggers a shutdown of the connected cache
instances. This method should only be used during shutdown of Torque. The
manager instance will not cache anymore after this call.
|
| getClassName | | public String getClassName()(Code) | | Get the classname to instantiate for getInstance()
value of className. |
| getOMClass | | protected Class getOMClass()(Code) | | Get the Class instance
the om class |
| getOMInstance | | protected Persistent getOMInstance(ObjectKey id) throws TorqueException(Code) | | Return an instance of an om based on the id
Parameters:
id - the primary key of the object the object from persistent storage or from cache
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| getOMInstance | | protected Persistent getOMInstance(ObjectKey key, boolean fromCache) throws TorqueException(Code) | | Return an instance of an om based on the id
Parameters:
key - the primary key of the object
Parameters:
fromCache - true if the object should be retrieved from cache the object from persistent storage or from cache
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| getOMs | | protected List getOMs(ObjectKey[] ids) throws TorqueException(Code) | | Gets a list of om's based on id's.
Parameters:
ids - a ObjectKey[] value a List value
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| getOMs | | protected List getOMs(List ids) throws TorqueException(Code) | | Gets a list of om's based on id's.
Parameters:
ids - a List of ObjectKey's a List value
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| getOMs | | protected List getOMs(List ids, boolean fromCache) throws TorqueException(Code) | | Gets a list of om's based on id's.
Parameters:
ids - a List of ObjectKey's a List value
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| getRegion | | public String getRegion()(Code) | | Get the value of region.
value of region. |
| notifyListeners | | protected void notifyListeners(List listeners, Persistent oldOm, Persistent om)(Code) | |
Parameters:
listeners -
Parameters:
oldOm -
Parameters:
om - |
| putInstanceImpl | | protected Persistent putInstanceImpl(Persistent om) throws TorqueException(Code) | | Put an object into the cache
Parameters:
om - the object if an object with the same key already is in the cachethis object will be returned, else null
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| putInstanceImpl | | protected Persistent putInstanceImpl(Serializable key, Persistent om) throws TorqueException(Code) | | Put an object into the cache
Parameters:
key - the cache key for the object
Parameters:
om - the object if an object with this key already is in the cachethis object will be returned, else null
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| registerAsListener | | protected void registerAsListener()(Code) | | NoOp version. Managers should override this method to notify other
managers that they are interested in CacheEvents.
|
| removeInstanceImpl | | protected Persistent removeInstanceImpl(Serializable key) throws TorqueException(Code) | | Remove an object from the cache
Parameters:
key - the cache key for the object the object one last time
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| retrieveStoredOM | | abstract protected Persistent retrieveStoredOM(ObjectKey id) throws TorqueException(Code) | | Retrieve an object from persistent storage
Parameters:
id - the primary key of the object the object
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| retrieveStoredOMs | | abstract protected List retrieveStoredOMs(List ids) throws TorqueException(Code) | | Gets a list of om's based on id's.
This method must be implemented in the drived class
Parameters:
ids - a List of ObjectKey's a List value
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| setClassName | | public void setClassName(String v) throws TorqueException(Code) | | Set the classname to instantiate for getInstance()
Parameters:
v - Value to assign to className.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| setOMClass | | protected void setOMClass(Class omClass)(Code) | | Set the Class that will be instantiated by this manager
Parameters:
omClass - the om class |
| setRegion | | public void setRegion(String v) throws TorqueException(Code) | | Set the value of region.
Parameters:
v - Value to assign to region.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
|
|
|