Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/* This file is part of the OWL API.
* The contents of this file are subject to the LGPL License, Version 3.0.
* Copyright 2011, Clark & Parsia, LLC
*
* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
* You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
*
* Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */
package com.clarkparsia.owlapi.explanation;
import static org.semanticweb.owlapi.model.parameters.Imports.EXCLUDED;
import static org.semanticweb.owlapi.model.parameters.Imports.INCLUDED;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.verifyNotNull;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import javax.annotation.Nonnull;
import org.semanticweb.owlapi.model.AddAxiom;
import org.semanticweb.owlapi.model.OWLAnnotationAxiom;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLAxiomVisitor;
import org.semanticweb.owlapi.model.OWLClass;
import org.semanticweb.owlapi.model.OWLClassExpression;
import org.semanticweb.owlapi.model.OWLDataProperty;
import org.semanticweb.owlapi.model.OWLDeclarationAxiom;
import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.OWLException;
import org.semanticweb.owlapi.model.OWLIndividual;
import org.semanticweb.owlapi.model.OWLObjectProperty;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.model.OWLOntologyManager;
import org.semanticweb.owlapi.model.OWLRuntimeException;
import org.semanticweb.owlapi.model.OWLSubClassOfAxiom;
import org.semanticweb.owlapi.reasoner.OWLReasoner;
import org.semanticweb.owlapi.reasoner.OWLReasonerFactory;
import org.semanticweb.owlapi.util.CollectionFactory;
import org.semanticweb.owlapi.util.OWLAxiomVisitorAdapter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.clarkparsia.owlapi.explanation.util.OntologyUtils;
/** A black box explanation. */
public class BlackBoxExplanation extends SingleExplanationGeneratorImpl
implements SingleExplanationGenerator {
private static final Logger LOGGER =
LoggerFactory.getLogger(BlackBoxExplanation.class.getName());
/** The debugging ontology. */
private OWLOntology debuggingOntology;
/** The debugging axioms. */
@Nonnull
protected final Set debuggingAxioms = new LinkedHashSet<>();
/** The objects expanded with defining axioms. */
@Nonnull
private final Set objectsExpandedWithDefiningAxioms = new HashSet<>();
/** The objects expanded with referencing axioms. */
@Nonnull
private final Set objectsExpandedWithReferencingAxioms = new HashSet<>();
/** The expanded with defining axioms. */
@Nonnull
private final Set expandedWithDefiningAxioms = new HashSet<>();
/** The expanded with referencing axioms. */
@Nonnull
private final Set expandedWithReferencingAxioms = new HashSet<>();
/** default expansion limit. */
public static final int DEFAULT_INITIAL_EXPANSION_LIMIT = 50;
/** The initial expansion limit. */
private final int initialExpansionLimit = DEFAULT_INITIAL_EXPANSION_LIMIT;
/** The expansion limit. */
private int expansionLimit = initialExpansionLimit;
/** The Constant DEFAULT_FAST_PRUNING_WINDOW_SIZE. */
private static final int DEFAULT_FAST_PRUNING_WINDOW_SIZE = 10;
/** The fast pruning window size. */
private int fastPruningWindowSize = 0;
/** The owl ontology manager. */
private final OWLOntologyManager owlOntologyManager;
// Creation of debugging ontology and satisfiability testing
private int satTestCount = 0;
/**
* Instantiates a new black box explanation.
*
* @param ontology the ontology
* @param reasonerFactory the reasoner factory
* @param reasoner the reasoner
*/
public BlackBoxExplanation(@Nonnull OWLOntology ontology,
@Nonnull OWLReasonerFactory reasonerFactory, @Nonnull OWLReasoner reasoner) {
this(ontology, reasonerFactory, reasoner,
Math.max(ontology.getLogicalAxiomCount() / 100, DEFAULT_FAST_PRUNING_WINDOW_SIZE));
}
/**
* Instantiates a new black box explanation.
*
* @param ontology the ontology
* @param reasonerFactory the reasoner factory
* @param reasoner the reasoner
* @param fastPruningWindowSize the window size for fast pruning (default to 1% of axioms, or 10
* - whichever is larger)
*/
public BlackBoxExplanation(OWLOntology ontology, OWLReasonerFactory reasonerFactory,
OWLReasoner reasoner, int fastPruningWindowSize) {
super(ontology, reasonerFactory, reasoner);
owlOntologyManager = ontology.getOWLOntologyManager();
this.fastPruningWindowSize = fastPruningWindowSize;
}
@Override
public void dispose() {
reset();
getReasoner().dispose();
}
private void reset() {
if (debuggingOntology != null) {
owlOntologyManager.removeOntology(verifyNotNull(debuggingOntology));
debuggingOntology = null;
}
debuggingAxioms.clear();
objectsExpandedWithDefiningAxioms.clear();
objectsExpandedWithReferencingAxioms.clear();
expandedWithDefiningAxioms.clear();
expandedWithReferencingAxioms.clear();
expansionLimit = initialExpansionLimit;
}
@Override
public Set getExplanation(OWLClassExpression unsatClass) {
if (!getDefinitionTracker().isDefined(unsatClass)) {
return CollectionFactory.emptySet();
}
try {
satTestCount++;
if (isFirstExplanation() && getReasoner().isSatisfiable(unsatClass)) {
return CollectionFactory.emptySet();
}
reset();
expandUntilUnsatisfiable(unsatClass);
pruneUntilMinimal(unsatClass);
removeDeclarations();
return new HashSet<>(debuggingAxioms);
} catch (OWLException e) {
throw new OWLRuntimeException(e);
}
}
// Expansion
private int expandAxioms() {
/*
* We expand the axiom set using axioms that define entities that are already referenced in
* the existing set of axioms. If this fails to expand the axiom set we expand using axioms
* that reference the entities in the axioms that have already been expanded.
*/
// Keep track of the number of axioms that have been added
int axiomsAdded = 0;
int remainingSpace = expansionLimit;
/* The expansion factor. */
double expansionFactor = 1.25;
for (OWLAxiom ax : new ArrayList<>(debuggingAxioms)) {
if (expandedWithDefiningAxioms.contains(ax)) {
// Skip if already done
continue;
}
// Collect the entities that have been used in the axiom
for (OWLEntity curObj : ax.getSignature()) {
assert curObj != null;
if (!objectsExpandedWithDefiningAxioms.contains(curObj)) {
int added = expandWithDefiningAxioms(curObj, remainingSpace);
axiomsAdded += added;
remainingSpace -= added;
if (remainingSpace == 0) {
expansionLimit *= expansionFactor;
return axiomsAdded;
}
// Flag that we have completely expanded all defining axioms
// for this particular entity
objectsExpandedWithDefiningAxioms.add(curObj);
}
}
// Flag that we've completely expanded this particular axiom
expandedWithDefiningAxioms.add(ax);
}
if (axiomsAdded > 0) {
return axiomsAdded;
}
// No axioms added at this point. Start adding axioms that reference
// entities contained in the current set of debugging axioms
for (OWLAxiom ax : new ArrayList<>(debuggingAxioms)) {
if (expandedWithReferencingAxioms.contains(ax)) {
// Skip - already done this one
continue;
}
// Keep track of the number of axioms that have been added
for (OWLEntity curObj : ax.getSignature()) {
assert curObj != null;
if (!objectsExpandedWithReferencingAxioms.contains(curObj)) {
int added = expandWithReferencingAxioms(curObj, expansionLimit);
axiomsAdded += added;
remainingSpace -= added;
if (remainingSpace == 0) {
expansionLimit *= expansionFactor;
return axiomsAdded;
}
objectsExpandedWithReferencingAxioms.add(curObj);
}
}
expandedWithReferencingAxioms.add(ax);
}
return axiomsAdded;
}
/**
* Creates a set of axioms to expands the debugging axiom set by adding the defining axioms for
* the specified entity.
*
* @param obj the obj
* @param limit the limit
* @return the int
*/
private int expandWithDefiningAxioms(@Nonnull OWLEntity obj, int limit) {
Set expansionAxioms = new HashSet<>();
for (OWLOntology ont : getOntology().getImportsClosure()) {
boolean referenceFound = false;
if (obj instanceof OWLClass) {
referenceFound = expansionAxioms.addAll(ont.getAxioms((OWLClass) obj, EXCLUDED));
} else if (obj instanceof OWLObjectProperty) {
referenceFound =
expansionAxioms.addAll(ont.getAxioms((OWLObjectProperty) obj, EXCLUDED));
} else if (obj instanceof OWLDataProperty) {
referenceFound =
expansionAxioms.addAll(ont.getAxioms((OWLDataProperty) obj, EXCLUDED));
} else if (obj instanceof OWLIndividual) {
referenceFound =
expansionAxioms.addAll(ont.getAxioms((OWLIndividual) obj, EXCLUDED));
}
if (!referenceFound) {
expansionAxioms
.add(owlOntologyManager.getOWLDataFactory().getOWLDeclarationAxiom(obj));
}
}
expansionAxioms.removeAll(debuggingAxioms);
return addMax(expansionAxioms, debuggingAxioms, limit);
}
/**
* Expands the axiom set by adding the referencing axioms for the specified entity.
*
* @param obj the obj
* @param limit the limit
* @return the int
*/
private int expandWithReferencingAxioms(@Nonnull OWLEntity obj, int limit) {
Set expansionAxioms = new HashSet<>();
// First expand by getting the defining axioms - if this doesn't
// return any axioms, then get the axioms that reference the entity
expansionAxioms.addAll(getOntology().getReferencingAxioms(obj, INCLUDED));
expansionAxioms.removeAll(debuggingAxioms);
return addMax(expansionAxioms, debuggingAxioms, limit);
}
/**
* A utility method. Adds axioms from one set to another set up to a specified limit. Annotation
* axioms are stripped out
*
* @param the number type
* @param source The source set. Objects from this set will be added to the destination set
* @param dest The destination set. Objects will be added to this set
* @param limit The maximum number of objects to be added.
* @return The number of objects that were actually added.
*/
private static int addMax(@Nonnull Set source, @Nonnull Set dest,
int limit) {
int count = 0;
for (N obj : source) {
if (count == limit) {
break;
}
if (!(obj instanceof OWLAnnotationAxiom) && dest.add(obj)) {
count++;
}
}
return count;
}
// Contraction/Pruning - Fast pruning is performed and then slow pruning is
// performed.
private void performFastPruning(@Nonnull OWLClassExpression unsatClass) throws OWLException {
Set axiomWindow = new HashSet<>();
Object[] axioms = debuggingAxioms.toArray();
LOGGER.info("Fast pruning: ");
LOGGER.info(" - Window size: {}", Integer.valueOf(fastPruningWindowSize));
int windowCount = debuggingAxioms.size() / fastPruningWindowSize;
for (int currentWindow = 0; currentWindow < windowCount; currentWindow++) {
axiomWindow.clear();
int startIndex = currentWindow * fastPruningWindowSize;
int endIndex = startIndex + fastPruningWindowSize;
for (int axiomIndex = startIndex; axiomIndex < endIndex; axiomIndex++) {
OWLAxiom currentAxiom = (OWLAxiom) axioms[axiomIndex];
axiomWindow.add(currentAxiom);
debuggingAxioms.remove(currentAxiom);
}
if (isSatisfiable(unsatClass)) {
debuggingAxioms.addAll(axiomWindow);
}
}
// Add any left over axioms
axiomWindow.clear();
int remainingAxiomsCount = debuggingAxioms.size() % fastPruningWindowSize;
if (remainingAxiomsCount > 0) {
int fragmentIndex = windowCount * fastPruningWindowSize;
while (fragmentIndex < axioms.length) {
OWLAxiom curAxiom = (OWLAxiom) axioms[fragmentIndex];
axiomWindow.add(curAxiom);
debuggingAxioms.remove(curAxiom);
fragmentIndex++;
}
if (isSatisfiable(unsatClass)) {
debuggingAxioms.addAll(axiomWindow);
}
}
LOGGER.info(" - End of fast pruning");
}
private void performSlowPruning(@Nonnull OWLClassExpression unsatClass) throws OWLException {
// Simply remove axioms one at a time. If the class
// being debugged turns satisfiable then we know we have
// an SOS axiom.
List axiomsCopy = new ArrayList<>(debuggingAxioms);
for (OWLAxiom ax : axiomsCopy) {
debuggingAxioms.remove(ax);
if (isSatisfiable(unsatClass)) {
// Affects satisfiability, so add back in
debuggingAxioms.add(ax);
}
}
}
/**
* Tests the satisfiability of the test class. The ontology is recreated before the test is
* performed.
*
* @param unsatClass the unsatisfiable class
* @return true, if is satisfiable
* @throws OWLException any exception
*/
private boolean isSatisfiable(@Nonnull OWLClassExpression unsatClass) throws OWLException {
try {
createDebuggingOntology();
OWLReasoner reasoner =
getReasonerFactory().createNonBufferingReasoner(verifyNotNull(debuggingOntology));
if (OntologyUtils.containsUnreferencedEntity(verifyNotNull(debuggingOntology),
unsatClass)) {
reasoner.dispose();
return true;
}
satTestCount++;
boolean sat = reasoner.isSatisfiable(unsatClass);
reasoner.dispose();
return sat;
} catch (IllegalArgumentException e) {
LOGGER.warn(
"Illegal argument found - satisfiability cannot be checked for {} because of {}",
unsatClass, e);
return false;
}
}
private void createDebuggingOntology() throws OWLException {
if (debuggingOntology != null) {
owlOntologyManager.removeOntology(verifyNotNull(debuggingOntology));
}
debuggingOntology = owlOntologyManager.createOntology();
List changes = new ArrayList<>();
for (OWLAxiom ax : new ArrayList<>(debuggingAxioms)) {
changes.add(new AddAxiom(verifyNotNull(debuggingOntology), verifyNotNull(ax)));
}
owlOntologyManager.applyChanges(changes);
}
private void resetSatisfiabilityTestCounter() {
satTestCount = 0;
}
private void expandUntilUnsatisfiable(@Nonnull OWLClassExpression unsatClass)
throws OWLException {
// Perform the initial expansion - this will cause
// the debugging axioms set to be expanded to the
// defining axioms for the class being debugged
resetSatisfiabilityTestCounter();
if (!unsatClass.isAnonymous()) {
expandWithDefiningAxioms((OWLClass) unsatClass, expansionLimit);
} else {
OWLClass owlThing = owlOntologyManager.getOWLDataFactory().getOWLThing();
OWLSubClassOfAxiom axiom =
owlOntologyManager.getOWLDataFactory().getOWLSubClassOfAxiom(unsatClass, owlThing);
debuggingAxioms.add(axiom);
expandAxioms();
debuggingAxioms.remove(axiom);
}
LOGGER.info("Initial axiom count: {}", Integer.valueOf(debuggingAxioms.size()));
int totalAdded = 0;
int expansionCount = 0;
while (isSatisfiable(unsatClass)) {
LOGGER.info("Expanding axioms (expansion {})", Integer.valueOf(expansionCount));
expansionCount++;
int numberAdded = expandAxioms();
totalAdded += numberAdded;
LOGGER.info(" ... expanded by {}", Integer.valueOf(numberAdded));
if (numberAdded == 0) {
LOGGER.info("ERROR! Cannot find SOS axioms!");
debuggingAxioms.clear();
return;
}
}
LOGGER.info("Total number of axioms added: {}", Integer.valueOf(totalAdded));
}
/**
* Prune until minimal.
*
* @param unsatClass the unsatisfiable class
* @throws OWLException any exception
*/
protected void pruneUntilMinimal(@Nonnull OWLClassExpression unsatClass) throws OWLException {
LOGGER.info("FOUND CLASH! Pruning {} axioms...", Integer.valueOf(debuggingAxioms.size()));
resetSatisfiabilityTestCounter();
LOGGER.info("Fast pruning...");
fastPruningWindowSize = DEFAULT_FAST_PRUNING_WINDOW_SIZE;
performFastPruning(unsatClass);
LOGGER.info("... end of fast pruning. Axioms remaining: {}",
Integer.valueOf(debuggingAxioms.size()));
LOGGER.info("Performed {} satisfiability tests during fast pruning",
Integer.valueOf(satTestCount));
int totalSatTests = satTestCount;
resetSatisfiabilityTestCounter();
LOGGER.info("Slow pruning...");
performSlowPruning(unsatClass);
LOGGER.info("... end of slow pruning");
LOGGER.info("Performed {} satisfiability tests during slow pruning",
Integer.valueOf(satTestCount));
totalSatTests += satTestCount;
LOGGER.info("Total number of satisfiability tests performed: {}",
Integer.valueOf(totalSatTests));
}
private void removeDeclarations() {
OWLAxiomVisitor declarationRemover = new OWLAxiomVisitorAdapter() {
@Override
public void visit(OWLDeclarationAxiom axiom) {
checkNotNull(axiom, "axiom cannot be null");
debuggingAxioms.remove(axiom);
}
};
for (OWLAxiom axiom : new ArrayList<>(debuggingAxioms)) {
axiom.accept(declarationRemover);
}
}
@Override
public String toString() {
return "BlackBox";
}
}
