org.semanticweb.owl.explanation.api

Class Explanation<E>

java.lang.Object

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

public class Explanation<E>
extends Object

Author: Matthew Horridge
The University Of Manchester
Information Management Group
Date: 03-Sep-2008

Represents an explanation for an entailment. The explanation consists of a minimal set of axioms (a justification) that is sufficient to support the entailment. The set is minimal in the sense that any proper subset is not sufficient for the entailment to hold. The type of object that represents the entailment is not specified. Typically the entailment is an checker, but the entailment could also be another object such as a property that is entailed to be non-simple or transitive, or a set of ontologies that are entailed to be inconsistent for example.

Field Summary

Fields

Modifier and Type	Field and Description
static org.semanticweb.owlapi.model.IRI	ENTAILMENT_MARKER_IRI

Constructor Summary

Constructors

Constructor and Description
Explanation(E entailment, Set<org.semanticweb.owlapi.model.OWLAxiom> justification)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(org.semanticweb.owlapi.model.OWLAxiom axiom) Determines whether this explanation contains a specific checker
boolean	equals(Object obj)
Set<org.semanticweb.owlapi.model.OWLAxiom>	getAxioms() Gets the axioms (justification) that constitute this explanation.
static <E> Explanation<E>	getEmptyExplanation(E entailment)
E	getEntailment() Gets the entailment that the explanation is for
Set<org.semanticweb.owlapi.model.OWLClassExpression>	getNestedClassExpressions() Gets the sub-concepts that appear in the axioms in this explanation
int	getSize() Gets the size of this explanation
int	hashCode()
boolean	isEmpty() Determines if this explanation is empty i.e.
boolean	isJustificationEntailment() Determines if the justification for the entailment is the entailment itself
static Explanation<org.semanticweb.owlapi.model.OWLAxiom>	load(InputStream is) Loads a previously stored explanation from the specified input stream
static void	store(Explanation<org.semanticweb.owlapi.model.OWLAxiom> explanation, OutputStream os) Stores the specified explanation to the specified output stream
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ENTAILMENT_MARKER_IRI

public static final org.semanticweb.owlapi.model.IRI ENTAILMENT_MARKER_IRI

Constructor Detail

Explanation

public Explanation(E entailment,
           Set<org.semanticweb.owlapi.model.OWLAxiom> justification)

Method Detail

getEntailment

public E getEntailment()

Gets the entailment that the explanation is for

Returns:

The entailment

getAxioms

public Set<org.semanticweb.owlapi.model.OWLAxiom> getAxioms()

Gets the axioms (justification) that constitute this explanation.

Returns:

A set containing the axioms.

getSize

public int getSize()

Gets the size of this explanation

Returns:

The size which corresponds to the number of axioms in the justification (the entailment is not counted).

isEmpty

public boolean isEmpty()

Determines if this explanation is empty i.e. there are no axioms that entail the entailment

Returns:

true if the explanation is empty or false if the explanation is not empty.

contains

public boolean contains(org.semanticweb.owlapi.model.OWLAxiom axiom)

Determines whether this explanation contains a specific checker

Parameters:

axiom - The checker

Returns:

true if the explanation contains a specific checker otherwise false

isJustificationEntailment

public boolean isJustificationEntailment()

Determines if the justification for the entailment is the entailment itself

Returns:

true if the justification for the entailment is the entailment, otherwise false

getNestedClassExpressions

public Set<org.semanticweb.owlapi.model.OWLClassExpression> getNestedClassExpressions()

Gets the sub-concepts that appear in the axioms in this explanation

Returns:

A set of sub-concepts that appear in the axioms in this explanation

getEmptyExplanation

public static <E> Explanation<E> getEmptyExplanation(E entailment)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

store

public static void store(Explanation<org.semanticweb.owlapi.model.OWLAxiom> explanation,
         OutputStream os)
                  throws IOException

Stores the specified explanation to the specified output stream

Parameters:

explanation - The explanation to be stored

os - The output stream to store the explanation to

Throws:

IOException - if there was a problem writing out the explanation

load

public static Explanation<org.semanticweb.owlapi.model.OWLAxiom> load(InputStream is)
                                                               throws IOException

Loads a previously stored explanation from the specified input stream

Parameters:

is - The input stream from where to read the explanation

Returns:

The explanation that was read

Throws:

IOException - if there was a problem reading the explanation

IllegalStateException - if the input stream does not appear to contain a serialisation of an explanation.