com.viaoa.object

Class OAObjectCacheDelegate

java.lang.Object

com.viaoa.object.OAObjectCacheDelegate

public class OAObjectCacheDelegate
extends Object

Author:

vincevia

See Also:

OAThreadLocalDelegate.setObjectCacheAddMode(int), OAThreadLocalDelegate.getObjectCacheAddMode()

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DefaultAddMode
static int	IGNORE_ALL dont store objects.
static int	IGNORE_DUPS dont store object if a duplicate is already stored.
protected static int	MODE_MAX
static int	NO_DUPS throw an exception if a duplicate object is added.
static int	OVERWRITE_DUPS store object even if another exists see HubController#setAddMode

Constructor Summary

Constructors

Constructor and Description
OAObjectCacheDelegate()

Method Summary

Modifier and Type	Method and Description
protected static Object	_find(Object fromObject, Class clazz, OAFinder finder, boolean bSkipNew, boolean bThrowException)
protected static Object	_find(Object fromObject, Class clazz, OAFinder finder, boolean bSkipNew, boolean bThrowException, int fetchAmount, ArrayList<Object> alResults)
protected static Object	_find(Object fromObject, Class clazz, String propertyPath, Object findObject, boolean bSkipNew, boolean bThrowException)
protected static Object	_find(Object fromObject, Class clazz, String propertyPath, Object findValue, boolean bSkipNew, boolean bThrowException, int fetchAmount, ArrayList<Object> alResults) Returns objects from the objectCache.
static OAObject	add(OAObject obj) Used by OAObject to cache new objects.
static OAObject	add(OAObject obj, boolean bErrorIfExists, boolean bAddToSelectAll)
static OAObject	add(OAObject obj, boolean bErrorIfExists, boolean bAddToSelectAll, boolean bSendAddEventInAnotherThread)
static <T extends OAObject> void	addListener(Class<T> clazz, OAObjectCacheListener<T> l) Listeners support for HubEvents.
static void	addToSelectAllHubs(OAObject obj)
static void	callback(Class clazz, OACallback callback)
static void	callback(OACallback callback) Used to visit every object in the Cache.
static void	callback(OACallback callback, Class clazz) Used to visit every object in the Cache for a Class.
static void	clearCache(Class clazz) Remove objects from cache for a class.
static Object	find(Class clazz) Searches all objects in Class clazz for an object with property equalTo findObject.
static Object	find(Class clazz, OAFinder finder)
static Object	find(Class clazz, OAFinder finder, boolean bSkipNew, boolean bThrowException)
static Object	find(Class clazz, String propertyPath, Object findObject)
static Object	find(Class clazz, String propertyPath, Object findObject, boolean bSkipNew, boolean bThrowException)
static Object	find(Object fromObject, Class clazz, int fetchAmount, ArrayList<Object> alResults)
static Object	find(Object fromObject, Class clazz, OAFilter filter, boolean bSkipNew, boolean bThrowException, int fetchAmount, ArrayList<Object> alResults)
static Object	find(Object fromObject, Class clazz, OAFinder finder, boolean bSkipNew, boolean bThrowException, int fetchAmount, ArrayList<Object> alResults)
static Object	findNext(Object fromObject)
static Object	findNext(Object fromObject, Class fromClass, String propertyPath, Object findObject)
static Object	findNext(Object fromObject, String propertyPath, Object findObject)
static Object	findNext(Object fromObject, String propertyPath, Object findObject, boolean bSkipNew, boolean bThrowException)
static void	fireAfterAddEvent(Hub hub, Object obj)
protected static void	fireAfterAddEvent(Object obj, boolean bSendAddEventInAnotherThread)
protected static void	fireAfterLoadEvent(Object obj)
protected static void	fireAfterPropertyChange(OAObject obj, OAObjectKey origKey, String propertyName, Object oldValue, Object newValue, boolean bLocalOnly, boolean bSendEvent) called by OAObject to send a HubEvent.
static void	fireAfterRemoveEvent(Hub hub, Object obj)
static <T> T	get(Class<T> clazz, int id) Used to retrieve any object based on its Object Id property value.
static <T> T	get(Class<T> clazz, Object key) Returns object with objectId of key.
static Object	get(OAObject obj) Used to retrieve any object.
static Class[]	getClasses()
static int	getDetaultAddMode()
static Vector	getInfo() Returns a Vector of Strings that describe the Classes and amount of objects that are loaded.
static void	getInfo(Vector vec) Populates a Vector of Strings that describe the Classes and amount of objects that are loaded.
static OAObjectCacheListener[]	getListeners(Class c) Returns array of HubListeners for a given class.
static Hub	getNamedHub(String name) Gets a hub that is stored by name.
static <T> T	getNewObjectUsingGuid(Class<T> clazz, int guid)
static <T> T	getObject(Class<T> clazz, Object key) Used to retrieve any object based on its Object Id property value.
static OAObject	getRandom(Class<? extends OAObject> clazz, int max)
static Hub	getSelectAllHub(Class clazz) returns first hub from getSelectAllHubs()
static Hub[]	getSelectAllHubs(Class clazz) Automatically set by Hub.select() when a select is done without a where clause.
static int	getTotal(Class clazz)
static <T> T	getUsingGuid(Class<T> clazz, int guid)
static void	refresh(Class clazz) Refresh all objects from the datasource.
protected static void	rehash(OAObject obj, OAObjectKey oldKey) Used by OAObjectKeyDelegate.updateKey when object Id property is changed.
static void	removeAllObjects() Removes all objects from HubController.
static void	removeAllObjects(Class c)
static void	removeAllSelectAllHubs()
static void	removeListener(Class clazz, OAObjectCacheListener l)
static void	removeObject(OAObject obj) Used by OAObject.finalize to remove object from HubContoller cache.
static void	removeSelectAllHub(Hub hub) Used by Hub to unregister a Hub that had all data selected.
static void	resetCache() Clear out object cache, remove all listeners, remove all selectAllHubs, remove all named hubs.
static void	setDefaultAddMode(int mode) The DefaultAddMode determines how HubController.addObject() will handle an object if it already exists.
static void	setDisableCache(boolean b)
static void	setDisableRemove(boolean b)
static void	setNamedHub(String name, Hub hub) Used to store a global hub by name, using a WeakReference.
static void	setSelectAllHub(Hub hub) Used by Hub.select() to register a Hub that has all data selected.
static void	setUnitTestMode(boolean b) Flag to allow system to be running in test mode This is used by resetCache()
protected static void	startCacheSendAddEventThread()
static void	visit(Class clazz, OACallback callback)
static void	visit(OACallback callback)
static void	visit(OACallback callback, Class clazz)

