Package repast.simphony.data2

Class BatchParamMapFileWriter

java.lang.Object

repast.simphony.data2.BatchParamMapFileWriter

All Implemented Interfaces:

DataSink

public class BatchParamMapFileWriter
extends Object
implements DataSink

DataSink that provides a mapping between a batch run number and the current batch parameters.

Author:

Nick Collier

Constructor Summary

Constructors

Constructor	Description
BatchParamMapFileWriter(BatchRunDataSource source, FileNameFormatter fnFormatter, String delimiter, FormatType formatType)

Method Summary

Modifier and Type	Method	Description
final void	append(String key, Object value)	Appends the specified data to this sink.
void	close()	Close this DataSink.
void	flush()	Flushes any data buffered by this DataSink.
final void	open(List<String> sourceIds)	Open this DataSink.
final void	recordEnded()	Notified this DataSink that the current record has ended.
final void	rowEnded()	Notifies this DataSink that the last append was end of a "row."
final void	rowStarted()	Notifies this DataSink that the next append is that start of a "row." of data.
void	runStarted()	Notifies this BatchParamMapFileWriter that another batch run has started, so we write the current parameter values to a file.

Methods inherited from class java.lang.Object

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

Constructor Details

BatchParamMapFileWriter

public BatchParamMapFileWriter(BatchRunDataSource source,
 FileNameFormatter fnFormatter,
 String delimiter,
 FormatType formatType)

Method Details

open

public final void open(List<String> sourceIds)

Description copied from interface: DataSink

Open this DataSink.

Specified by:

open in interface DataSink

Parameters:

sourceIds - a list of the DataSource ids for which this is the sink.

flush

public void flush()

Description copied from interface: DataSink

Flushes any data buffered by this DataSink.

Specified by:

flush in interface DataSink

runStarted

public void runStarted()

Notifies this BatchParamMapFileWriter that another batch run has started, so we write the current parameter values to a file.

rowStarted

public final void rowStarted()

Description copied from interface: DataSink

Notifies this DataSink that the next append is that start of a "row." of data.

Specified by:

rowStarted in interface DataSink

append

public final void append(String key,
 Object value)

Description copied from interface: DataSink

Appends the specified data to this sink. The key can be, for example, a column name and the value the current value for that column.

Specified by:

append in interface DataSink

Parameters:

key - the data's key

value - the data's value

rowEnded

public final void rowEnded()

Description copied from interface: DataSink

Notifies this DataSink that the last append was end of a "row."

Specified by:

rowEnded in interface DataSink

recordEnded

public final void recordEnded()

Description copied from interface: DataSink

Notified this DataSink that the current record has ended.

Specified by:

recordEnded in interface DataSink

close

public void close()

Description copied from interface: DataSink

Close this DataSink.

Specified by:

close in interface DataSink