org.semanticweb.owl.explanation.api

Class NullExplanationProgressMonitor<E>

java.lang.Object

org.semanticweb.owl.explanation.api.NullExplanationProgressMonitor<E>

All Implemented Interfaces:

ExplanationProgressMonitor<E>

public class NullExplanationProgressMonitor<E>
extends Object
implements ExplanationProgressMonitor<E>

Author: Matthew Horridge
The University of Manchester
Information Management Group
Date: 28-Nov-2008 A progress monitor that does nothing and specifies that the explanation generator should continue finding explanations.

Constructor Summary

Constructors

Constructor and Description
NullExplanationProgressMonitor()

Method Summary

Methods

Modifier and Type	Method and Description
void	foundExplanation(ExplanationGenerator<E> explanationGenerator, Explanation<E> eExplanation, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullExplanationProgressMonitor

public NullExplanationProgressMonitor()

Method Detail

foundExplanation

public void foundExplanation(ExplanationGenerator<E> explanationGenerator,
                    Explanation<E> eExplanation,
                    Set<Explanation<E>> allFoundExplanations)

Description copied from interface: ExplanationProgressMonitor

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.

Specified by:

foundExplanation in interface ExplanationProgressMonitor<E>

Parameters:

explanationGenerator - The explanation generator that found the explanation

eExplanation - 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

public boolean isCancelled()

Description copied from interface: ExplanationProgressMonitor

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

Specified by:

isCancelled in interface ExplanationProgressMonitor<E>

Returns:

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