Package adams.flow.sink.simplelogging.format

Class AbstractSimpleFormat

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.simplelogging.format.AbstractSimpleFormat

All Implemented Interfaces:

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

Direct Known Subclasses:

NoFormat, TimestampedFormat

public abstract class AbstractSimpleFormat
extends AbstractOptionHandler
implements SimpleFormat

Ancestor for simple formatting 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
AbstractSimpleFormat()

Method Summary

Modifier and Type	Method	Description
protected String	check(String msg)	Hook method for checks before attempting to format the message.
protected abstract String	doFormatMessage(String msg)	Formats the logging message and returns the updated message.
String	formatMessage(String msg)	Formats the logging message and returns the updated message.
Actor	getFlowContext()	Returns the flow context.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
boolean	requiresFlowContext()	Returns whether flow context is really required.
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 transient Actor m_FlowContext

the flow context.

Constructor Detail

AbstractSimpleFormat

public AbstractSimpleFormat()

Method Detail

setFlowContext

public void setFlowContext(Actor value)

Sets the flow context.

Specified by:

setFlowContext in interface FlowContextHandler

Parameters:

value - the context

getFlowContext

public Actor getFlowContext()

Returns the flow context.

Specified by:

getFlowContext in interface FlowContextHandler

Returns:

the context, null if not available

requiresFlowContext

public boolean requiresFlowContext()

Returns whether flow context is really required.

Specified by:

requiresFlowContext in interface SimpleFormat

Returns:

true if required

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 for checks before attempting to format the message.
Default implementation accepts everything and only ensures that flow context is set if required.

Parameters:

msg - the message to format

Returns:

null if checks passed, otherwise error message

doFormatMessage

protected abstract String doFormatMessage(String msg)

Formats the logging message and returns the updated message.

Parameters:

msg - the message to format

Returns:

the formatted message

formatMessage

public String formatMessage(String msg)

Formats the logging message and returns the updated message.

Specified by:

formatMessage in interface SimpleFormat

Parameters:

msg - the message to format

Returns:

the formatted message