owlapi-version5/api/src/main/java/org/semanticweb/owlapi/util/ImportsStructureObjectSorter.java
/* 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.util;

import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.asList;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.asSet;

import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Stream;
import org.semanticweb.owlapi.model.OWLOntology;

/**
 * Sorts objects into sets based on where they appear in the imports closure of
 * an ontology. Consider ontology B that imports ontology A. A map will be
 * generated that maps each ontology, A, B, to a set of objects that are
 * associated with the ontology. If an object is associated with ontology A and
 * associated with ontology B then it will only appear in the set of objects
 * that are associated with ontology A since A appears higher up the imports
 * closure. An example of the use of this class is to obtain a map of ontologies
 * to sets of entities where each set of entities contains entities that are
 * first mentioned in the ontology that maps to them.
 *
 * @param <O> the type
 * @author Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group
 * @see org.semanticweb.owlapi.util.ImportsStructureEntitySorter
 * @since 2.2.0
 */
public class ImportsStructureObjectSorter<O> {

    private final OWLOntology ontology;
    private final ObjectSelector<O> objectSelector;

    /**
     * Creates a sorter for the specified ontology, whose imports closure is
     * obtained with the specified manager, and for each ontology whose objects
     * are selected using the specified object selector.
     *
     * @param ontology The ontology
     * @param objectSelector The selector that will be used to select objects that are associated
     * with each ontology.
     */
    public ImportsStructureObjectSorter(OWLOntology ontology, ObjectSelector<O> objectSelector) {
        this.ontology = checkNotNull(ontology, "ontology cannot be null");
        this.objectSelector = checkNotNull(objectSelector, "objectSelector cannot be null");
    }

    /**
     * Gets a map that maps ontologies to sets of associated objects. The
     * ontologies will be the ontologies that are contained in the imports
     * closure of the original specified ontology.
     *
     * @return The map.
     */
    public Map<OWLOntology, Set<O>> getObjects() {
        List<OWLOntology> imports = asList(ontology.importsClosure());
        Collections.reverse(imports);
        Map<OWLOntology, Set<O>> ontology2EntityMap = new HashMap<>();
        Set<O> processed = new HashSet<>();
        imports.forEach(ont -> ontology2EntityMap
            .put(ont, asSet(objectSelector.objects(ont).filter(processed::add))));
        return ontology2EntityMap;
    }

    /**
     * @param <O> type of selected objects
     */
    @FunctionalInterface
    public interface ObjectSelector<O> {

        /**
         * @param ontology the ontology to explore
         * @return set of objects selected
         */
        Stream<O> objects(OWLOntology ontology);
    }
}
