genius.core.logging

Class CsvLogger

java.lang.Object

genius.core.logging.CsvLogger

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class CsvLogger
extends java.lang.Object
implements java.io.Closeable

Logger interface that writes the log to a comma separated value file (.csv file) File is created upon logger interface creation and logger class should be released (i.e. log.close() to release internal file handle when done with logger). *

Author:

David Festen

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELIMITER

Constructor Summary

Constructors

Constructor and Description
CsvLogger(java.lang.String fileName) Initializes a new instance of the CsvLogger class.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream and releases any system resources associated with it.
static java.lang.String	getDefaultSessionLog(Session session, MultilateralProtocol protocol, java.util.List<NegotiationPartyInternal> partiesint, double runTime) Log default session information.
static java.util.List<java.lang.Double>	getUtils(java.util.List<NegotiationPartyInternal> parties, Bid agreement, boolean discount)
static java.lang.String	join(java.util.Collection<?> s, java.lang.String delimiter) Helper method.
void	log(java.lang.Object value) Log a given object.
void	logLine(java.lang.Object... values) Logs a complete line to the file.
static java.lang.String	logSingleSession(Session session, MultilateralProtocol protocol, java.util.List<NegotiationPartyInternal> partiesint, double runTime)
static java.lang.String	stripPath(java.lang.String filenameWithPath)

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

public static final java.lang.String DELIMITER

See Also:

Constant Field Values

Constructor Detail

CsvLogger

public CsvLogger(java.lang.String fileName)
          throws java.io.IOException

Initializes a new instance of the CsvLogger class. Initializing this class opens a print stream, the user of the instance should take care to close (i.e. logger.close()) this instance when done.

Parameters:

fileName - The name of the file to log to (including the .csv extension)

Throws:

java.io.FileNotFoundException - Thrown by the PrintStream if the location is not writable.

java.io.IOException

Method Detail

join

public static java.lang.String join(java.util.Collection<?> s,
                                    java.lang.String delimiter)

Helper method. Joins all the elements in the collection using the given delimiter. For each element the to string function is used to generate the string.

Parameters:

s - Collection of objects to create string of

delimiter - The delimiter used between object

Returns:

The string delimited with the given delimiter

log

public void log(java.lang.Object value)

Log a given object. This actually just adds it to the buffer, to print to file, call logLine() afterwards.

Parameters:

value - The object to log

logLine

public void logLine(java.lang.Object... values)

Logs a complete line to the file.

Parameters:

values - zero or more objects to log, using ; delimiter

getDefaultSessionLog

public static java.lang.String getDefaultSessionLog(Session session,
                                                    MultilateralProtocol protocol,
                                                    java.util.List<NegotiationPartyInternal> partiesint,
                                                    double runTime)
                                             throws java.lang.Exception

Log default session information. Seems applicable only when an agreement was reached.

Throws:

java.lang.Exception

getUtils

public static java.util.List<java.lang.Double> getUtils(java.util.List<NegotiationPartyInternal> parties,
                                                        Bid agreement,
                                                        boolean discount)

Parameters:

parties - the parties in the nego

agreement - the reached agreement, or null if there was no agreement.

discount - true iff you want the discounted utilities.

Returns:

list with (possibly discounted) utilities/res value of each of the parties. Res value is only used if agreement=null.

logSingleSession

public static java.lang.String logSingleSession(Session session,
                                                MultilateralProtocol protocol,
                                                java.util.List<NegotiationPartyInternal> partiesint,
                                                double runTime)
                                         throws java.lang.Exception

Parameters:

session -

protocol -

partiesint -

runTime -

Returns:

string for the log file

Throws:

java.lang.Exception

stripPath

public static java.lang.String stripPath(java.lang.String filenameWithPath)

close

public void close()
           throws java.io.IOException

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an I/O error occurs