Package adams.flow.sink.simplelogging.output

Class FileOutput

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.FileOutput

All Implemented Interfaces:

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

Direct Known Subclasses:

RotatingFileOutput

public class FileOutput
extends AbstractSimpleOutput
implements FileWriter

Appends the log messages to the specified file.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_OutputFile	the file to write to.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(String msg)	Hook method for checks before attempting to log the message.
void	defineOptions()	Adds options to the internal list of options.
protected String	doLogMessage(String msg)	Logs the (formatted) logging message.
PlaceholderFile	getOutputFile()	Returns the output file.
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	outputFileTipText()	Returns the tip text for this property.
void	setOutputFile(PlaceholderFile value)	Sets the output file.

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

getFlowContext, logMessage, requiresFlowContext, 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_OutputFile

protected PlaceholderFile m_OutputFile

the file to write to.

Constructor Detail

FileOutput

public FileOutput()

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

setOutputFile

public void setOutputFile(PlaceholderFile value)

Sets the output file.

Specified by:

setOutputFile in interface FileWriter

Parameters:

value - the file

getOutputFile

public PlaceholderFile getOutputFile()

Returns the output file.

Specified by:

getOutputFile in interface FileWriter

Returns:

the file

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in interface FileWriter

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

check

protected String check(String msg)

Description copied from class: AbstractSimpleOutput

Hook method for checks before attempting to log the message.
Default implementation accepts everything and only ensures that flow context is set if required.

Overrides:

check in class AbstractSimpleOutput

Parameters:

msg - the message to log

Returns:

null if checks passed, otherwise error message

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