org.semanticweb.owl.explanation.api

Interface ExplanationProgressMonitor<E>

All Known Implementing Classes:

ConsoleExplanationProgressMonitor, LaconicExplanationGenerator, NullExplanationProgressMonitor

public interface ExplanationProgressMonitor<E>

Author: Matthew Horridge
The University of Manchester
Information Management Group
Date: 28-Nov-2008

Method Summary

Modifier and Type	Method and Description
void	foundExplanation(ExplanationGenerator<E> generator, Explanation<E> explanation, Set<Explanation<E>> allFoundExplanations) Called by explanation generators that support progress monitors.
boolean	isCancelled() The explanation generator will periodically check to see if it should continue finding explanations by calling this method.

Method Detail

foundExplanation

void foundExplanation(ExplanationGenerator<E> generator,
                      Explanation<E> explanation,
                      Set<Explanation<E>> allFoundExplanations)

Called by explanation generators that support progress monitors. This is called when a new explanation is found for an entailment when searching for multiple explanations.

Parameters:

generator - The explanation generator that found the explanation

explanation - The explanation that was found for the entailment or false if the explanation generator should stop finding explanations at the next opportunity.

allFoundExplanations - All of the explanations found so far for the specified entailment

isCancelled

boolean isCancelled()

The explanation generator will periodically check to see if it should continue finding explanations by calling this method.

Returns:

true if the explanation generator should cancel the explanation finding process or false if the explanation generator should continue.