meka.events

Class LogObject

java.lang.Object

meka.events.LogObject

All Implemented Interfaces:

Serializable, LogSupporter

Direct Known Subclasses:

AbstractDatasetProvider, AbstractEvaluationStatisticsExporter, AbstractEvaluationStatisticsHandler, AbstractEvaluator, AbstractExperimentFileHandler, DefaultExperiment

public class LogObject
extends Object
implements Serializable, LogSupporter

Ancestor for objects that support logging. Debug mode can be enabled using boolean system property 'meka.exec.debug'.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_Debug whether to run code in DEBUG mode
protected HashSet<LogListener>	m_LogListeners the listeners.

Constructor Summary

Constructors

Constructor and Description
LogObject()

Method Summary

Modifier and Type	Method and Description
void	addLogListener(LogListener l) Adds the log listener to use.
void	debug(String msg) For debugging messages.
protected HashSet<LogListener>	getLogListeners() Returns the log listeners.
String	handleException(String msg, Throwable t) Logs the stacktrace along with the message on stderr and returns a combination of both of them as string.
void	log(String msg) For logging messages.
void	removeLogListener(LogListener l) Remove the log listener to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_Debug

protected boolean m_Debug

whether to run code in DEBUG mode

m_LogListeners

protected transient HashSet<LogListener> m_LogListeners

the listeners.

Constructor Detail

LogObject

public LogObject()

Method Detail

getLogListeners

protected HashSet<LogListener> getLogListeners()

Returns the log listeners. Instantiates them if neccessary.

Returns:

the listeners

addLogListener

public void addLogListener(LogListener l)

Adds the log listener to use.

Specified by:

addLogListener in interface LogSupporter

Parameters:

l - the listener

removeLogListener

public void removeLogListener(LogListener l)

Remove the log listener to use.

Specified by:

removeLogListener in interface LogSupporter

Parameters:

l - the listener

log

public void log(String msg)

For logging messages. Uses stderr if no listeners defined.

Specified by:

log in interface LogSupporter

Parameters:

msg - the message to output

debug

public void debug(String msg)

For debugging messages. Uses stderr.

Parameters:

msg - the message to output

handleException

public String handleException(String msg,
                              Throwable t)

Logs the stacktrace along with the message on stderr and returns a combination of both of them as string.

Parameters:

msg - the message for the exception

t - the exception

Returns:

the full error message (message + stacktrace)