📄 logservice.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.5.0_13) on Mon Jul 14 01:36:50 CEST 2008 --><TITLE>LogService (RapidMiner Class Documentation)</TITLE><META NAME="keywords" CONTENT="com.rapidminer.tools.LogService class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="LogService (RapidMiner Class Documentation)";}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LogService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../com/rapidminer/tools/LoggingHandler.html" title="interface in com.rapidminer.tools"><B>PREV CLASS</B></A> <A HREF="../../../com/rapidminer/tools/ObjectVisualizerService.html" title="class in com.rapidminer.tools"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/rapidminer/tools/LogService.html" target="_top"><B>FRAMES</B></A> <A HREF="LogService.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">com.rapidminer.tools</FONT><BR>Class LogService</H2><PRE>java.lang.Object <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rapidminer.tools.LogService</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/rapidminer/tools/LoggingHandler.html" title="interface in com.rapidminer.tools">LoggingHandler</A></DD></DL><HR><DL><DT><PRE>public class <B>LogService</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../com/rapidminer/tools/LoggingHandler.html" title="interface in com.rapidminer.tools">LoggingHandler</A></DL></PRE><P><p>Utility class providing static methods for logging.<br> Parameters read from the XML process configuration file:</p> <ul> <li>logfile (filename or "stdout" or "stderr")</li> <li>logverbosity (possible values are in <A HREF="../../../com/rapidminer/tools/LogService.html#LOG_VERBOSITY_NAMES"><CODE>LOG_VERBOSITY_NAMES</CODE></A></li> </ul> <p>Beside the <b>local</b> log service associated with a concrete process and which will be automatically initialized during the setup phase, one <b>global</b> log service exist which is used for generic log messages not bound to the operators used in a process. This global log service is usually initialized to log messages on system out (at least during the basic initialization phase of RapidMiner). After the basic intialization phase, the global messages will be presented in the message viewer (if the RapidMiner GUI is used) or still printed to system out or in any other stream defined via the method <A HREF="../../../com/rapidminer/tools/LogService.html#initGlobalLogging(java.io.OutputStream, int)"><CODE>initGlobalLogging(OutputStream, int)</CODE></A>. Alternatively, one could also define an environment variable named <A HREF="../../../com/rapidminer/RapidMiner.html#PROPERTY_RAPIDMINER_GLOBAL_LOG_FILE"><CODE>RapidMiner.PROPERTY_RAPIDMINER_GLOBAL_LOG_FILE</CODE></A>.</p> <p>Usually, operators should only use the log verbosities MINIMUM for messages with a low priority and STATUS for normal information messages. In rare cases, the verbosity level NOTE could be used for operators stating some message more important then STATUS (hence the user should see the message for the default log verbosity level of INIT) but not as important then WARNING. The verbosity levels WARNING, EXCEPTION, and ERROR should be used in error cases. All other log verbosity levels should only be used by internal RapidMiner classes and not by user written operators.</p> <p>We recommend to set the parameter for the log verbosity level to INIT for the process design phase (eventually STATUS for debugging) and to the log verbosity level WARNING in the production phase. This way it is ensured that not too many logging messages are produced in the production phase.</p> <p>Log messages can be formatted by using the following macros:</p> <ul> <li>"$b" and "^b" start and end bold mode respectively</li> <li>"$i" and "^i" start and end italic mode respectively</li> <li>"$m" and "^m" start and end monospace mode respectively</li> <li>"$n" and "^n" start and end note color mode respectively</li> <li>"$w" and "^w" start and end warning color mode respectively</li> <li>"$e" and "^e" start and end error color mode respectively</li> </ul><P><P><DL><DT><B>Version:</B></DT> <DD>$Id: LogService.java,v 1.12 2008/05/09 19:22:55 ingomierswa Exp $</DD><DT><B>Author:</B></DT> <DD>Ingo Mierswa</DD></DL><HR><P><!-- =========== FIELD SUMMARY =========== --><A NAME="field_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#ERROR">ERROR</A></B></CODE><BR> Use this log verbosity for logging of errors.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#FATAL">FATAL</A></B></CODE><BR> Use this log verbosity for logging of fatal errors which will stop process running somewhere in the future.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#GLOBAL_PREFIX">GLOBAL_PREFIX</A></B></CODE><BR> The prefix used to indicate the global logger.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#INIT">INIT</A></B></CODE><BR> Only the most important logging messaged should use this log verbosity.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#IO">IO</A></B></CODE><BR> Indicates log messages concerning in- and output.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String[]</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#LOG_VERBOSITY_NAMES">LOG_VERBOSITY_NAMES</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#MAXIMUM">MAXIMUM</A></B></CODE><BR> Normally this log verbosity should not be used by operators.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#MINIMUM">MINIMUM</A></B></CODE><BR> Indicates the lowest log verbosity.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#NOTE">NOTE</A></B></CODE><BR> Use this log verbosity for logging of important notes, i.e. things less important than warnings but important enough to see for all not interested in the detailed status messages.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#OFF">OFF</A></B></CODE><BR> For switching off logging during testing.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#STATUS">STATUS</A></B></CODE><BR> The default log verbosity for all logging purposes of operators.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#UNKNOWN_LEVEL">UNKNOWN_LEVEL</A></B></CODE><BR> Indicates an unknown verbosity level.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#WARNING">WARNING</A></B></CODE><BR> Use this log verbosity for logging of warnings.</TD></TR></TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#LogService(com.rapidminer.Process)">LogService</A></B>(<A HREF="../../../com/rapidminer/Process.html" title="class in com.rapidminer">Process</A> process)</CODE><BR> Creates a log service for this process.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#LogService(com.rapidminer.Process, int)">LogService</A></B>(<A HREF="../../../com/rapidminer/Process.html" title="class in com.rapidminer">Process</A> process, int logVerbosity)</CODE><BR> Creates a log service for this process.</TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#flush()">flush</A></B>()</CODE><BR> Flush the streams.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static <A HREF="../../../com/rapidminer/tools/LogService.html" title="class in com.rapidminer.tools">LogService</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#getGlobal()">getGlobal</A></B>()</CODE><BR> Returns the global logging.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.io.File</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#getLogFile()">getLogFile</A></B>()</CODE><BR> Returns the current log file or null.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/tools/LogService.html#getVerbosityLevel()">getVerbosityLevel</A></B>()</CODE>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -