Package adams.flow.sink.sendnotification

Class AbstractNotification

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.sendnotification.AbstractNotification

All Implemented Interfaces:

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

Direct Known Subclasses:

Console, Email, LogFile, MessageBox, MultiNotification, Null

public abstract class AbstractNotification
extends AbstractOptionHandler
implements QuickInfoSupporter, FlowContextHandler

Ancestor for notification schemes.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Actor	m_FlowContext	the flow context.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(String msg)	Hook method before attempting to send the message.
protected abstract String	doSendNotification(String msg)	Sends the notification.
Actor	getFlowContext()	Returns the flow context, if any.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	sendNotification(String msg)	Sends the notification.
void	setFlowContext(Actor value)	Sets the flow context.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_FlowContext

protected Actor m_FlowContext

the flow context.

Constructor Detail

AbstractNotification

public AbstractNotification()

Method Detail

setFlowContext

public void setFlowContext(Actor value)

Sets the flow context.

Specified by:

setFlowContext in interface FlowContextHandler

Parameters:

value - the actor

getFlowContext

public Actor getFlowContext()

Returns the flow context, if any.

Specified by:

getFlowContext in interface FlowContextHandler

Returns:

the actor, null if none available

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check(String msg)

Hook method before attempting to send the message.

Parameters:

msg - the message to send

Returns:

null if successful, otherwise error message

doSendNotification

protected abstract String doSendNotification(String msg)

Sends the notification.

Parameters:

msg - the message to send

Returns:

null if successfully sent, otherwise error message

sendNotification

public String sendNotification(String msg)

Sends the notification.

Parameters:

msg - the message to send

Returns:

null if successfully sent, otherwise error message