uk.ac.ebi.adfconverter.common.tools.log
Class ADFConverterLoggerImpl

java.lang.Object
  uk.ac.ebi.adfconverter.common.tools.log.ADFConverterLoggerImpl

All Implemented Interfaces:

ADFConverterLogger

public class ADFConverterLoggerImpl

extends java.lang.Object

implements ADFConverterLogger

Implements tool logger using Log4J API.

There is two log type. One application log, which deals with global application message. one treated file log type, which reports messages for each treated file.

These are several possible logging level per log (from Log4J):

• DEBUG
• INFO
• WARN
• ERROR
• FATAL

The logger is configured (logging level, output file, output format) from the ADFConverter configuration file.

Version:

1 ADF MAGE-TOOL - MicroArray Informatics Team / European Bioinformatics Institute (EBI) ArrayExpress License: ============================================================================== Copyright (c) 2002 The European Bioinformatics Institute. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name ArrayExpress must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact arrayexpress@ebi.ac.uk 4. Products derived from this software may not be called "ArrayExpress" nor may "ArrayExpress" appear in their names without prior written permission of the ArrayExpress developers. 5. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes software developed by ArrayExpress (http://www.ebi.ac.uk/arrayexpress)" THIS SOFTWARE IS PROVIDED BY THE ARRAYEXPRESS GROUP ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARRAYEXPRESS GROUP OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The European Bioinformatics Institute may publish revised and/or new versions of this license with new releases of ArrayExpress software. ==============================================================================

Author:

Pierre MARGUERITE

See Also:

ADFConverterConfiguration

Constructor Summary

ADFConverterLoggerImpl()
Constructor of the ADFConverterLoggerImpl class Inits list of used log (as hashtable)

ADFConverterLoggerImpl(java.lang.Class cl)
Constructor of the ADFConverterLoggerImpl class for a given class object should be removed

ADFConverterLoggerImpl(java.lang.Class cl, java.io.File file)
Constructor of the ADFConverterLoggerImpl class for a given class object and a given file object should be removed

ADFConverterLoggerImpl(java.io.File file)
Constructor of the ADFConverterLoggerImpl class for a given treated file

ADFConverterLoggerImpl(java.lang.String ClassName)
Constructor Should be removed for optimisation

Method Summary

void	Applidebug(java.lang.String mess) Logs a debug message into the tool logger
void	Applidebug(java.lang.String mess, java.lang.Throwable t) Logs a debug message into the tool logger and reports an exception
void	AppliError(java.lang.String mess) Logs an error message into the tool logger
void	AppliError(java.lang.String mess, java.lang.Throwable t) Logs an error message into the tool logger and reports an exception
void	AppliFatal(java.lang.String mess) Logs an fatal message into the tool logger
void	AppliFatal(java.lang.String mess, java.lang.Throwable t) Logs an fatal message into the tool logger and reports an exception
void	AppliInfo(java.lang.String mess) Logs an info message into the tool logger and reports an exception
void	AppliInfo(java.lang.String mess, java.lang.Throwable t) Logs an info message into the tool logger and reports an exception
void	AppliWarn(java.lang.String mess) Logs an warn message into the tool logger and reports an exception
void	AppliWarn(java.lang.String mess, java.lang.Throwable t) Logs an warn message into the tool logger and reports an exception
void	debug(java.lang.String mess) Logs a debug message into the current logger
void	error(java.lang.String mess) Logs an errormessage into the current logger
void	fatal(java.lang.String mess) Logs a fatal message into the current logger
Logger	getApplicationLogger(java.lang.String name) Retrieves tool logger
void	info(java.lang.String mess) Logs a info message into the current logger
static boolean	isProduction() Retrieves the isProduction attribut
void	setLoggingLevel(java.lang.String fileLoggingLevel) Sets treated file logger log level following level name string.
void	setRootLogger(java.util.Properties loggerprop) Sets root logger.
void	warn(java.lang.String mess) Logs a warn message into the current logger

Methods inherited from class java.lang.Object

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

Constructor Detail

ADFConverterLoggerImpl

public ADFConverterLoggerImpl()

Constructor of the ADFConverterLoggerImpl class Inits list of used log (as hashtable)

ADFConverterLoggerImpl

public ADFConverterLoggerImpl(java.lang.Class cl)

Constructor of the ADFConverterLoggerImpl class for a given class object should be removed

Parameters:

cl - the class object

ADFConverterLoggerImpl

public ADFConverterLoggerImpl(java.lang.Class cl,
                              java.io.File file)

Constructor of the ADFConverterLoggerImpl class for a given class object and a given file object should be removed

Parameters:

cl - class calling this method

file - treated file object

ADFConverterLoggerImpl

public ADFConverterLoggerImpl(java.io.File file)

Constructor of the ADFConverterLoggerImpl class for a given treated file

Parameters:

file - the treated file object.

ADFConverterLoggerImpl

public ADFConverterLoggerImpl(java.lang.String ClassName)

Constructor Should be removed for optimisation

Parameters:

ClassName - the name of the class calling this method.

Method Detail

Applidebug

public void Applidebug(java.lang.String mess)

Logs a debug message into the tool logger

Specified by:

Applidebug in interface ADFConverterLogger

Parameters:

mess - message string to log

Applidebug

public void Applidebug(java.lang.String mess,
                       java.lang.Throwable t)

Logs a debug message into the tool logger and reports an exception

Specified by:

Applidebug in interface ADFConverterLogger

Parameters:

mess - message string to log

t - the exception to log

AppliError

public void AppliError(java.lang.String mess)

Logs an error message into the tool logger

Specified by:

AppliError in interface ADFConverterLogger

Parameters:

mess - message string to log

AppliError

public void AppliError(java.lang.String mess,
                       java.lang.Throwable t)

Logs an error message into the tool logger and reports an exception

Specified by:

AppliError in interface ADFConverterLogger

Parameters:

mess - message string to log

t - the exception to log

AppliFatal

public void AppliFatal(java.lang.String mess)

Logs an fatal message into the tool logger

Specified by:

AppliFatal in interface ADFConverterLogger

Parameters:

mess - message string to log

AppliFatal

public void AppliFatal(java.lang.String mess,
                       java.lang.Throwable t)

Logs an fatal message into the tool logger and reports an exception

Specified by:

AppliFatal in interface ADFConverterLogger

Parameters:

mess - message string to log

t - the exception to log

AppliInfo

public void AppliInfo(java.lang.String mess)

Logs an info message into the tool logger and reports an exception

Specified by:

AppliInfo in interface ADFConverterLogger

Parameters:

mess - message string to log

AppliInfo

public void AppliInfo(java.lang.String mess,
                      java.lang.Throwable t)

Logs an info message into the tool logger and reports an exception

Specified by:

AppliInfo in interface ADFConverterLogger

Parameters:

mess - message string to log

t - the exception to log

AppliWarn

public void AppliWarn(java.lang.String mess)

Logs an warn message into the tool logger and reports an exception

Specified by:

AppliWarn in interface ADFConverterLogger

Parameters:

mess - message string to log

AppliWarn

public void AppliWarn(java.lang.String mess,
                      java.lang.Throwable t)

Logs an warn message into the tool logger and reports an exception

Specified by:

AppliWarn in interface ADFConverterLogger

Parameters:

mess - message string to log

t - the exception to log

debug

public void debug(java.lang.String mess)

Logs a debug message into the current logger

Specified by:

debug in interface ADFConverterLogger

Parameters:

mess - message to log

error

public void error(java.lang.String mess)

Logs an errormessage into the current logger

Specified by:

error in interface ADFConverterLogger

Parameters:

mess - message to log

fatal

public void fatal(java.lang.String mess)

Logs a fatal message into the current logger

Specified by:

fatal in interface ADFConverterLogger

Parameters:

mess - message string to log

getApplicationLogger

public Logger getApplicationLogger(java.lang.String name)

Retrieves tool logger

Parameters:

name - file name

Returns:

the application/tool logger

info

public void info(java.lang.String mess)

Logs a info message into the current logger

Specified by:

info in interface ADFConverterLogger

Parameters:

mess - message string to log message is not logged, if tool run in production.

isProduction

public static boolean isProduction()

Retrieves the isProduction attribut

Returns:

Returns the isProduction.

setLoggingLevel

public void setLoggingLevel(java.lang.String fileLoggingLevel)

Sets treated file logger log level following level name string. Possible level names (case insensitive) : debug, info, warn, error, fatal.

Parameters:

fileLoggingLevel - log level name String (debug, info, warn, error, fatal)

setRootLogger

public void setRootLogger(java.util.Properties loggerprop)

Sets root logger. Sets the tool logger Properties came from Log4j. toolLevel: tool log level logtype Several outputs can be set. output type and output format:

• console: output on standard output, predefined output format
• file: messages are stored in a log file. Message can be as a given format:
  • html: as html page (i.e. : for web service)
  • pattern: output following a given output (Log4J)
  • TTCCLayout: a predefined pattern
  • xml: output as xml

Parameters:

loggerprop - list of properties specifyiing the root logger

warn

public void warn(java.lang.String mess)

Logs a warn message into the current logger

Specified by:

warn in interface ADFConverterLogger

Parameters:

mess - message string to log