de.zmt.output.writing

Class LineOutputWriter<T extends Collectable<?>>

java.lang.Object

de.zmt.output.writing.LineOutputWriter<T>

Type Parameters:

T - the type of Collectable

All Implemented Interfaces:

OutputWriter, Closeable, Serializable, AutoCloseable

Direct Known Subclasses:

MultiLineOutputWriter

public class LineOutputWriter<T extends Collectable<?>>
extends Object

OutputWriter implementation writing data line by line in CSV format.

See Also:

Serialized Form

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
LineOutputWriter(T collectable, Path outputPath) Constructs a new WritingCollector.

Method Summary

Modifier and Type	Method and Description
void	close() If this writer keeps any resources open that needs closing, it has to be done here.
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.
protected de.zmt.output.writing.CsvWriter	getWriter()
void	setOutputPath(Path outputPath) Sets the output path for this writer.
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

Constructor Detail

LineOutputWriter

public LineOutputWriter(T collectable,
                        Path outputPath)

Constructs a new WritingCollector. Headers are written immediately after opening the file.

Parameters:

collectable - the Collectable to write data from

outputPath - the file data is written to

Method Detail

getWriter

protected final de.zmt.output.writing.CsvWriter getWriter()

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 outputPath)

Description copied from interface: OutputWriter

Sets the output path for this writer. The path is assumed to point to an existing directory.

Will be called during deserialization from Output for all associated writers. No need to handle serialization within implementation.

Parameters:

outputPath - the output path

close

public void close()
           throws IOException

Description copied from interface: OutputWriter

If this writer keeps any resources open that needs closing, it has to be done here. Default implementation is an empty method.

Throws:

IOException

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