Methods inherited from class java.lang.Object

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

Field Detail

DefaultAddMode

protected static int DefaultAddMode

NO_DUPS

public static final int NO_DUPS

throw an exception if a duplicate object is added. This is Default. see HubController#setAddMode

See Also:

Constant Field Values

IGNORE_DUPS

public static final int IGNORE_DUPS

dont store object if a duplicate is already stored. If the object is being deserialized (see OAObject.readResolve) then the object that is already loaded will be used. see HubController#setAddMode

See Also:

OAObject.readResolve(), Constant Field Values

OVERWRITE_DUPS

public static final int OVERWRITE_DUPS

store object even if another exists see HubController#setAddMode

See Also:

Constant Field Values

IGNORE_ALL

public static final int IGNORE_ALL

dont store objects. see HubController#setAddMode

See Also:

Constant Field Values

MODE_MAX

protected static final int MODE_MAX

See Also:

Constant Field Values

Constructor Detail

OAObjectCacheDelegate

public OAObjectCacheDelegate()

Method Detail

getSelectAllHubs

public static Hub[] getSelectAllHubs(Class clazz)

Automatically set by Hub.select() when a select is done without a where clause. A WeakReference is used for storage. When a new OAObject is created, it will be added to a SelectAllHub.

Since:

2007/08/16

getSelectAllHub

public static Hub getSelectAllHub(Class clazz)

returns first hub from getSelectAllHubs()

setSelectAllHub

public static void setSelectAllHub(Hub hub)

Used by Hub.select() to register a Hub that has all data selected.

Since:

2007/08/16

removeSelectAllHub

public static void removeSelectAllHub(Hub hub)

Used by Hub to unregister a Hub that had all data selected.

Since:

2007/08/16

removeAllSelectAllHubs

public static void removeAllSelectAllHubs()

setNamedHub

