edu.udo.cs.yale.tools
Class LogService

java.lang.Object
  edu.udo.cs.yale.tools.LogService

public class LogService
extends java.lang.Object

Utility class providing static methods for logging.
Parameters read from config file:

• logfile (filename or "stdout" or "stderr")
• logverbosity (possible values are in LOG_VERBOSITY_NAMES

Usually, operators should only use the log verbosities MINIMUM for messages with a low priority and STATUS for normal information messages. The verbosity levels WARNING, EXCEPTION, and ERROR should be used in error cases. All other log verbosity levels should only be used by internal YALE classes and not by user written operators.

Log messages can be formatted by using the following macros:

• "$b" and "^b" start and end bold mode respectively
• "$i" and "^i" start and end italic mode respectively
• "$m" and "^m" start and end monospace mode respectively
• "$w" and "^w" start and end warning color mode respectively
• "$e" and "^e" start and end error color mode respectively

Version:

$Id: LogService.java,v 2.26 2006/08/15 20:34:48 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

Field Summary

private static int	equalMessageCount Counts how often a message was repeated.
static int	ERROR Use this log verbosity for logging of errors.
static int	EXCEPTION Use this log verbosity for logging of exceptions.
static int	FATAL Use this log verbosity for logging of fatal errors which will stop experiment running somewhere in the future.
static int	INIT Only the most important logging messaged should use this log verbosity.
static int	IO Indicates log messages concerning in- and output.
private static java.lang.String	lastMessage The last printed message.
static java.lang.String[]	LOG_VERBOSITY_NAMES
private static java.io.File	logFile
private static java.io.PrintStream	logOut The PrintStream to write the messages to.
static int	MAXIMUM Normally this log verbosity should not be used by operators.
static int	MINIMUM Indicates the lowest log verbosity.
private static int	minVerbosityLevel The minimal verbosity level.
static int	OFF For switching off logging during testing.
static int	STATUS The default log verbosity for all logging purposes of operators.
private static java.lang.String[]	VERBOSITYLEVEL_END
private static java.lang.String[]	VERBOSITYLEVEL_START
static int	WARNING Use this log verbosity for logging of warnings.

Constructor Summary

LogService()

Method Summary

static void	close() Closes the stream.
private static Operator	getCurrentOperator()
static java.io.File	getLogFile()
private static java.lang.String	getTime() Returns the current system time nicely formatted.
static int	getVerbosityLevel()
private static java.lang.String	handleNewlineChars(java.lang.String message) Adds an additional \r on Windows systems in order to provide nice-looking file logging.
static void	init(Experiment experiment) Initialises the LogService reading parameters form the ParameterService.
static void	init(Experiment experiment, int verbosityLevel) Initialises the LogService reading parameters form the ParameterService.
static void	init(java.io.OutputStream out, int verbosityLevel, boolean format) Initialises the LogService.
static void	initGUI()
static boolean	isSufficientLogVerbosity(int level)
static void	logException(java.lang.String message, java.lang.Throwable exception) Writes the message and the stack trace of the exception.
static void	logMessage(java.lang.String message, int verbosityLevel) Writes the message to the output stream if the verbosity level is high enough.
static void	logMessageWithTree(java.lang.String message, int verbosityLevel, Operator op) Writes the message to the output stream if the verbosity level is high enough and appends the experiment tree with operator op marked.
static void	setOutputStream(java.io.OutputStream out)
static void	setVerbosityLevel(int level)

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM

public static final int MINIMUM

Indicates the lowest log verbosity. Should only be used for very detailed but not necessary logging.

See Also:

Constant Field Values

IO

public static final int IO

Indicates log messages concerning in- and output. Should only be used by the class Operator itself and not by its subclasses.

See Also:

Constant Field Values

STATUS

public static final int STATUS

The default log verbosity for all logging purposes of operators.

See Also:

Constant Field Values

INIT

public static final int INIT

Only the most important logging messaged should use this log verbosity. Currently used only by the LogService itself.

See Also:

Constant Field Values

WARNING

public static final int WARNING

Use this log verbosity for logging of warnings.

See Also:

Constant Field Values

EXCEPTION

public static final int EXCEPTION

Use this log verbosity for logging of exceptions.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Use this log verbosity for logging of errors.

See Also:

Constant Field Values

FATAL

public static final int FATAL

Use this log verbosity for logging of fatal errors which will stop experiment running somewhere in the future.

See Also:

Constant Field Values

MAXIMUM

public static final int MAXIMUM

Normally this log verbosity should not be used by operators. Messages with this verbosity will always be displayed.

See Also:

Constant Field Values

OFF

public static final int OFF

For switching off logging during testing.

See Also:

Constant Field Values

LOG_VERBOSITY_NAMES

public static final java.lang.String[] LOG_VERBOSITY_NAMES

logOut

private static java.io.PrintStream logOut

The PrintStream to write the messages to.

minVerbosityLevel

private static int minVerbosityLevel

The minimal verbosity level. Message below this level are ignored.

lastMessage

private static java.lang.String lastMessage

The last printed message.

equalMessageCount

private static int equalMessageCount

Counts how often a message was repeated.

logFile

private static java.io.File logFile

VERBOSITYLEVEL_START

private static final java.lang.String[] VERBOSITYLEVEL_START

VERBOSITYLEVEL_END

private static final java.lang.String[] VERBOSITYLEVEL_END

Constructor Detail

LogService

public LogService()

Method Detail

init

public static void init(Experiment experiment)
                 throws UndefinedParameterError

Initialises the LogService reading parameters form the ParameterService.

Throws:

UndefinedParameterError

init

public static void init(Experiment experiment,
                        int verbosityLevel)
                 throws UndefinedParameterError

Initialises the LogService reading parameters form the ParameterService.

Throws:

UndefinedParameterError

init

public static void init(java.io.OutputStream out,
                        int verbosityLevel,
                        boolean format)

Initialises the LogService.

Parameters:

out - The stream to write the messages to.

verbosityLevel - Only messages with message.verbosityLevel >= verbosityLevel are logged

format - must be true if the output should be formatted by the FormattedPrintStream

initGUI

public static void initGUI()
                    throws UndefinedParameterError

Throws:

UndefinedParameterError

setOutputStream

public static void setOutputStream(java.io.OutputStream out)

close

public static void close()

Closes the stream.

setVerbosityLevel

public static void setVerbosityLevel(int level)

getVerbosityLevel

public static int getVerbosityLevel()

isSufficientLogVerbosity

public static boolean isSufficientLogVerbosity(int level)

getCurrentOperator

private static Operator getCurrentOperator()

handleNewlineChars

private static java.lang.String handleNewlineChars(java.lang.String message)

Adds an additional \r on Windows systems in order to provide nice-looking file logging.

logMessage

public static void logMessage(java.lang.String message,
                              int verbosityLevel)

Writes the message to the output stream if the verbosity level is high enough.

logMessageWithTree

public static void logMessageWithTree(java.lang.String message,
                                      int verbosityLevel,
                                      Operator op)

Writes the message to the output stream if the verbosity level is high enough and appends the experiment tree with operator op marked.

logException

public static void logException(java.lang.String message,
                                java.lang.Throwable exception)

Writes the message and the stack trace of the exception.

getTime

private static java.lang.String getTime()

Returns the current system time nicely formatted.

getLogFile

public static java.io.File getLogFile()