Package repast.simphony.engine.watcher

Class SharedWatchParameters

java.lang.Object

repast.simphony.engine.watcher.SharedWatchParameters

public class SharedWatchParameters
extends Object

Contains the invariant part of a WatchParamter that can be shared among WatchParameters for different objects.

Author:

Nick Collier

Constructor Summary

Constructors

Constructor	Description
SharedWatchParameters(String classToWatch, String fieldToWatch)

Method Summary

Modifier and Type	Method	Description
String	createWatcheeID()	Creates an id based on the watchee class and field.
boolean	doShuffleWatchers()	Gets whether or not to shuffle the watchers before triggering them.
ArgMatcher	getArgMatcher()
String	getClassName()
String	getFieldName()
IBooleanExpression	getQueryCondition()
double	getScheduleDelta()
double	getSchedulePriority()
WatcherTriggerSchedule	getTriggerSchedule()
Class<?>	getWatcheeClass()
String	getWatcheeCondition()
int	getWatcherCount()	Gets the amount of watchers to trigger.
String	getWatchID()
void	setArgMatcher(ArgMatcher matcher)
void	setQueryCondition(IBooleanExpression condition)
void	setShuffleWatchers(boolean shuffleWatchers)	Sets whether or not to shuffle the watchers before triggering them.
void	setTriggerSchedule(WatcherTriggerSchedule schedule, double scheduleDelta, double schedulePriority)
void	setWatcheeCondition(String watcheeCondition)
void	setWatcherCount(int pick)	Gets the amount of watchers to trigger.
void	setWatchID(String watchID)

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedWatchParameters

public SharedWatchParameters(String classToWatch,
                             String fieldToWatch)

Method Detail

getWatcheeClass

public Class<?> getWatcheeClass()

setArgMatcher

public void setArgMatcher(ArgMatcher matcher)

getArgMatcher

public ArgMatcher getArgMatcher()

setTriggerSchedule

public void setTriggerSchedule(WatcherTriggerSchedule schedule,
                               double scheduleDelta,
                               double schedulePriority)

getTriggerSchedule

public WatcherTriggerSchedule getTriggerSchedule()

getScheduleDelta

public double getScheduleDelta()

getSchedulePriority

public double getSchedulePriority()

getWatchID

public String getWatchID()

setWatchID

public void setWatchID(String watchID)

createWatcheeID

public String createWatcheeID()

Creates an id based on the watchee class and field.

Returns:

an id based on the watchee class and field.

getWatcheeCondition

public String getWatcheeCondition()

setWatcheeCondition

public void setWatcheeCondition(String watcheeCondition)

getClassName

public String getClassName()

getFieldName

public String getFieldName()

setQueryCondition

public void setQueryCondition(IBooleanExpression condition)

getQueryCondition

public IBooleanExpression getQueryCondition()

getWatcherCount

public int getWatcherCount()

Gets the amount of watchers to trigger.

Returns:

the amount of watchers to trigger.

setWatcherCount

public void setWatcherCount(int pick)

Gets the amount of watchers to trigger.

Parameters:

pick - the amount of watchers to trigger

doShuffleWatchers

public boolean doShuffleWatchers()

Gets whether or not to shuffle the watchers before triggering them.

Returns:

whether or not to shuffle the watchers before triggering them.

setShuffleWatchers

public void setShuffleWatchers(boolean shuffleWatchers)

Sets whether or not to shuffle the watchers before triggering them.

Parameters:

shuffleWatchers - true to shuffle, false don't shuffle