public static void setNamedHub(String name,
                               Hub hub)

Used to store a global hub by name, using a WeakReference.

Parameters:

name - reference name to use, not case-sensitive

getNamedHub

public static Hub getNamedHub(String name)

Gets a hub that is stored by name.

Parameters:

name - reference name to use, not case-sensitive

Returns:

if found then Hub, else null.

addListener

public static <T extends OAObject> void addListener(Class<T> clazz,
                                                    OAObjectCacheListener<T> l)

Listeners support for HubEvents.

The following events are sent:
Events from Hubs: afterAdd, afterRemove
Events from OAObjects: afterPropertyChange

setUnitTestMode

public static void setUnitTestMode(boolean b)

Flag to allow system to be running in test mode This is used by resetCache()

resetCache

public static void resetCache()

Clear out object cache, remove all listeners, remove all selectAllHubs, remove all named hubs.

NOTE: this can only be used if UnitTestMode=true

See Also:

must be true, else an Exception is thrown, removeAllObjects(), clearCache(Class)

removeListener

public static void removeListener(Class clazz,
                                  OAObjectCacheListener l)

getListeners

public static OAObjectCacheListener[] getListeners(Class c)

Returns array of HubListeners for a given class. see addListener(Class, HubListener)

fireAfterPropertyChange

protected static void fireAfterPropertyChange(OAObject obj,
                                              OAObjectKey origKey,
                                              String propertyName,
                                              Object oldValue,
                                              Object newValue,
                                              boolean bLocalOnly,
                                              boolean bSendEvent)

called by OAObject to send a HubEvent.

fireAfterLoadEvent

protected static void fireAfterLoadEvent(Object obj)

fireAfterAddEvent

public static void fireAfterAddEvent(Hub hub,
                                     Object obj)

fireAfterRemoveEvent

public static void fireAfterRemoveEvent(Hub hub,
                                        Object obj)

removeAllObjects

public static void removeAllObjects()

Removes all objects from HubController.

See Also:

to remove objects for a Class., resetCache()

removeAllObjects

public static void removeAllObjects(Class c)

callback

public static void callback(OACallback callback)

Used to visit every object in the Cache.

visit

public static void visit(OACallback callback)

callback

public static void callback(Class clazz,
                            OACallback callback)

visit

public static void visit(Class clazz,
                         OACallback callback)

callback

public static void callback(OACallback callback,
                            Class clazz)

Used to visit every object in the Cache for a Class.

visit

public static void visit(OACallback callback,
                         Class clazz)

getInfo

public static void getInfo(Vector vec)

Populates a Vector of Strings that describe the Classes and amount of objects that are loaded.

getClasses

public static Class[] getClasses()

getTotal

public static int getTotal(Class clazz)

getRandom

public static OAObject getRandom(Class<? extends OAObject> clazz,
                                 int max)

getInfo

public static Vector getInfo()

Returns a Vector of Strings that describe the Classes and amount of objects that are loaded.

setDefaultAddMode

public static void setDefaultAddMode(int mode)

The DefaultAddMode determines how HubController.addObject() will handle an object if it already exists. This method sets the Default mode for all unassigned threads.

Parameters:

mode - AddModes are NO_DUPS (default), IGNORE_DUPS, OVERWRITE_DUPS. see HubController#setAddMode

getDetaultAddMode

public static int getDetaultAddMode()

See Also:

setDefaultAddMode(int)

add

public static OAObject add(OAObject obj)

Used by OAObject to cache new objects. Objects are removed by OAObject.finalize() see #setAddMode(int)

Returns:

either the object that was "obj" or the object that was already in the tree.

clearCache

public static void clearCache(Class clazz)

Remove objects from cache for a class.

See Also:

removeAllObjects(), resetCache()

add

public static OAObject add(OAObject obj,
                           boolean bErrorIfExists,
                           boolean bAddToSelectAll)

add

public static OAObject add(OAObject obj,
                           boolean bErrorIfExists,
                           boolean bAddToSelectAll,
                           boolean bSendAddEventInAnotherThread)

setDisableCache

public static void setDisableCache(boolean b)

setDisableRemove

public static void setDisableRemove(boolean b)

fireAfterAddEvent

protected static void fireAfterAddEvent(Object obj,
                                        boolean bSendAddEventInAnotherThread)

