com.clarkparsia.owlapi.explanation

Class DefaultExplanationGenerator

java.lang.Object

com.clarkparsia.owlapi.explanation.DefaultExplanationGenerator

All Implemented Interfaces:

ExplanationGenerator

public class DefaultExplanationGenerator
extends Object
implements ExplanationGenerator

Since:

2.2.0

Author:

Matthew Horridge, Clark & Parsia, LLC, Bio-Health Informatics Group

Constructor Summary

Constructors

Constructor and Description
DefaultExplanationGenerator(OWLOntologyManager man, OWLReasonerFactory reasonerFactory, OWLOntology ontology, ExplanationProgressMonitor progressMonitor) Instantiates a new default explanation generator.
DefaultExplanationGenerator(OWLOntologyManager man, OWLReasonerFactory reasonerFactory, OWLOntology ontology, OWLReasoner reasoner, ExplanationProgressMonitor progressMonitor) Instantiates a new default explanation generator.

Method Summary

Modifier and Type	Method and Description
Set<OWLAxiom>	getExplanation(OWLAxiom axiom) Gets the explanation.
Set<OWLAxiom>	getExplanation(OWLClassExpression unsatClass) Returns a single explanation for the given unsatisfiable class.
Set<Set<OWLAxiom>>	getExplanations(OWLAxiom axiom) Gets the explanations.
Set<Set<OWLAxiom>>	getExplanations(OWLAxiom axiom, int maxExplanations) Gets the explanations.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExplanationGenerator

public DefaultExplanationGenerator(@Nonnull
                                   OWLOntologyManager man,
                                   @Nonnull
                                   OWLReasonerFactory reasonerFactory,
                                   @Nonnull
                                   OWLOntology ontology,
                                   @Nonnull
                                   ExplanationProgressMonitor progressMonitor)

Instantiates a new default explanation generator.

Parameters:

man - manager

reasonerFactory - reasoner factory

ontology - ontology to reason on

progressMonitor - progress monitor

DefaultExplanationGenerator

public DefaultExplanationGenerator(@Nonnull
                                   OWLOntologyManager man,
                                   @Nonnull
                                   OWLReasonerFactory reasonerFactory,
                                   @Nonnull
                                   OWLOntology ontology,
                                   @Nonnull
                                   OWLReasoner reasoner,
                                   @Nullable
                                   ExplanationProgressMonitor progressMonitor)

Instantiates a new default explanation generator.

Parameters:

man - manager

reasonerFactory - reasoner factory

ontology - ontology to reason on

reasoner - the reasoner to use

progressMonitor - progress monitor

Method Detail

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

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

getExplanation

@Nonnull
public Set<OWLAxiom> getExplanation(@Nonnull
                                             OWLAxiom axiom)

Gets the explanation.

Parameters:

axiom - the axiom to explain

Returns:

the explanation

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

getExplanations

@Nonnull
public Set<Set<OWLAxiom>> getExplanations(@Nonnull
                                                   OWLAxiom axiom)

Gets the explanations.

Parameters:

axiom - the axiom to explain

Returns:

the set of explanations

getExplanations

public Set<Set<OWLAxiom>> getExplanations(OWLClassExpression unsatClass,
                                          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

getExplanations

@Nonnull
public Set<Set<OWLAxiom>> getExplanations(@Nonnull
                                                   OWLAxiom axiom,
                                                   int maxExplanations)

Gets the explanations.

Parameters:

axiom - the axiom to explain

maxExplanations - max number of explanations

Returns:

the set of explanations