de.zmt.output.writing

Class OneShotOutputWriter

java.lang.Object

de.zmt.output.writing.OneShotOutputWriter

All Implemented Interfaces:

OutputWriter, Closeable, Serializable, AutoCloseable

public class OneShotOutputWriter
extends Object

OutputWriter implementation writing data from a MultiCollectable into a step indexed file.

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.zmt.output.writing.OutputWriter

EMPTY

Constructor Summary

Constructors

Constructor and Description
OneShotOutputWriter(MultiCollectable<?> collectable, Path outputPathBase) Constructs a new OneShotWritingCollector.

Method Summary

Modifier and Type	Method and Description
protected T	getCollectable() Returns the Collectable containing the data to be written.
String	getFileName() Returns the name of the file where data is to be written.
void	setOutputPath(Path outputPathBase) Sets the output path base pointing to the directory where to create the files for each shot.
String	toString()
protected void	writeHeaders(de.zmt.output.writing.CsvWriter writer) Write headers from collectable using the writer.
void	writeValues(long steps) Implementing classes need to specify how to write values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.zmt.output.writing.OutputWriter

close

Constructor Detail

OneShotOutputWriter

public OneShotOutputWriter(MultiCollectable<?> collectable,
                           Path outputPathBase)

Constructs a new OneShotWritingCollector.

Parameters:

collectable - the MultiCollectable to write data from

outputPathBase - the base file to be used, the step number will be attached each time

Method Detail

writeValues

public void writeValues(long steps)
                 throws IOException

Description copied from interface: OutputWriter

Implementing classes need to specify how to write values. Called after the collection process.

Parameters:

steps - the number of steps passed in Schedule

Throws:

IOException - If an I/O error occurs

setOutputPath

public void setOutputPath(Path outputPathBase)

Sets the output path base pointing to the directory where to create the files for each shot.

Parameters:

outputPathBase - the output path base

writeHeaders

protected final void writeHeaders(de.zmt.output.writing.CsvWriter writer)

Write headers from collectable using the writer.

Parameters:

writer - the writer to write the headers

getCollectable

protected T getCollectable()

Returns the Collectable containing the data to be written.

Returns:

the Collectable containing the data to be written

getFileName

public String getFileName()

Returns the name of the file where data is to be written.

Returns:

the name of the file where data is to be written

toString

public String toString()

Overrides:

toString in class Object