com.clarkparsia.owlapi.explanation

Class HSTExplanationGenerator

java.lang.Object

com.clarkparsia.owlapi.explanation.HSTExplanationGenerator

All Implemented Interfaces:

ExplanationGenerator, MultipleExplanationGenerator, SingleExplanationGenerator

public class HSTExplanationGenerator
extends Object
implements MultipleExplanationGenerator

HST explanation generator.

Constructor Summary

Constructors

Constructor and Description
HSTExplanationGenerator(TransactionAwareSingleExpGen singleExplanationGenerator) Instantiates a new hST explanation generator.

Method Summary

Modifier and Type	Method and Description
void	dispose() dispose of the reasoners and ontologies.
Set<OWLAxiom>	getExplanation(OWLClassExpression unsatClass) Returns a single explanation for the given unsatisfiable class.
Set<Set<OWLAxiom>>	getExplanations(OWLClassExpression unsatClass) Returns all the explanations for the given unsatisfiable class.
Set<Set<OWLAxiom>>	getExplanations(OWLClassExpression unsatClass, int maxExplanations) Return a specified number of explanations for the given unsatisfiable class.
OWLOntology	getOntology() Gets the ontology.
OWLOntologyManager	getOntologyManager() Gets the ontology manager.
OWLReasoner	getReasoner() Gets the reasoner.
OWLReasonerFactory	getReasonerFactory() Gets the reasoner factory.
TransactionAwareSingleExpGen	getSingleExplanationGenerator() Gets the single explanation generator.
void	setProgressMonitor(ExplanationProgressMonitor progressMonitor) Sets the progress monitor for this multiple explanation generator.

Methods inherited from class java.lang.Object

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

Constructor Detail

HSTExplanationGenerator

public HSTExplanationGenerator(@Nonnull
                               TransactionAwareSingleExpGen singleExplanationGenerator)

Instantiates a new hST explanation generator.

Parameters:

singleExplanationGenerator - explanation generator to use

Method Detail

setProgressMonitor

public void setProgressMonitor(ExplanationProgressMonitor progressMonitor)

Description copied from interface: MultipleExplanationGenerator

Sets the progress monitor for this multiple explanation generator.

Specified by:

setProgressMonitor in interface MultipleExplanationGenerator

Parameters:

progressMonitor - The progress monitor.

getOntologyManager

public OWLOntologyManager getOntologyManager()

Description copied from interface: SingleExplanationGenerator

Gets the ontology manager.

Specified by:

getOntologyManager in interface SingleExplanationGenerator

Returns:

the ontology manager for this explanation generator.

getOntology

public OWLOntology getOntology()

Description copied from interface: SingleExplanationGenerator

Gets the ontology.

Specified by:

getOntology in interface SingleExplanationGenerator

Returns:

the ontology according to which the explanations are generated

getReasoner

public OWLReasoner getReasoner()

Description copied from interface: SingleExplanationGenerator

Gets the reasoner.

Specified by:

getReasoner in interface SingleExplanationGenerator

Returns:

the reasoner associated with this generator.

getReasonerFactory

public OWLReasonerFactory getReasonerFactory()

Description copied from interface: SingleExplanationGenerator

Gets the reasoner factory.

Specified by:

getReasonerFactory in interface SingleExplanationGenerator

Returns:

the reasoner factory used to create fresh reasoners.

getSingleExplanationGenerator

@Nonnull
public TransactionAwareSingleExpGen getSingleExplanationGenerator()

Gets the single explanation generator.

Returns:

the explanation generator

getExplanation

public Set<OWLAxiom> getExplanation(OWLClassExpression unsatClass)

Description copied from interface: ExplanationGenerator

Returns a single explanation for the given unsatisfiable class.

Specified by:

getExplanation in interface ExplanationGenerator

Specified by:

getExplanation in interface SingleExplanationGenerator

Parameters:

unsatClass - The class that is unsatisfiable for which an explanation will be generated.

Returns:

A single explanation for the given unsatisfiable class, or empty set if the concept is satisfiable

getExplanations

public Set<Set<OWLAxiom>> getExplanations(OWLClassExpression unsatClass)

Description copied from interface: ExplanationGenerator

Returns all the explanations for the given unsatisfiable class.

Specified by:

getExplanations in interface ExplanationGenerator

Parameters:

unsatClass - The class that is unsatisfiable for which an explanation will be generated.

Returns:

All explanations for the given unsatisfiable class, or an empty set if the concept is satisfiable

dispose

public void dispose()

Description copied from interface: SingleExplanationGenerator

dispose of the reasoners and ontologies.

Specified by:

dispose in interface SingleExplanationGenerator

getExplanations

public Set<Set<OWLAxiom>> getExplanations(OWLClassExpression unsatClass,
                                          @Nonnegative
                                          int maxExplanations)

Description copied from interface: ExplanationGenerator

Return a specified number of explanations for the given unsatisfiable class. A smaller number of explanations can be returned if there are not as many explanations for the given concept. The returned set will be empty if the given class is satisfiable,

Specified by:

getExplanations in interface ExplanationGenerator

Parameters:

unsatClass - The class that is unsatisfiable for which an explanation will be generated.

maxExplanations - Maximum number of explanations requested, or 0 to get all the explanations

Returns:

A specified number of explanations for the given unsatisfiable class, or an empty set if the concept is satisfiable