Package adams.flow.sink.sendnotification

Class Console

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.sendnotification.AbstractNotification

adams.flow.sink.sendnotification.Console

All Implemented Interfaces:

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

public class Console
extends AbstractNotification

Outputs the message in the console (with optional prefix).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseText	m_Prefix	a custom prefix.

Fields inherited from class adams.flow.sink.sendnotification.AbstractNotification

m_FlowContext

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doSendNotification(String msg)	Sends the notification.
BaseText	getPrefix()	Returns the class label index (1-based index).
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	prefixTipText()	Returns the tip text for this property.
void	setPrefix(BaseText value)	Sets the class label index (1-based index).

Methods inherited from class adams.flow.sink.sendnotification.AbstractNotification

check, getFlowContext, sendNotification, setFlowContext

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_Prefix

protected BaseText m_Prefix

a custom prefix.

Constructor Detail

Console

public Console()

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

setPrefix

public void setPrefix(BaseText value)

Sets the class label index (1-based index).

Parameters:

value - the index

getPrefix

public BaseText getPrefix()

Returns the class label index (1-based index).

Returns:

the index

prefixTipText

public String prefixTipText()

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 AbstractNotification

Returns:

null if no info available, otherwise short string

doSendNotification

protected String doSendNotification(String msg)

Sends the notification.

Specified by:

doSendNotification in class AbstractNotification

Parameters:

msg - the message to send

Returns:

null if successfully sent, otherwise error message