org.protege.editor.owl.model.util.ClassDefinitionExtractor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of protege-editor-owl

OWL ontology editing infrastructure used by the Protege desktop application.

There is a newer version: 5.6.4-beta3

package org.protege.editor.owl.model.util;

import org.semanticweb.owlapi.model.*;

import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Matthew Horridge
 * Stanford Center for Biomedical Informatics Research
 * 23 Aug 2017
 */
public class ClassDefinitionExtractor {

    @Nonnull
    private final OWLClass cls;

    @Nonnull
    private final OWLDataFactory dataFactory;

    @Nonnull
    private final OWLOntology ontology;

    public ClassDefinitionExtractor(@Nonnull OWLClass cls,
                                    @Nonnull OWLOntology ontology,
                                    @Nonnull OWLDataFactory dataFactory) {
        this.cls = checkNotNull(cls);
        this.dataFactory = checkNotNull(dataFactory);
        this.ontology = checkNotNull(ontology);
    }

    /**
     * Gets a list of changes that are necessary to remove the axioms that constitute the logical definition
     * of the target class.
     * @return A list of changes.
     */
    @Nonnull
    public List getChangesToRemoveDefinition() {
        List changes = new ArrayList<>();
        generateChangesToRemoveDefinitionFromOntology(ontology, changes);
        return changes;
    }

    @Nonnull
    public Set getDefiningAxioms() {
        Set result = new HashSet<>();
        result.addAll(ontology.getSubClassAxiomsForSubClass(cls));
        result.addAll(ontology.getEquivalentClassesAxioms(cls));
        result.addAll(ontology.getDisjointClassesAxioms(cls));
        result.addAll(ontology.getHasKeyAxioms(cls));
        result.addAll(ontology.getDisjointUnionAxioms(cls));
        return result;
    }

    private void generateChangesToRemoveDefinitionFromOntology(@Nonnull OWLOntology o,
                                                               @Nonnull List changes) {
        o.getSubClassAxiomsForSubClass(cls).forEach(ax -> changes.add(new RemoveAxiom(o, ax)));
        o.getEquivalentClassesAxioms(cls).forEach(ax -> changes.add(new RemoveAxiom(o, ax)));
        o.getDisjointClassesAxioms(cls).forEach(ax -> {
            changes.add(new RemoveAxiom(o, ax));
            Set remainingDisjointClasses = ax.getClassExpressionsMinus(cls);
            if(remainingDisjointClasses.size() > 1) {
                OWLAxiom freshAx = dataFactory.getOWLDisjointClassesAxiom(remainingDisjointClasses,
                                                                          ax.getAnnotations());
                changes.add(new AddAxiom(o, freshAx));
            }
        });
        o.getHasKeyAxioms(cls).forEach(ax -> new RemoveAxiom(o, ax));
        o.getDisjointUnionAxioms(cls).forEach(ax -> new RemoveAxiom(o, ax));
    }
}