com.viaoa.object

Class OAObjectCacheTrigger<T extends OAObject>

java.lang.Object

com.viaoa.object.OAObjectCacheTrigger<T>

All Implemented Interfaces:

OAFilter<T>, Serializable

public abstract class OAObjectCacheTrigger<T extends OAObject>
extends Object
implements OAFilter<T>

This is used to listen to the OAObjectCache for objects that match filter criteria and then call the onTrigger method.

Author:

vvia

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bServerSideOnly

Constructor Summary

Constructors

Constructor and Description
OAObjectCacheTrigger(Class clazz) Create new cache trigger.
OAObjectCacheTrigger(Class clazz, OAFilter<T> filter) Create new cache trigger.
OAObjectCacheTrigger(Class clazz, OAFilter<T> filter, String... dependentPropPaths)
OAObjectCacheTrigger(Hub<T> hub, OAFilter<T> filter, String... dependentPropPaths)

Method Summary

Modifier and Type	Method and Description
void	addDependentProperty(String prop) add a property to listen to.
void	addFilter(OAFilter<T> f) Add a filter that is used to determine if an object from the cache will be added to hub.
void	addFilter(OAFilter<T> f, boolean bCallRefresh) Add a filter that is used to determine if an object from the cache will be added to hub.
void	addFilter(OAFilter<T> f, String... dependentPropPaths)
void	close()
protected void	finalize()
boolean	isUsed(T obj) Called to see if an object should be included in hub.
abstract void	onTrigger(T obj) Method that will be called when isUsed() returns true, and isUsedFromObjectCache() returns true.
void	refresh() Clear hub and check all cached objects to see if they should be added to hub.
void	setServerSideOnly(boolean b) This needs to be set to true if it is only created on the server.
protected void	setupTrigger()

Methods inherited from class java.lang.Object

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

Field Detail

bServerSideOnly

protected boolean bServerSideOnly

Constructor Detail

OAObjectCacheTrigger

public OAObjectCacheTrigger(Class clazz)

Create new cache trigger. Cached objects that are true for isUsedFromObjectCache & isUsed will then call onTrigger.

OAObjectCacheTrigger

public OAObjectCacheTrigger(Class clazz,
                            OAFilter<T> filter)

Create new cache trigger. Cached objects that are true for isUsedFromObjectCache & isUsed will then call onTrigger.

OAObjectCacheTrigger

public OAObjectCacheTrigger(Class clazz,
                            OAFilter<T> filter,
                            String... dependentPropPaths)

OAObjectCacheTrigger

public OAObjectCacheTrigger(Hub<T> hub,
                            OAFilter<T> filter,
                            String... dependentPropPaths)

Method Detail

setServerSideOnly

public void setServerSideOnly(boolean b)

This needs to be set to true if it is only created on the server. This is so that changes will be published to the clients, even if initiated on OAClientThread.

addFilter

public void addFilter(OAFilter<T> f)

Add a filter that is used to determine if an object from the cache will be added to hub. This will clear and refresh hub.

Parameters:

f - filter to add. By default isUsed() will return false if any of the filters.isUsed() returns false.

See Also:

that has an option for refreshing.

addFilter

public void addFilter(OAFilter<T> f,
                      String... dependentPropPaths)

addFilter

public void addFilter(OAFilter<T> f,
                      boolean bCallRefresh)

Add a filter that is used to determine if an object from the cache will be added to hub.

Parameters:

f - filter to add. By default isUsed() will return false if any of the filters.isUsed() returns false.

bCallRefresh - if true, then call refresh.

refresh

public void refresh()

Clear hub and check all cached objects to see if they should be added to hub. To be added, isUsedFromObjectCache() and isUsed() must return true.

addDependentProperty

public void addDependentProperty(String prop)

add a property to listen to. If the property changes, then it will be recalculated to determine if it should be added to hub, or removed from it. This will recheck the object cache to see if any of the existing objects isUsed() is true and should be added to hub. It will not call refresh.

setupTrigger

protected void setupTrigger()

close

public void close()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

isUsed

public boolean isUsed(T obj)

Called to see if an object should be included in hub. By default, this will return false if no filters have been added, or the result of the filters.

Specified by:

isUsed in interface OAFilter<T extends OAObject>

onTrigger

public abstract void onTrigger(T obj)

Method that will be called when isUsed() returns true, and isUsedFromObjectCache() returns true.

Parameters:

obj -