org.corpus_tools.pepper.core

Class ModuleFitnessChecker

java.lang.Object

org.corpus_tools.pepper.core.ModuleFitnessChecker

public class ModuleFitnessChecker
extends Object

A helper class for checking health and fitness of a module or a set of modules.

Author:

florian

Constructor Summary

Constructors

Constructor and Description
ModuleFitnessChecker()
ModuleFitnessChecker(Pepper pepper)

Method Summary

Modifier and Type	Method and Description
List<ModuleFitness>	checkFitness(Collection<PepperModule> modules) Returns a ModuleFitness value for each PepperModule in specified list.
ModuleFitness	checkFitness(PepperModule module) Returns a ModuleFitness value for specified PepperModule.
List<ModuleFitness>	checkHealth(Collection<PepperModule> modules) Returns a ModuleFitness value for each PepperModule in specified list.
ModuleFitness	checkHealth(PepperModule module) Returns a ModuleFitness value for specified PepperModule.
ModuleFitness	selfTest(PepperModule pepperModule) When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran.
protected ModuleFitness	selfTest(PepperModule pepperModule, ModuleFitness moduleFitness) When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran.
protected ModuleFitness	selfTest(PepperModule pepperModule, ModuleFitness moduleFitness, SelfTestDesc selfTestDesc) When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleFitnessChecker

public ModuleFitnessChecker(Pepper pepper)

ModuleFitnessChecker

public ModuleFitnessChecker()

Method Detail

checkFitness

public List<ModuleFitness> checkFitness(Collection<PepperModule> modules)

Returns a ModuleFitness value for each PepperModule in specified list.

Parameters:

modules -

Returns:

checkFitness

public ModuleFitness checkFitness(PepperModule module)

Returns a ModuleFitness value for specified PepperModule.

Parameters:

modules -

Returns:

checkHealth

public List<ModuleFitness> checkHealth(Collection<PepperModule> modules)

Returns a ModuleFitness value for each PepperModule in specified list. Only checks ModuleFitness.FitnessFeature.getHealthFeatures().

Parameters:

modules -

Returns:

checkHealth

public ModuleFitness checkHealth(PepperModule module)

Returns a ModuleFitness value for specified PepperModule. Only checks ModuleFitness.FitnessFeature.getHealthFeatures().

Parameters:

modules -

Returns:

selfTest

public ModuleFitness selfTest(PepperModule pepperModule)

When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran. Depending on success, the following health features are set:

• ModuleFitness.FitnessFeature.HAS_PASSED_SELFTEST
• ModuleFitness.FitnessFeature.IS_IMPORTABLE_SEFTEST_DATA
• ModuleFitness.FitnessFeature.IS_VALID_SELFTEST_DATA

Parameters:

pepperModule - module to test

pepper - Pepper environment to test

selfTest

protected ModuleFitness selfTest(PepperModule pepperModule,
                                 ModuleFitness moduleFitness)

When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran. Depending on success, the following health features are set:

• ModuleFitness.FitnessFeature.HAS_PASSED_SELFTEST
• ModuleFitness.FitnessFeature.IS_IMPORTABLE_SEFTEST_DATA
• ModuleFitness.FitnessFeature.IS_VALID_SELFTEST_DATA

Parameters:

pepperModule - module to test

pepper - Pepper environment to test

moduleFitness - the ModuleFitness to be filled.

selfTest

protected ModuleFitness selfTest(PepperModule pepperModule,
                                 ModuleFitness moduleFitness,
                                 SelfTestDesc selfTestDesc)

When the specified module provides a self test, the fitness feature ModuleFitness.FitnessFeature.HAS_SELFTEST is set to true and self test is ran. Depending on success, the following health features are set:

• ModuleFitness.FitnessFeature.HAS_PASSED_SELFTEST
• ModuleFitness.FitnessFeature.IS_IMPORTABLE_SEFTEST_DATA
• ModuleFitness.FitnessFeature.IS_VALID_SELFTEST_DATA

Parameters:

pepperModule - module to test

pepper - Pepper environment to test

moduleFitness - the ModuleFitness to be filled.

selfTestDesc - The self-test description as provided by PepperModule.getSelfTestDesc()