Package org.anchoranalysis.feature.io.csv.results

Class LabelledResultsCSVWriter

Object

LabelledResultsCSVWriter

public abstract class LabelledResultsCSVWriter
extends Object

Allows results to be written to a FeatureCSVWriter, possibly adding further processing.

Author:

Owen Feehan

Field Summary

Fields

Modifier and Type	Field	Description
protected final FeatureCSVMetadataForOutput	outputMetadata	Metadata defining which CSV file to write to, and which headers.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LabelledResultsCSVWriter(FeatureCSVMetadataForOutput outputMetadata, FeatureCSVWriterFactory writerCreator, Optional<Consumer<LabelledResultsVector>> consumeAfterAdding)	Creates a new LabelledResultsCSVWriter instance.

Method Summary

Modifier and Type	Method	Description
abstract void	add(LabelledResultsVector results)	Adds a results-element to be written.
protected Optional<FeatureCSVWriter>	createWriter(FeatureCSVMetadata csvMetadata)	Creates a CSVWriter.
abstract void	end()	Stops writing the CSV file.
protected void	maybeConsumeResults(LabelledResultsVector results)	Consumes the LabelledResultsVector if consumeAfterAdding is present.
abstract void	start()	Starts writing the CSV file.

Methods inherited from class java.lang.Object

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

Field Details

outputMetadata

protected final FeatureCSVMetadataForOutput outputMetadata

Metadata defining which CSV file to write to, and which headers.

Constructor Details

LabelledResultsCSVWriter

protected LabelledResultsCSVWriter(FeatureCSVMetadataForOutput outputMetadata,
 FeatureCSVWriterFactory writerCreator,
 Optional<Consumer<LabelledResultsVector>> consumeAfterAdding)

Creates a new LabelledResultsCSVWriter instance.

Parameters:

outputMetadata - Metadata defining which CSV file to write to, and which headers.

writerCreator - Creates a FeatureCSVWriter for writing the non-aggregated feature results.

consumeAfterAdding - After adding a LabelledResultsVector, this function is also called, if it is defined.

Method Details

start

public abstract void start()
                    throws OutputWriteFailedException

Starts writing the CSV file.

This should be called once, before any calls to add(LabelledResultsVector).

Throws:

OutputWriteFailedException - if the output file cannot be created.

add

public abstract void add(LabelledResultsVector results)

Adds a results-element to be written.

This should be called once for each set of results to be written.

Parameters:

results - the results.

end

public abstract void end()
                  throws OutputWriteFailedException

Stops writing the CSV file.

This should be called once, after all calls to add(LabelledResultsVector).

Throws:

OutputWriteFailedException - if the output file cannot be created.

createWriter

protected Optional<FeatureCSVWriter> createWriter(FeatureCSVMetadata csvMetadata)
                                           throws OutputWriteFailedException

Creates a CSVWriter.

Parameters:

csvMetadata - the metadata for the writer.

Returns:

the newly-created writer, if possible.

Throws:

OutputWriteFailedException - if the CSV file cannot be created successfully.

maybeConsumeResults

protected void maybeConsumeResults(LabelledResultsVector results)

Consumes the LabelledResultsVector if consumeAfterAdding is present.

Parameters:

results - the results to maybe consume.