de.jstacs.results.savers

Class ResultSetResultSaver

java.lang.Object

de.jstacs.results.savers.ResultSetResultSaver

All Implemented Interfaces:

ResultSaver<ResultSetResult>

public class ResultSetResultSaver
extends Object
implements ResultSaver<ResultSetResult>

ResultSaver for a ResultSetResult. File names for the Results in the contained ResultSet are defined using the AnnotatedEntity.getName() method, replacing whitespace with underscores. If a file with the corresponding name already exists, a number is appended and the existing file is not overwritten.

Author:

Jan Grau

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getFileExtensions(ResultSetResult 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.
static void	register() Registers this ResultSaver in the ResultSaverLibrary
boolean	writeOutput(ResultSetResult result, File dir) Writes the output (i.e., the result contents) to the supplied file.
boolean	writeOutput(ResultSetResult result, StringBuffer buf) Appends the output (i.e., the result contents) to the supplied StringBuffer

Methods inherited from class java.lang.Object

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

Method Detail

register

public static void register()

Registers this ResultSaver in the ResultSaverLibrary

isAtomic

public boolean isAtomic()

Description copied from interface: ResultSaver

Returns true if this ResultSaver is for storing atomic Results.

Specified by:

isAtomic in interface ResultSaver<ResultSetResult>

Returns:

if this ResultSaver is for storing atomic Results.

getFileExtensions

public String[] getFileExtensions(ResultSetResult result)

Description copied from interface: ResultSaver

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

Specified by:

getFileExtensions in interface ResultSaver<ResultSetResult>

Parameters:

result - the result

Returns:

the file extension(s)

writeOutput

public boolean writeOutput(ResultSetResult result,
                  File dir)

Description copied from interface: ResultSaver

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

Specified by:

writeOutput in interface ResultSaver<ResultSetResult>

Parameters:

result - the result

dir - the output file

Returns:

if writing was successful

writeOutput

public boolean writeOutput(ResultSetResult result,
                  StringBuffer buf)

Description copied from interface: ResultSaver

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

Specified by:

writeOutput in interface ResultSaver<ResultSetResult>

Parameters:

result - the result

buf - the buffer

Returns:

if appending was successful