de.jstacs.results.savers

Interface ResultSaver<T extends Result>

Type Parameters:

T - the type of the Results that can be saved

All Known Implementing Classes:

DataSetResultSaver, ListResultSaver, PlotGeneratorResultSaver, ResultSetResultSaver, StorableResultSaver, TextResultSaver

public interface ResultSaver<T extends Result>

Interface for saving Results to a file. Specific implementations for different Result types required. Each implementation must register using ResultSaverLibrary.register(Class, ResultSaver) to become available in other classes.

Author:

Jan Grau

Method Summary

Modifier and Type	Method and Description
String[]	getFileExtensions(T result) Returns the file extensions (in descending preference) for storing the given Result
boolean	isAtomic() Returns true if this ResultSaver is for storing atomic Results.
boolean	writeOutput(T result, File path) Writes the output (i.e., the result contents) to the supplied file.
boolean	writeOutput(T result, StringBuffer buf) Appends the output (i.e., the result contents) to the supplied StringBuffer

Method Detail

isAtomic

boolean isAtomic()

Returns true if this ResultSaver is for storing atomic Results.

Returns:

if this ResultSaver is for storing atomic Results.

getFileExtensions

String[] getFileExtensions(T result)

Returns the file extensions (in descending preference) for storing the given Result

Parameters:

result - the result

Returns:

the file extension(s)

writeOutput

boolean writeOutput(T result,
                    File path)

Writes the output (i.e., the result contents) to the supplied file.

Parameters:

result - the result

path - the output file

Returns:

if writing was successful

writeOutput

boolean writeOutput(T result,
                    StringBuffer buf)

Appends the output (i.e., the result contents) to the supplied StringBuffer

Parameters:

result - the result

buf - the buffer

Returns:

if appending was successful