Package adams.flow.sink.simplelogging.output

Class MultiOutput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.simplelogging.output.AbstractSimpleOutput

adams.flow.sink.simplelogging.output.MultiOutput

All Implemented Interfaces:

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

public class MultiOutput
extends AbstractSimpleOutput

Outputs the log message with all the specified sub-outputs.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SimpleOutput[]	m_Outputs	the underlying outputs.

Fields inherited from class adams.flow.sink.simplelogging.output.AbstractSimpleOutput

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doLogMessage(String msg)	Logs the (formatted) logging message.
SimpleOutput[]	getOutputs()	Returns the outputs in use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	outputsTipText()	Returns the tip text for this property.
boolean	requiresFlowContext()	Returns whether flow context is really required.
void	setFlowContext(Actor value)	Sets the flow context.
void	setOutputs(SimpleOutput[] value)	Sets the outputs to use.

Methods inherited from class adams.flow.sink.simplelogging.output.AbstractSimpleOutput

check, getFlowContext, logMessage

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_Outputs

protected SimpleOutput[] m_Outputs

the underlying outputs.

Constructor Detail

MultiOutput

public MultiOutput()

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

setFlowContext

public void setFlowContext(Actor value)

Sets the flow context.

Specified by:

setFlowContext in interface FlowContextHandler

Overrides:

setFlowContext in class AbstractSimpleOutput

Parameters:

value - the context

setOutputs

public void setOutputs(SimpleOutput[] value)

Sets the outputs to use.

Parameters:

value - the outputs to use

getOutputs

public SimpleOutput[] getOutputs()

Returns the outputs in use.

Returns:

the outputs in use

outputsTipText

public String outputsTipText()

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 object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractSimpleOutput

Returns:

null if no info available, otherwise short string

requiresFlowContext

public boolean requiresFlowContext()

Returns whether flow context is really required.

Specified by:

requiresFlowContext in interface SimpleOutput

Overrides:

requiresFlowContext in class AbstractSimpleOutput

Returns:

true if required

doLogMessage

protected String doLogMessage(String msg)

Logs the (formatted) logging message.

Specified by:

doLogMessage in class AbstractSimpleOutput

Parameters:

msg - the message to log

Returns:

null if successful, otherwise error message