fr.cnes.genius.logger

Class GLogger

java.lang.Object

fr.cnes.genius.logger.GLogger

public class GLogger
extends Object

The class implements the log file. This file is initialized by the application maker via the class GEnvironment. If the log file is not initialized, all items send to the log file are ignored. The log file is closed automatically during the application shutting down without action of the application maker. The class allows events recording by methods writeLogInfo(Type, String, String, boolean), writeLogWarn(Type, String, String, boolean),and writeLogError(Type, String, String, boolean), depending on its criticity. Events of the log file are composed of following fields:

• Criticity (info, warn, error).
• Type (Operational, user, system).
• Origin
• Description

The log messages may be also sent to standard error by means of the boolean argument of cited methods.

Author:

jjct

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GLogger.Criticity Critcity of the event.
static class	GLogger.Type Log event type.

Constructor Summary

Constructors

Constructor and Description
GLogger(String logFilename, boolean createViewer) GLog contructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the log file before the object is destroyed.
GLogEventTablePanel	getGLogViewer() Get the log viewer.
static void	setErrorColor(Color color) Setter of the ERROR color.
static void	setInfoColor(Color color) Setter of the INFO color.
static void	setWarningColor(Color color) Setter of the WARNING color.
void	writeLogError(GLogger.Type type, String source, String description) Write a log entry with ERROR criticity.
void	writeLogError(GLogger.Type type, String source, String description, boolean sendToStderr) Write a log entry with ERROR criticity.
void	writeLogInfo(GLogger.Type type, String source, String description) Write a log entry with INFO criticity.
void	writeLogInfo(GLogger.Type type, String source, String description, boolean sendToStderr) Write a log entry with INFO criticity.
void	writeLogUser(GLogger.Criticity criticity, String source, String description) Write a log entry with USER type.
void	writeLogUser(GLogger.Criticity criticity, String source, String description, boolean sendToStderr) Write a log entry with USER type.
void	writeLogWarn(GLogger.Type type, String source, String description) Write a log entry with WARN criticity.
void	writeLogWarn(GLogger.Type type, String source, String description, boolean sendToStderr) Write a log entry with WARN criticity.

Methods inherited from class java.lang.Object

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

Constructor Detail

GLogger

public GLogger(String logFilename,
               boolean createViewer)
        throws IOException

GLog contructor. Opens the log file identified by logFilename.

Parameters:

logFilename - filename of the log to create.

createViewer - create the logTable Viewer.

Throws:

IOException - in case of error creating the log file.

Method Detail

getGLogViewer

public GLogEventTablePanel getGLogViewer()

Get the log viewer.

Returns:

the log viewer.

setErrorColor

public static void setErrorColor(Color color)

Setter of the ERROR color.

Parameters:

color - to be set.

setInfoColor

public static void setInfoColor(Color color)

Setter of the INFO color.

Parameters:

color - to be set.

setWarningColor

public static void setWarningColor(Color color)

Setter of the WARNING color.

Parameters:

color - to be set.

close

public void close()

Closes the log file before the object is destroyed.

writeLogInfo

public void writeLogInfo(GLogger.Type type,
                         String source,
                         String description,
                         boolean sendToStderr)

Write a log entry with INFO criticity.

Parameters:

type - of the log entry.

source - or the log entry.

description - of the log entry.

sendToStderr - if true the log message is also send to the stderr.

writeLogInfo

public void writeLogInfo(GLogger.Type type,
                         String source,
                         String description)

Write a log entry with INFO criticity.

Parameters:

type - of the log entry.

source - or the log entry.

description - of the log entry.

writeLogWarn

public void writeLogWarn(GLogger.Type type,
                         String source,
                         String description,
                         boolean sendToStderr)

Write a log entry with WARN criticity.

Parameters:

type - of the log entry.

source - or the log entry.

description - of the log entry.

sendToStderr - if true the log message is also send to the stderr.

writeLogWarn

public void writeLogWarn(GLogger.Type type,
                         String source,
                         String description)

Write a log entry with WARN criticity.

Parameters:

type - of the log entry.

source - or the log entry.

description - of the log entry.

writeLogError

public void writeLogError(GLogger.Type type,
                          String source,
                          String description,
                          boolean sendToStderr)

Write a log entry with ERROR criticity.

Parameters:

type - of the log entry.

source - or the log entry.

description - of the log entry.

sendToStderr - if true the log message is also send to the stderr.

writeLogError

public void writeLogError(GLogger.Type type,
                          String source,
                          String description)

Write a log entry with ERROR criticity.

Parameters:

type - of the log entry.

source - or the log entry.

description - of the log entry.

writeLogUser

public void writeLogUser(GLogger.Criticity criticity,
                         String source,
                         String description,
                         boolean sendToStderr)

Write a log entry with USER type.

Parameters:

criticity - of the log entry.

source - or the log entry.

description - of the log entry.

sendToStderr - if true the log message is also send to the stderr.

writeLogUser

public void writeLogUser(GLogger.Criticity criticity,
                         String source,
                         String description)

Write a log entry with USER type.

Parameters:

criticity - of the log entry.

source - or the log entry.

description - of the log entry.