Package adams.flow.control.flowrestart.trigger

Class MultiTrigger

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.flowrestart.trigger.AbstractTrigger

adams.flow.control.flowrestart.trigger.MultiTrigger

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class MultiTrigger
extends AbstractTrigger

Manages multiple triggers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AbstractTrigger>	m_Triggers	the triggers to manage.

Fields inherited from class adams.flow.control.flowrestart.trigger.AbstractTrigger

m_TriggerHandler

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
MultiTrigger()

Method Summary

Modifier and Type	Method	Description
void	addTrigger(AbstractTrigger value)	Appends the specified trigger.
void	defineOptions()	Adds options to the internal list of options.
protected String	doStart(Flow flow)	Starts the trigger.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
AbstractTrigger[]	getTriggers()	Returns the managed triggers.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	setTriggerHandler(TriggerHandler value)	Sets the trigger handler to use.
void	setTriggers(AbstractTrigger[] value)	Sets the managed triggers.
String	stop()	Stops the trigger.
String	triggersTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.control.flowrestart.trigger.AbstractTrigger

check, getTriggerHandler, start

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Triggers

protected List<AbstractTrigger> m_Triggers

the triggers to manage.

Constructor Detail

MultiTrigger

public MultiTrigger()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

addTrigger

public void addTrigger(AbstractTrigger value)

Appends the specified trigger.

Parameters:

value - the trigger to add

setTriggers

public void setTriggers(AbstractTrigger[] value)

Sets the managed triggers.

Parameters:

value - the triggers

getTriggers

public AbstractTrigger[] getTriggers()

Returns the managed triggers.

Returns:

the trigger

triggersTipText

public String triggersTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractTrigger

Returns:

null if no info available, otherwise short string

setTriggerHandler

public void setTriggerHandler(TriggerHandler value)

Sets the trigger handler to use.

Overrides:

setTriggerHandler in class AbstractTrigger

Parameters:

value - the handler to use

doStart

protected String doStart(Flow flow)

Starts the trigger.

Specified by:

doStart in class AbstractTrigger

Parameters:

flow - the flow to handle

Returns:

null if successfully started, otherwise error message

stop

public String stop()

Stops the trigger.

Specified by:

stop in class AbstractTrigger

Returns:

null if successfully stopped, otherwise error message