Package org.corpus_tools.pepper.common

Class ModuleFitness

java.lang.Object

org.corpus_tools.pepper.common.ModuleFitness

public class ModuleFitness
extends Object

An object determining the fitness of a single Pepper module. Multiple single fitness values forms one combined value determining the overall fitness.

Author:

florian

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleFitness.Fitness
static class	ModuleFitness.FitnessFeature
static class	ModuleFitness.ModuleFitnessBuilder	A simple builder to create ModuleFitness objects.

Constructor Summary

Constructors

Constructor	Description
ModuleFitness(String moduleName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Boolean	getFitness(ModuleFitness.FitnessFeature feature)
String	getModuleName()
ModuleFitness.Fitness	getOverallFitness()	Returns a combined fitness value representing all single values.
int	hashCode()
void	setFeature(ModuleFitness.FitnessFeature feature, boolean value)	Sets the value to the specified feature.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleFitness

public ModuleFitness(String moduleName)

Method Detail

getModuleName

public String getModuleName()

setFeature

public void setFeature(ModuleFitness.FitnessFeature feature,
                       boolean value)

Sets the value to the specified feature. If the ModuleFitness.FitnessFeature is a health feature, true means ModuleFitness.Fitness.FIT and false means ModuleFitness.Fitness.HEALTHY. If the ModuleFitness.FitnessFeature is a fitness feature, true means ModuleFitness.Fitness.HEALTHY and false means ModuleFitness.Fitness.CRITICAL.

Parameters:

feature -

value -

getFitness

public Boolean getFitness(ModuleFitness.FitnessFeature feature)

getOverallFitness

public ModuleFitness.Fitness getOverallFitness()

Returns a combined fitness value representing all single values. A module is: ModuleFitness.Fitness.FIT

• ModuleFitness.Fitness.FIT, when all single fitness feature are fit
• ModuleFitness.Fitness.HEALTHY, when all health feature are fit, but at least one of the fitness ones isn't
• ModuleFitness.Fitness.CRITICAL, at least one health feature is not fit

Returns:

the overall fitness value

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object