owlapi-version5/tools/src/main/java/com/clarkparsia/owlapi/explanation/util/DefinitionTracker.java
/* 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.util;

import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.contains;

import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLClassExpression;
import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.model.OWLOntologyChange;
import org.semanticweb.owlapi.model.OWLOntologyChangeListener;

/**
 * Tracker for definitions.
 */
public class DefinitionTracker implements OWLOntologyChangeListener {

    /**
     * Mapping from entities to the number of axioms.
     */
    private final Map<OWLEntity, AtomicInteger> referenceCounts = new HashMap<>();
    private final OWLOntology ontology;
    private final Set<OWLAxiom> axioms = new HashSet<>();

    /**
     * Instantiates a new definition tracker.
     *
     * @param ontology ontology to track
     */
    public DefinitionTracker(OWLOntology ontology) {
        this.ontology = checkNotNull(ontology, "ontology cannot be null");
        ontology.importsClosure().flatMap(OWLOntology::axioms).forEach(this::addAxiom);
        ontology.getOWLOntologyManager().addOntologyChangeListener(this);
    }

    private void addAxiom(OWLAxiom axiom) {
        if (axioms.add(axiom)) {
            axiom.signature()
                .forEach(e -> referenceCounts.computeIfAbsent(e, x -> new AtomicInteger(0))
                    .incrementAndGet());
        }
    }

    private void removeAxiom(OWLAxiom axiom) {
        if (axioms.remove(axiom)) {
            axiom.signature().forEach(e -> {
                AtomicInteger count = referenceCounts.get(e);
                if (count != null && count.decrementAndGet() == 0) {
                    referenceCounts.remove(e);
                }
            });
        }
    }

    /**
     * Checks if this entity is referred by a logical axiom in the imports
     * closure of the designated ontology.
     *
     * @param entity entity we are searching for
     * @return {@code true} if there is at least one logical axiom in the imports closure of the
     * given ontology that refers the given entity
     */
    public boolean isDefined(OWLEntity entity) {
        return checkNotNull(entity, "entity cannot be null").isBuiltIn() || referenceCounts
            .containsKey(entity);
    }

    /**
     * Checks if all the entities referred in the given concept are also
     * referred by a logical axiom in the imports closure of the designated
     * ontology.
     *
     * @param classExpression description that contains the entities we are searching for
     * @return {@code true} if all the entities in the given description are referred by at least
     * one logical axiom in the imports closure of the given ontology
     */
    public boolean isDefined(OWLClassExpression classExpression) {
        checkNotNull(classExpression, "classExpression cannot be null");
        return !classExpression.signature().anyMatch(e -> !isDefined(e));
    }

    @Override
    public void ontologiesChanged(List<? extends OWLOntologyChange> changes) {
        for (OWLOntologyChange change : changes) {
            if (!change.isAxiomChange() || !contains(ontology.importsClosure(),
                change.getOntology())) {
                continue;
            }
            OWLAxiom axiom = change.getAxiom();
            if (change.isAddAxiom()) {
                addAxiom(axiom);
            } else if (change.isRemoveAxiom()) {
                removeAxiom(axiom);
            } else {
                throw new UnsupportedOperationException("Unrecognized axiom change: " + change);
            }
        }
    }
}
