org.semanticweb.elk.reasoner.stages
Interface ReasonerStage

All Known Implementing Classes:

AxiomLoadingStage, ClassSaturationStage, IncrementalAdditionInitializationStage, IncrementalAdditionStage, IncrementalClassTaxonomyComputationStage, IncrementalCompletionStage, IncrementalContextCleaningStage, IncrementalDeletionInitializationStage, IncrementalDeletionStage, IncrementalInstanceTaxonomyComputationStage, IncrementalOverdeletionPruningStage, IncrementalTaxonomyCleaningStage, PropertyHierarchyCompositionComputationStage, PropertyReflexivityComputationStage

public interface ReasonerStage

A basic computation unit that can be executed by a reasoner. A ReasonerStage can specify other ReasonerStages as dependencies. Thus, several stages can be chained within a reasoning process.

Author:

"Yevgeny Kazakov"

Method Summary

void	clearInterrupt() Clears the interrupt status of this executor
void	execute() Performs the execution of this stage.
String	getName()
Iterable<? extends ReasonerStage>	getPreStages()
boolean	isCompleted()
boolean	isInterrupted()
boolean	postExecute() Invoked after execute() to perform any necessary clean-up.
boolean	preExecute() Invoked prior to execute() to perform any necessary initialization
void	printInfo() Prints detailed information about the (progress) of this stage.

Method Detail

getName

String getName()

Returns:

a string identifier of this stage

isCompleted

boolean isCompleted()

Returns:

true if the results for this stage have been already computed; this does not necessarily mean that this stage was executed: the results of the computation could have been computed by other stages

getPreStages

Iterable<? extends ReasonerStage> getPreStages()

Returns:

the list of stages that are required to be executed before executing this stage; the order of the execution does not matter

preExecute

boolean preExecute()

Invoked prior to execute() to perform any necessary initialization

Returns:

true if the operation is successful

execute

void execute()
             throws ElkException

Performs the execution of this stage.

Throws:

ElkException - if execution was not successful

postExecute

boolean postExecute()

Invoked after execute() to perform any necessary clean-up. Could be invoked before execute() if preExecute() threw an exception. FIXME: can preExecute() throw an exception? If so, document.

Returns:

true if the operation is successful

isInterrupted

boolean isInterrupted()

Returns:

true if this executor was interrupted

clearInterrupt

void clearInterrupt()

Clears the interrupt status of this executor

printInfo

void printInfo()

Prints detailed information about the (progress) of this stage. This function can be used to print statistics after this stage is executed or interrupted.