Package repast.simphony.engine.watcher

Class WatchParameters

java.lang.Object

repast.simphony.engine.watcher.WatchParameters

public class WatchParameters
extends Object

Parameter object for setting watches

Version:

$Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $

Author:

Nick Collier

Constructor Summary

Constructors

Constructor	Description
WatchParameters(SharedWatchParameters params, CallBackAction action)

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.
CallBackAction	getAction()
ArgMatcher	getArgMatcher()
String	getClassName()
String	getFieldName()
IBooleanExpression	getQueryCondition()
double	getScheduleDelta()
double	getSchedulePriority()
WatcherTriggerSchedule	getTriggerSchedule()
Class<?>	getWatcheeClass()
String	getWatcheeCondition()
Object	getWatcher()
int	getWatcherCount()	Gets the amount of watchers to trigger.
String	getWatcherMethodName()
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 Details

WatchParameters

public WatchParameters(SharedWatchParameters params,
 CallBackAction action)

Method Details

getWatcheeClass

public Class<?> getWatcheeClass()

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()

setArgMatcher

public void setArgMatcher(ArgMatcher matcher)

getArgMatcher

public ArgMatcher getArgMatcher()

getWatcher

public Object getWatcher()

getWatcherMethodName

public String getWatcherMethodName()

getAction

public CallBackAction getAction()

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