de.jstacs.results.savers

Class StorableResultSaver

java.lang.Object

de.jstacs.results.savers.StorableResultSaver

All Implemented Interfaces:

ResultSaver<StorableResult>

public class StorableResultSaver
extends Object
implements ResultSaver<StorableResult>

Implements a ResultSaver for StorableResult. StorableResult are stored to files as their XML representation using Storable.toXML() of the contained Storable object. This object is obtained from the StorableResult.getResultInstance() method.

Author:

Jan Grau

Method Summary

Modifier and Type	Method and Description
String[]	getFileExtensions(StorableResult 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(StorableResult result, File path) Writes the output (i.e., the result contents) to the supplied file.
boolean	writeOutput(StorableResult 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<StorableResult>

Returns:

if this ResultSaver is for storing atomic Results.

getFileExtensions

public String[] getFileExtensions(StorableResult result)

Description copied from interface: ResultSaver

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

Specified by:

getFileExtensions in interface ResultSaver<StorableResult>

Parameters:

result - the result

Returns:

the file extension(s)

writeOutput

public boolean writeOutput(StorableResult result,
                           File path)

Description copied from interface: ResultSaver

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

Specified by:

writeOutput in interface ResultSaver<StorableResult>

Parameters:

result - the result

path - the output file

Returns:

if writing was successful

writeOutput

public boolean writeOutput(StorableResult 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<StorableResult>

Parameters:

result - the result

buf - the buffer

Returns:

if appending was successful