de.jstacs.tools

Class ToolResult

java.lang.Object

de.jstacs.AnnotatedEntity

de.jstacs.results.Result

de.jstacs.results.ListResult

de.jstacs.results.ResultSetResult

de.jstacs.tools.ToolResult

All Implemented Interfaces:

Storable

public class ToolResult
extends ResultSetResult

Class for the results of a JstacsTool. In addition to a standard ResultSetResult, this class stores some supplementary information like the parameters of the tool's run, the name of the tool, and the time the tool's run finished.

Author:

Jan Grau

Field Summary

Fields inherited from class de.jstacs.results.ListResult

list

Fields inherited from class de.jstacs.AnnotatedEntity

comment, datatype, name

Constructor Summary

Constructors

Constructor and Description
ToolResult(StringBuffer representation) The standard constructor for the interface Storable.
ToolResult(String name, String comment, ResultSet annotation, ResultSet result, ParameterSet toolParameters, String toolName, Date finished) Creates a new ToolResult with most arguments identical to those of a ListResult.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	appendFurtherInfos(StringBuffer buf) This method can be used in the method Storable.toXML() to extract further information (name, comment, datatype).
protected void	extractFurtherInfos(StringBuffer representation) This method can be used in the constructor with parameter StringBuffer to extract the further information.
Date	getFinishedDate() Returns the date and time, when the tool's run resulting in this ToolResult finished.
String	getToolName() Returns the name of the tool (see JstacsTool.getToolName()) used to create these results.
ParameterSet	getToolParameters() Returns the tool's parameters that have been used to create the results stored in this ToolResult.
void	setFromStoredParameters(ParameterSet other) Sets the values of all parameters in other to those stored in the internal parameters that have been supplied upon construction.

Methods inherited from class de.jstacs.results.ListResult

getAnnotation, getExport, getRawResult, getValue, getXMLTag, print, setExport, sort, toString

Methods inherited from class de.jstacs.results.Result

checkDatatype, createResult, isCastableResult, isComparableResult

Methods inherited from class de.jstacs.AnnotatedEntity

getComment, getDatatype, getName, toXML

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolResult

public ToolResult(String name,
          String comment,
          ResultSet annotation,
          ResultSet result,
          ParameterSet toolParameters,
          String toolName,
          Date finished)

Creates a new ToolResult with most arguments identical to those of a ListResult. In addition, it stores the name of the creating tool, the parameters for the tool's run (see JstacsTool.getToolParameters()), and the date/time of result creation.

Parameters:

name - the name of the result

comment - a comment on the meaning of the result

annotation - optional annotation, may be null

result - the set of all results of the tool's run

toolParameters - the (filled) parameters of the tool's run

toolName - the name of the tool

finished - the date/time the tool's run finished and results were created

ToolResult

public ToolResult(StringBuffer representation)
           throws NonParsableException

The standard constructor for the interface Storable. Creates a new ToolResult from the corresponding XML representation.

Parameters:

representation - the XML representation as StringBuffer

Throws:

NonParsableException - if the StringBufferrepresentation could not be parsed

Method Detail

getToolName

public String getToolName()

Returns the name of the tool (see JstacsTool.getToolName()) used to create these results.

Returns:

the name

getFinishedDate

public Date getFinishedDate()

Returns the date and time, when the tool's run resulting in this ToolResult finished.

Returns:

the date/time

appendFurtherInfos

protected void appendFurtherInfos(StringBuffer buf)

Description copied from class: AnnotatedEntity

This method can be used in the method Storable.toXML() to extract further information (name, comment, datatype).

Overrides:

appendFurtherInfos in class ListResult

Parameters:

buf - a XML representation of the main information as StringBuffer

See Also:

Storable.toXML()

extractFurtherInfos

protected void extractFurtherInfos(StringBuffer representation)
                            throws NonParsableException

Description copied from class: AnnotatedEntity

This method can be used in the constructor with parameter StringBuffer to extract the further information.

Overrides:

extractFurtherInfos in class ListResult

Parameters:

representation - a XML represenation of the main information as StringBuffer

Throws:

NonParsableException - if the XML representation is not parsable

See Also:

AnnotatedEntity.AnnotatedEntity(StringBuffer)

setFromStoredParameters

public void setFromStoredParameters(ParameterSet other)

Sets the values of all parameters in other to those stored in the internal parameters that have been supplied upon construction. Works successfully only if both parameter sets have an identical structure, which should be the case if both have been created from the same tool's JstacsTool.getToolParameters() method.

Parameters:

other - the parameters to be filled

See Also:

ToolResult(String, String, ResultSet, ResultSet, ParameterSet, String, Date)

getToolParameters

public ParameterSet getToolParameters()

Returns the tool's parameters that have been used to create the results stored in this ToolResult.

Returns:

the parameters

See Also:

JstacsTool.getToolParameters()