org.semanticweb.owlapi.debugging.JustificationMap Maven / Gradle / Ivy
/* This file is part of the OWL API.
* The contents of this file are subject to the LGPL License, Version 3.0.
* Copyright 2014, The University of Manchester
*
* 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 org.semanticweb.owlapi.debugging;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import javax.annotation.Nonnull;
import org.semanticweb.owlapi.model.OWLAsymmetricObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLClassAssertionAxiom;
import org.semanticweb.owlapi.model.OWLClassExpression;
import org.semanticweb.owlapi.model.OWLDataPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLDataPropertyDomainAxiom;
import org.semanticweb.owlapi.model.OWLDataPropertyRangeAxiom;
import org.semanticweb.owlapi.model.OWLDifferentIndividualsAxiom;
import org.semanticweb.owlapi.model.OWLDisjointClassesAxiom;
import org.semanticweb.owlapi.model.OWLDisjointDataPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLDisjointObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLDisjointUnionAxiom;
import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.OWLEquivalentClassesAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentDataPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLFunctionalDataPropertyAxiom;
import org.semanticweb.owlapi.model.OWLFunctionalObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLInverseFunctionalObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLInverseObjectPropertiesAxiom;
import org.semanticweb.owlapi.model.OWLIrreflexiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLNegativeDataPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLNegativeObjectPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLObject;
import org.semanticweb.owlapi.model.OWLObjectPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLObjectPropertyDomainAxiom;
import org.semanticweb.owlapi.model.OWLObjectPropertyRangeAxiom;
import org.semanticweb.owlapi.model.OWLReflexiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLSameIndividualAxiom;
import org.semanticweb.owlapi.model.OWLSubClassOfAxiom;
import org.semanticweb.owlapi.model.OWLSubDataPropertyOfAxiom;
import org.semanticweb.owlapi.model.OWLSubObjectPropertyOfAxiom;
import org.semanticweb.owlapi.model.OWLSubPropertyChainOfAxiom;
import org.semanticweb.owlapi.model.OWLSymmetricObjectPropertyAxiom;
import org.semanticweb.owlapi.model.OWLTransitiveObjectPropertyAxiom;
import org.semanticweb.owlapi.model.SWRLRule;
import org.semanticweb.owlapi.util.OWLAxiomVisitorAdapter;
import org.semanticweb.owlapi.util.OWLEntityCollector;
import com.google.common.collect.LinkedHashMultimap;
import com.google.common.collect.Multimap;
/**
* @author Matthew Horridge, The University Of Manchester, Bio-Health
* Informatics Group
* @since 2.0.0
*/
@SuppressWarnings("null")
public class JustificationMap {
@Nonnull
private final Set axioms;
@Nonnull
private final Set rootAxioms = new HashSet<>();
@Nonnull
private final Set usedAxioms = new HashSet<>();
@Nonnull
private final Multimap map = LinkedHashMultimap
.create();
@Nonnull
private final Multimap axiomsByRHS = LinkedHashMultimap
.create();
@Nonnull
private final Multimap axiomsByLHS = LinkedHashMultimap
.create();
@Nonnull
private final OWLClassExpression desc;
/**
* Instantiates a new justification map.
*
* @param desc
* the class expression
* @param axioms
* the axioms
*/
public JustificationMap(@Nonnull OWLClassExpression desc,
@Nonnull Set axioms) {
this.axioms = checkNotNull(axioms, "axioms cannot be null");
this.desc = checkNotNull(desc, "desc cannot be null");
createMap();
}
private void createMap() {
for (OWLAxiom ax : axioms) {
OWLAxiomPartExtractor extractor = new OWLAxiomPartExtractor();
ax.accept(extractor);
Set rhscollected = new HashSet<>();
OWLEntityCollector rhsCollector = new OWLEntityCollector(
rhscollected);
for (OWLObject rhsObject : extractor.getRHS()) {
rhsObject.accept(rhsCollector);
}
for (OWLEntity rhsEntity : rhscollected) {
axiomsByRHS.put(rhsEntity, ax);
}
Set lhscollected = new HashSet<>();
OWLEntityCollector lhsCollector = new OWLEntityCollector(
lhscollected);
for (OWLObject lhsObject : extractor.getLHS()) {
lhsObject.accept(lhsCollector);
}
for (OWLEntity lhsEntity : lhscollected) {
axiomsByLHS.put(lhsEntity, ax);
}
}
buildChildren(desc);
}
/**
* Gets the axioms by lhs.
*
* @param lhs
* the lhs
* @return the axioms by lhs
*/
@Nonnull
private Set getAxiomsByLHS(@Nonnull OWLEntity lhs) {
Set ts = new TreeSet<>(new OWLAxiomComparator());
ts.addAll(axiomsByLHS.get(lhs));
return ts;
}
private void buildChildren(@Nonnull OWLClassExpression seed) {
// Return the axioms that have the entity on the LHS
Set result = new HashSet<>();
for (OWLEntity ent : seed.getSignature()) {
assert ent != null;
Set axs = getAxiomsByLHS(ent);
for (OWLAxiom ax : axs) {
result.add(ax);
usedAxioms.add(ax);
}
}
rootAxioms.addAll(result);
buildChildren(result);
}
private void buildChildren(@Nonnull Set axiomSet) {
List> axiomChildren = new ArrayList<>();
for (OWLAxiom ax : axiomSet) {
assert ax != null;
Set children = build(ax);
for (OWLAxiom childAx : children) {
map.put(childAx, ax);
}
axiomChildren.add(children);
}
for (Set children : axiomChildren) {
assert children != null;
buildChildren(children);
}
}
/**
* Builds the.
*
* @param parentAxiom
* the parent axiom
* @return the sets the
*/
@Nonnull
private Set build(@Nonnull OWLAxiom parentAxiom) {
usedAxioms.add(parentAxiom);
OWLAxiomPartExtractor extractor = new OWLAxiomPartExtractor();
parentAxiom.accept(extractor);
Set result = new HashSet<>();
for (OWLObject obj : extractor.getRHS()) {
for (OWLEntity ent : obj.getSignature()) {
assert ent != null;
Set axs = getAxiomsByLHS(ent);
for (OWLAxiom ax : axs) {
if (!usedAxioms.contains(ax)) {
result.add(ax);
usedAxioms.add(ax);
}
}
}
}
return result;
}
/**
* Gets the root axioms.
*
* @return the root axioms
*/
@Nonnull
public Set getRootAxioms() {
return rootAxioms;
}
/**
* Gets the child axioms.
*
* @param ax
* the axiom whose children are to be retrieved
* @return children of ax
*/
@Nonnull
public Collection getChildAxioms(@Nonnull OWLAxiom ax) {
return map.get(ax);
}
/** The Class OWLAxiomPartExtractor. */
private static class OWLAxiomPartExtractor extends OWLAxiomVisitorAdapter {
@Nonnull
private final Set rhs = new HashSet<>();
@Nonnull
private final Set lhs = new HashSet<>();
/**
* Gets the rhs.
*
* @return the rhs
*/
@Nonnull
public Set getRHS() {
return rhs;
}
/**
* Gets the lhs.
*
* @return the lhs
*/
@Nonnull
public Set getLHS() {
return lhs;
}
/** Instantiates a new oWL axiom part extractor. */
OWLAxiomPartExtractor() {}
@Override
public void visit(OWLSubClassOfAxiom axiom) {
rhs.add(axiom.getSuperClass());
lhs.add(axiom.getSubClass());
}
@Override
public void visit(OWLNegativeObjectPropertyAssertionAxiom axiom) {
rhs.add(axiom.getObject());
rhs.add(axiom.getProperty());
lhs.add(axiom.getSubject());
}
@Override
public void visit(OWLAsymmetricObjectPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLReflexiveObjectPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLDisjointClassesAxiom axiom) {
rhs.addAll(axiom.getClassExpressions());
lhs.addAll(axiom.getClassExpressions());
}
@Override
public void visit(OWLDataPropertyDomainAxiom axiom) {
rhs.add(axiom.getDomain());
lhs.add(axiom.getProperty());
}
@Override
public void visit(OWLObjectPropertyDomainAxiom axiom) {
rhs.add(axiom.getDomain());
lhs.add(axiom.getProperty());
}
@Override
public void visit(OWLEquivalentObjectPropertiesAxiom axiom) {
rhs.addAll(axiom.getProperties());
lhs.addAll(axiom.getProperties());
}
@Override
public void visit(OWLNegativeDataPropertyAssertionAxiom axiom) {
rhs.add(axiom.getProperty());
rhs.add(axiom.getObject());
lhs.add(axiom.getSubject());
}
@Override
public void visit(OWLDifferentIndividualsAxiom axiom) {
rhs.addAll(axiom.getIndividuals());
lhs.addAll(axiom.getIndividuals());
}
@Override
public void visit(OWLDisjointDataPropertiesAxiom axiom) {
rhs.addAll(axiom.getProperties());
lhs.addAll(axiom.getProperties());
}
@Override
public void visit(OWLDisjointObjectPropertiesAxiom axiom) {
rhs.addAll(axiom.getProperties());
lhs.addAll(axiom.getProperties());
}
@Override
public void visit(OWLObjectPropertyRangeAxiom axiom) {
rhs.add(axiom.getRange());
lhs.add(axiom.getProperty());
}
@Override
public void visit(OWLObjectPropertyAssertionAxiom axiom) {
rhs.add(axiom.getProperty());
rhs.add(axiom.getObject());
lhs.add(axiom.getSubject());
}
@Override
public void visit(OWLFunctionalObjectPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLSubObjectPropertyOfAxiom axiom) {
rhs.add(axiom.getSuperProperty());
lhs.add(axiom.getSubProperty());
}
@Override
public void visit(OWLDisjointUnionAxiom axiom) {
rhs.addAll(axiom.getClassExpressions());
rhs.add(axiom.getOWLClass());
lhs.add(axiom.getOWLClass());
lhs.addAll(axiom.getClassExpressions());
}
@Override
public void visit(OWLSymmetricObjectPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLDataPropertyRangeAxiom axiom) {
rhs.add(axiom.getRange());
lhs.add(axiom.getProperty());
}
@Override
public void visit(OWLFunctionalDataPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLEquivalentDataPropertiesAxiom axiom) {
rhs.addAll(axiom.getProperties());
lhs.addAll(axiom.getProperties());
}
@Override
public void visit(OWLClassAssertionAxiom axiom) {
rhs.add(axiom.getClassExpression());
lhs.add(axiom.getIndividual());
}
@Override
public void visit(OWLEquivalentClassesAxiom axiom) {
rhs.addAll(axiom.getClassExpressions());
lhs.addAll(axiom.getClassExpressions());
}
@Override
public void visit(OWLDataPropertyAssertionAxiom axiom) {
rhs.add(axiom.getProperty());
lhs.add(axiom.getSubject());
}
@Override
public void visit(OWLTransitiveObjectPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLIrreflexiveObjectPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLSubDataPropertyOfAxiom axiom) {
rhs.add(axiom.getSuperProperty());
}
@Override
public void visit(OWLInverseFunctionalObjectPropertyAxiom axiom) {
rhs.add(axiom.getProperty());
}
@Override
public void visit(OWLSameIndividualAxiom axiom) {
rhs.addAll(axiom.getIndividuals());
lhs.addAll(axiom.getIndividuals());
}
@Override
public void visit(OWLSubPropertyChainOfAxiom axiom) {
rhs.add(axiom.getSuperProperty());
lhs.addAll(axiom.getPropertyChain());
}
@Override
public void visit(OWLInverseObjectPropertiesAxiom axiom) {
rhs.addAll(axiom.getProperties());
lhs.addAll(axiom.getProperties());
}
@Override
public void visit(SWRLRule rule) {}
}
/** The Class OWLAxiomComparator. */
private static class OWLAxiomComparator extends OWLAxiomVisitorAdapter
implements Comparator, Serializable {
private static final long serialVersionUID = 40000L;
private int result;
/** Instantiates a new oWL axiom comparator. */
OWLAxiomComparator() {}
@Override
public void visit(OWLSubClassOfAxiom axiom) {
result = 0;
}
@Override
public void visit(OWLEquivalentClassesAxiom axiom) {
result = 1;
}
@Override
public void visit(OWLDisjointClassesAxiom axiom) {
result = 2;
}
@Override
public int compare(OWLAxiom o1, OWLAxiom o2) {
result = 0;
o1.accept(this);
int result1 = result;
o2.accept(this);
int result2 = result;
int diff = result2 - result1;
if (diff != 0) {
return diff;
} else {
return -1;
}
}
}
}