org.corpus_tools.pepper.core.ModuleFitnessChecker Class Reference

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

Public Member Functions
	ModuleFitnessChecker (Pepper pepper)
List< ModuleFitness >	checkFitness (final Collection< PepperModule > modules)
	Returns a ModuleFitness value for each PepperModule in specified list.
ModuleFitness	checkFitness (final PepperModule module)
	Returns a ModuleFitness value for specified PepperModule.
List< ModuleFitness >	checkHealth (final Collection< PepperModule > modules)
	Returns a ModuleFitness value for each PepperModule in specified list.
ModuleFitness	checkHealth (final PepperModule module)
	Returns a ModuleFitness value for specified PepperModule.
ModuleFitness	selfTest (final PepperModule pepperModule)
	When the specified module provides a self test, the fitness feature FitnessFeature#HAS_SELFTEST is set to true and self test is ran.

Protected Member Functions
ModuleFitness	selfTest (final PepperModule pepperModule, ModuleFitness moduleFitness)
	When the specified module provides a self test, the fitness feature FitnessFeature#HAS_SELFTEST is set to true and self test is ran.
ModuleFitness	selfTest (final PepperModule pepperModule, ModuleFitness moduleFitness, SelfTestDesc selfTestDesc)
	When the specified module provides a self test, the fitness feature FitnessFeature#HAS_SELFTEST is set to true and self test is ran.

Detailed Description

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

Author

florian

Member Function Documentation

checkFitness() [1/2]

List< ModuleFitness > org.corpus_tools.pepper.core.ModuleFitnessChecker.checkFitness

(

final Collection< PepperModule >

modules

)

Returns a ModuleFitness value for each PepperModule in specified list.

Parameters

modules

Returns

checkFitness() [2/2]

ModuleFitness org.corpus_tools.pepper.core.ModuleFitnessChecker.checkFitness

(

final PepperModule

module

)

Returns a ModuleFitness value for specified PepperModule.

Parameters

modules

Returns

checkHealth() [1/2]

List< ModuleFitness > org.corpus_tools.pepper.core.ModuleFitnessChecker.checkHealth

(

final Collection< PepperModule >

modules

)

Returns a ModuleFitness value for each PepperModule in specified list.

Only checks FitnessFeature#getHealthFeatures().

Parameters

modules

Returns

checkHealth() [2/2]

ModuleFitness org.corpus_tools.pepper.core.ModuleFitnessChecker.checkHealth

(

final PepperModule

module

)

Returns a ModuleFitness value for specified PepperModule.

Only checks FitnessFeature#getHealthFeatures().

Parameters

modules

Returns

selfTest() [1/3]

ModuleFitness org.corpus_tools.pepper.core.ModuleFitnessChecker.selfTest

(

final PepperModule

pepperModule

)

When the specified module provides a self test, the fitness feature FitnessFeature#HAS_SELFTEST is set to true and self test is ran.

Depending on success, the following health features are set:

• FitnessFeature#HAS_PASSED_SELFTEST
• FitnessFeature#IS_IMPORTABLE_SEFTEST_DATA
• FitnessFeature#IS_VALID_SELFTEST_DATA

Parameters

pepperModule	module to test
pepper	Pepper environment to test

selfTest() [2/3]

ModuleFitness org.corpus_tools.pepper.core.ModuleFitnessChecker.selfTest ( final PepperModule  pepperModule, ModuleFitness  moduleFitness  )

protected

When the specified module provides a self test, the fitness feature FitnessFeature#HAS_SELFTEST is set to true and self test is ran.

Depending on success, the following health features are set:

• FitnessFeature#HAS_PASSED_SELFTEST
• FitnessFeature#IS_IMPORTABLE_SEFTEST_DATA
• FitnessFeature#IS_VALID_SELFTEST_DATA

Parameters

pepperModule	module to test
pepper	Pepper environment to test
moduleFitness	the ModuleFitness to be filled.

selfTest() [3/3]

ModuleFitness org.corpus_tools.pepper.core.ModuleFitnessChecker.selfTest ( final PepperModule  pepperModule, ModuleFitness  moduleFitness, SelfTestDesc  selfTestDesc  )

protected

When the specified module provides a self test, the fitness feature FitnessFeature#HAS_SELFTEST is set to true and self test is ran.

Depending on success, the following health features are set:

• FitnessFeature#HAS_PASSED_SELFTEST
• FitnessFeature#IS_IMPORTABLE_SEFTEST_DATA
• 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()