<html> <head> <title>Interface XCsvLogFormatter</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XCsvLogFormatter-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">logging</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XCsvLogFormatter</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XCsvLogFormatter</strong> ┗ <a href="XLogFormatter.html">XLogFormatter</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XLogFormatter.html">XLogFormatter</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>specifies the interface to be used for formatting log records </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the interface used for formatting log records for RFC4180 csv output </dd> <dt><b>See also</b></dt> <dd>XLogFormatter,<br> XLogHandler </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.0</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#formatMultiColumn">formatMultiColumn</a></td> <td class="imsum_right">if the CsvLogFormatter is set to have more than one column, any logged infomation has to be send through this method before calling log(). E.g.: <code>XLoggerInstance.log(1000, XCsvLogFormatterInstance.formatMultiColumn(column_data))</code> </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#LogEventNo">LogEventNo</a></td> <td class="imsum_right">Defines if the EventNo should be logged </td> </tr> <tr> <td class="imsum_left"><a href="#LogThread">LogThread</a></td> <td class="imsum_right">Defines if the ThreadId should be logged </td> </tr> <tr> <td class="imsum_left"><a href="#LogTimestamp">LogTimestamp</a></td> <td class="imsum_right">Defines if the Timestamp should be logged </td> </tr> <tr> <td class="imsum_left"><a href="#LogSource">LogSource</a></td> <td class="imsum_right">Defines if the Source should be logged </td> </tr> <tr> <td class="imsum_left"><a href="#Columnnames">Columnnames</a></td> <td class="imsum_right">Defines the names of the additional columns this defaults to only one row titled "message". if this is set to more than one column, the messages need to be preformatted using <code>formatMultiColumn</code> </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="formatMultiColumn" class="membertitle">formatMultiColumn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>formatMultiColumn</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> column_data );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>if the CsvLogFormatter is set to have more than one column, any logged infomation has to be send through this method before calling log(). E.g.: <code>XLoggerInstance.log(1000, XCsvLogFormatterInstance.formatMultiColumn(column_data))</code> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="LogEventNo" class="membertitle">LogEventNo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>LogEventNo</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines if the EventNo should be logged </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LogThread" class="membertitle">LogThread</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>LogThread</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines if the ThreadId should be logged </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LogTimestamp" class="membertitle">LogTimestamp</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>LogTimestamp</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines if the Timestamp should be logged </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LogSource" class="membertitle">LogSource</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>LogSource</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines if the Source should be logged </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Columnnames" class="membertitle">Columnnames</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< string > <b>Columnnames</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines the names of the additional columns this defaults to only one row titled "message". if this is set to more than one column, the messages need to be preformatted using <code>formatMultiColumn</code></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2010 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
