org.corpus_tools.pepper.common.ModuleFitness Class Reference

An object determining the fitness of a single Pepper module. More...

Classes
enum	Fitness
enum	FitnessFeature
class	ModuleFitnessBuilder
	A simple builder to create ModuleFitness objects.

Public Member Functions
	ModuleFitness (final String moduleName)
String	getModuleName ()
void	setFeature (final FitnessFeature feature, boolean value)
	Sets the value to the specified feature. More...
Boolean	getFitness (final FitnessFeature feature)
Fitness	getOverallFitness ()
	Returns a combined fitness value representing all single values. More...
String	toString ()
int	hashCode ()
boolean	equals (Object obj)

Detailed Description

An object determining the fitness of a single Pepper module.

Multiple single fitness values forms one combined value determining the overall fitness.

Author

florian

Member Function Documentation

getOverallFitness()

Fitness org.corpus_tools.pepper.common.ModuleFitness.getOverallFitness

(

)

Returns a combined fitness value representing all single values.

A module is: Fitness#FIT

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

Returns

the overall fitness value

setFeature()

void org.corpus_tools.pepper.common.ModuleFitness.setFeature	(	final FitnessFeature	feature,
		boolean	value
	)

Sets the value to the specified feature.

If the FitnessFeature is a health feature, true means Fitness#FIT and false means Fitness#HEALTHY. If the FitnessFeature is a fitness feature, true means Fitness#HEALTHY and false means Fitness#CRITICAL.

Parameters

feature
value