de.fzi.kadmos.cmdutils.result
Class EvaluatorResult

java.lang.Object
  de.fzi.kadmos.cmdutils.result.EvaluatorResult

Direct Known Subclasses:

PrecRecEvaluatorResult, SymProxEvaluatorResult

public abstract class EvaluatorResult
extends Object

Abstract class for an Evaluator result. An evaluator result object contains an alignment the result is associated with. The result is computed by calling applyEvalutor(de.fzi.kadmos.evaluator.Evaluator) method, passing in an Evaluator object. The actual metrics and values of the result are subject to the extending class. Methods for retrieving the set of metrics and values is provided.

Since:

1.0.1

Version:

1.3.0

Author:

Matthias Stumpp

Field Summary

protected Alignment	alignment
protected String	alignmentName

Constructor Summary

EvaluatorResult(String alignmentName, Alignment alignment)
Creates a new EvaluatorResult instance.

Method Summary

abstract void	applyEvalutor(Evaluator evaluator) Initiates computation of metrics and stores their values in the appropriate fields of extending class
Alignment	getAlignment() Getter method for the alignment object this evaluator result object is associated with
String	getAlignmentName() Getter method for the alignment name this evaluator result object is associated with
abstract List<Object>	getMetrics() Getter method for retrieving list of metrics
abstract List<Object>	getValues() Getter method for retrieving list of values

Methods inherited from class java.lang.Object

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

Field Detail

alignmentName

protected String alignmentName

alignment

protected Alignment alignment

Constructor Detail

EvaluatorResult

public EvaluatorResult(String alignmentName,
                       Alignment alignment)

Creates a new EvaluatorResult instance.

Parameters:

alignmentName - Alignment name.

alignmentName - Alignment name.

alignmentName - Alignment name.

alignmentName - Alignment name.

alignmentName - Alignment name.

alignmentName - Alignment name.

alignment - Alignment to be evaluated.

Since:

1.0.1

Method Detail

getAlignmentName

public String getAlignmentName()

Getter method for the alignment name this evaluator result object is associated with

Returns:

Alignment name

Since:

1.0.1

getAlignment

public Alignment getAlignment()

Getter method for the alignment object this evaluator result object is associated with

Returns:

Alignment object

Since:

1.0.1

applyEvalutor

public abstract void applyEvalutor(Evaluator evaluator)
                            throws IncompatibleAlignmentsException,
                                   KADMOSCMDException

Initiates computation of metrics and stores their values in the appropriate fields of extending class

Parameters:

Evaluator - object that actually computes the metrics.

Throws:

IncompatibleAlignmentsException

KADMOSCMDException

Since:

1.0.1

getMetrics

public abstract List<Object> getMetrics()

Getter method for retrieving list of metrics

Returns:

List of objects representing the metrics to be computed.

Since:

1.0.1

getValues

public abstract List<Object> getValues()

Getter method for retrieving list of values

Returns:

List of objects representing the computed values.

Since:

1.0.1