startCacheSendAddEventThread

protected static void startCacheSendAddEventThread()

addToSelectAllHubs

public static void addToSelectAllHubs(OAObject obj)

rehash

protected static void rehash(OAObject obj,
                             OAObjectKey oldKey)

Used by OAObjectKeyDelegate.updateKey when object Id property is changed.

removeObject

public static void removeObject(OAObject obj)

Used by OAObject.finalize to remove object from HubContoller cache.

getObject

public static <T> T getObject(Class<T> clazz,
                              Object key)

Used to retrieve any object based on its Object Id property value.

Parameters:

key - object to compare to, object or objects[] to compare this object's objectId(s) with or OAObjectKey to compare with this object's objectId

See Also:

OAObjectKey.OAObjectKey(java.lang.String), OAObject.equals(java.lang.Object)

get

public static <T> T get(Class<T> clazz,
                        int id)

Used to retrieve any object based on its Object Id property value.

See Also:

getObject(Class, Object)

get

public static <T> T get(Class<T> clazz,
                        Object key)

Returns object with objectId of key.

getNewObjectUsingGuid

public static <T> T getNewObjectUsingGuid(Class<T> clazz,
                                          int guid)

getUsingGuid

public static <T> T getUsingGuid(Class<T> clazz,
                                 int guid)

get

public static Object get(OAObject obj)

Used to retrieve any object.

Parameters:

key - object to find.

findNext

public static Object findNext(Object fromObject)

findNext

public static Object findNext(Object fromObject,
                              String propertyPath,
                              Object findObject)

findNext

public static Object findNext(Object fromObject,
                              String propertyPath,
                              Object findObject,
                              boolean bSkipNew,
                              boolean bThrowException)

findNext

public static Object findNext(Object fromObject,
                              Class fromClass,
                              String propertyPath,
                              Object findObject)

find

public static Object find(Class clazz)

Searches all objects in Class clazz for an object with property equalTo findObject.

find

public static Object find(Class clazz,
                          OAFinder finder)

find

public static Object find(Class clazz,
                          String propertyPath,
                          Object findObject)

find

public static Object find(Class clazz,
                          String propertyPath,
                          Object findObject,
                          boolean bSkipNew,
                          boolean bThrowException)

find

public static Object find(Class clazz,
                          OAFinder finder,
                          boolean bSkipNew,
                          boolean bThrowException)

_find

protected static Object _find(Object fromObject,
                              Class clazz,
                              String propertyPath,
                              Object findObject,
                              boolean bSkipNew,
                              boolean bThrowException)

_find

protected static Object _find(Object fromObject,
                              Class clazz,
                              OAFinder finder,
                              boolean bSkipNew,
                              boolean bThrowException)

find

public static Object find(Object fromObject,
                          Class clazz,
                          OAFinder finder,
                          boolean bSkipNew,
                          boolean bThrowException,
                          int fetchAmount,
                          ArrayList<Object> alResults)

find

public static Object find(Object fromObject,
                          Class clazz,
                          OAFilter filter,
                          boolean bSkipNew,
                          boolean bThrowException,
                          int fetchAmount,
                          ArrayList<Object> alResults)

find

public static Object find(Object fromObject,
                          Class clazz,
                          int fetchAmount,
                          ArrayList<Object> alResults)

_find

protected static Object _find(Object fromObject,
                              Class clazz,
                              String propertyPath,
                              Object findValue,
                              boolean bSkipNew,
                              boolean bThrowException,
                              int fetchAmount,
                              ArrayList<Object> alResults)

Returns objects from the objectCache.

Parameters:

clazz - type of objects

fromObject - null to start from the beginning, else use the last object previously returned.

fetchAmount - max number to add to the alResults

alResults - list of objects, after the fromObject

Returns:

last object in alResults, that can be used as the fromObject on the next call to fetch

_find

protected static Object _find(Object fromObject,
                              Class clazz,
                              OAFinder finder,
                              boolean bSkipNew,
                              boolean bThrowException,
                              int fetchAmount,
                              ArrayList<Object> alResults)

refresh

public static void refresh(Class clazz)

Refresh all objects from the datasource. This will be ran on the server, if called by client then it will async to run on server.

Parameters:

clazz - Class of objects to update, will also requery all hubs for this class.