net.sourceforge.jabm.report
Class CSVReportVariables

java.lang.Object
  net.sourceforge.jabm.report.CSVReportVariables

All Implemented Interfaces:

EventListener, Report, ReportVariables

public class CSVReportVariables
extends java.lang.Object
implements ReportVariables

CSVReportVariables automatically record other ReportVariables to a comma separated variables (CSV) file whenever they are computed.

Field Summary

protected boolean	autoNumbering
protected java.lang.Object	fileNameExtension
protected java.lang.Object	fileNamePrefix
protected java.lang.String	fileNameSuffix
protected int	fileNumber
protected boolean	passThrough
protected ReportVariables	reportVariables This report collects the data that we will write.
protected CSVWriter	writer

Constructor Summary

CSVReportVariables()

CSVReportVariables(java.lang.String fileNameSuffix, java.lang.Object fileNamePrefix, ReportVariables reportVariables)

CSVReportVariables(java.lang.String fileNameSuffix, ReportVariables reportVariables)

Method Summary

void	compute(SimEvent event) Update variables.
void	createWriter()
void	dispose(SimEvent event) Clean up any side effects (eg close file).
void	eventOccurred(SimEvent event)
java.lang.String	getFileName()
java.lang.Object	getFileNameExtension()
java.lang.Object	getFileNamePrefix()
java.lang.String	getFileNameSuffix()
java.lang.String	getName()
java.lang.String	getNumberingSuffix()
ReportVariables	getReportVariables()
java.util.Map<java.lang.Object,java.lang.Number>	getVariableBindings() Get the values calculated by this report.
void	initialise(SimEvent event) Initialise the variables in response to event.
boolean	isAutoNumbering()
boolean	isPassThrough()
void	setAutoNumbering(boolean autoNumbering)
void	setFileNameExtension(java.lang.Object fileNameExtension)
void	setFileNamePrefix(java.lang.Object fileNamePrefix)
void	setFileNameSuffix(java.lang.String fileNameSuffix)
void	setPassThrough(boolean passThrough)
void	setReportVariables(ReportVariables reportVariables)

Methods inherited from class java.lang.Object

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

Field Detail

fileNameSuffix

protected java.lang.String fileNameSuffix

fileNamePrefix

protected java.lang.Object fileNamePrefix

fileNameExtension

protected java.lang.Object fileNameExtension

writer

protected CSVWriter writer

reportVariables

protected ReportVariables reportVariables

This report collects the data that we will write.

fileNumber

protected int fileNumber

autoNumbering

protected boolean autoNumbering

passThrough

protected boolean passThrough

Constructor Detail

CSVReportVariables

public CSVReportVariables(java.lang.String fileNameSuffix,
                          java.lang.Object fileNamePrefix,
                          ReportVariables reportVariables)

CSVReportVariables

public CSVReportVariables(java.lang.String fileNameSuffix,
                          ReportVariables reportVariables)

CSVReportVariables

public CSVReportVariables()

Method Detail

compute

public void compute(SimEvent event)

Description copied from interface: ReportVariables

Update variables.

Specified by:

compute in interface ReportVariables

createWriter

public void createWriter()

getFileName

public java.lang.String getFileName()

getNumberingSuffix

public java.lang.String getNumberingSuffix()

getVariableBindings

public java.util.Map<java.lang.Object,java.lang.Number> getVariableBindings()

Description copied from interface: Report

Get the values calculated by this report.

Specified by:

getVariableBindings in interface Report

Returns:

A Map of user-readable variable names to their associated values.

getFileNameSuffix

public java.lang.String getFileNameSuffix()

setFileNameSuffix

public void setFileNameSuffix(java.lang.String fileNameSuffix)

getFileNamePrefix

public java.lang.Object getFileNamePrefix()

setFileNamePrefix

public void setFileNamePrefix(java.lang.Object fileNamePrefix)

eventOccurred

public void eventOccurred(SimEvent event)

Specified by:

eventOccurred in interface EventListener

dispose

public void dispose(SimEvent event)

Description copied from interface: ReportVariables

Clean up any side effects (eg close file).

Specified by:

dispose in interface ReportVariables

initialise

public void initialise(SimEvent event)

Description copied from interface: ReportVariables

Initialise the variables in response to event.

Specified by:

initialise in interface ReportVariables

getReportVariables

public ReportVariables getReportVariables()

setReportVariables

public void setReportVariables(ReportVariables reportVariables)

isAutoNumbering

public boolean isAutoNumbering()

setAutoNumbering

public void setAutoNumbering(boolean autoNumbering)

getFileNameExtension

public java.lang.Object getFileNameExtension()

setFileNameExtension

public void setFileNameExtension(java.lang.Object fileNameExtension)

isPassThrough

public boolean isPassThrough()

setPassThrough

public void setPassThrough(boolean passThrough)

getName

public java.lang.String getName()

Specified by:

getName in interface Report

Specified by:

getName in interface ReportVariables