Package adams.flow.control.flowrestart

Class NotificationManager

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.flowrestart.AbstractFlowRestartManager

adams.flow.control.flowrestart.NotificationManager

All Implemented Interfaces:

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

public class NotificationManager
extends AbstractFlowRestartManager
implements TriggerHandler

Applies the specified action once the trigger fires.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Flow	m_Flow	the flow to restart.
protected AbstractNotification	m_Notification	the notification.
protected AbstractTrigger	m_Trigger	the trigger in use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doStart(Flow flow)	Starts the restart handling.
protected String	doStop(Flow flow)	Stops the restart handling.
AbstractNotification	getNotification()	Returns the restart option in use.
AbstractTrigger	getTrigger()	Returns the trigger in use.
String	globalInfo()	Returns a string describing the object.
String	notificationTipText()	Returns the tip text for this property.
void	setNotification(AbstractNotification value)	Sets the restart operation to use.
void	setTrigger(AbstractTrigger value)	Sets the trigger to use.
String	trigger()	Receive a trigger.
String	triggerTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.control.flowrestart.AbstractFlowRestartManager

start, stop

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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_Trigger

protected AbstractTrigger m_Trigger

the trigger in use.

m_Notification

protected AbstractNotification m_Notification

the notification.

m_Flow

protected Flow m_Flow

the flow to restart.

Constructor Detail

NotificationManager

public NotificationManager()

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

setTrigger

public void setTrigger(AbstractTrigger value)

Sets the trigger to use.

Parameters:

value - the trigger

getTrigger

public AbstractTrigger getTrigger()

Returns the trigger in use.

Returns:

the trigger

triggerTipText

public String triggerTipText()

Returns the tip text for this property.

Returns:

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

setNotification

public void setNotification(AbstractNotification value)

Sets the restart operation to use.

Parameters:

value - the operation

getNotification

public AbstractNotification getNotification()

Returns the restart option in use.

Returns:

the operation

notificationTipText

public String notificationTipText()

Returns the tip text for this property.

Returns:

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

doStart

protected String doStart(Flow flow)

Starts the restart handling.

Specified by:

doStart in class AbstractFlowRestartManager

Parameters:

flow - the flow to handle

Returns:

null if successfully started, otherwise error message

doStop

protected String doStop(Flow flow)

Stops the restart handling.

Specified by:

doStop in class AbstractFlowRestartManager

Parameters:

flow - the flow to handle

Returns:

null if successfully stopped, otherwise error message

trigger

public String trigger()

Receive a trigger.

Specified by:

trigger in interface TriggerHandler

Returns:

null if successfully triggered, otherwise the error message