owlapi-version5/tools/src/main/java/org/semanticweb/owlapitools/decomposition/OntologyAtom.java
package org.semanticweb.owlapitools.decomposition;

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 javax.annotation.Nullable;

/**
 * An ontology atom including module and dependencies information.
 */
public class OntologyAtom {

    static Comparator<OntologyAtom> comparator = (arg0, arg1) -> arg0.getId() - arg1.getId();
    /**
     * set of axioms in the atom
     */
    private final List<AxiomWrapper> axioms = new ArrayList<>();
    /**
     * set of axioms in the module (Atom's ideal)
     */
    private List<AxiomWrapper> module = new ArrayList<>();
    /**
     * set of atoms current one depends on
     */
    private final Set<OntologyAtom> dependencies = new HashSet<>();
    /**
     * set of all atoms current one depends on
     */
    private final Set<OntologyAtom> allDependencies = new HashSet<>();
    /**
     * unique atom's identifier
     */
    private int id = 0;

    /**
     * remove all atoms in AllDepAtoms from DepAtoms
     */
    public void filterDep() {
        dependencies.removeAll(allDependencies);
    }

    /**
     * build all dep atoms; filter them from DepAtoms
     *
     * @param checked sets of atoms to check
     */
    public void buildAllDepAtoms(Set<OntologyAtom> checked) {
        // first gather all dep atoms from all known dep atoms
        for (OntologyAtom p : dependencies) {
            Set<OntologyAtom> dep = p.getAllDepAtoms(checked);
            allDependencies.addAll(dep);
        }
        // now filter them out from known dep atoms
        filterDep();
        // add direct deps to all deps
        allDependencies.addAll(dependencies);
        // now the atom is checked
        checked.add(this);
    }

    // fill in the sets

    /**
     * @param ax axiom to add to the atom
     */
    public void addAxiom(AxiomWrapper ax) {
        axioms.add(ax);
        ax.setAtom(this);
    }

    /**
     * @param axs axioms to add to the atom
     */
    public void addAxioms(Collection<AxiomWrapper> axs) {
        axs.forEach(this::addAxiom);
    }

    /**
     * @param atom add atom to the dependency set
     */
    public void addDepAtom(@Nullable OntologyAtom atom) {
        if (atom != null && atom != this) {
            dependencies.add(atom);
        }
    }

    /**
     * get all the atoms the current one depends on; build this set if necessary
     *
     * @param checked atoms to check
     * @return all dependencies
     */
    public Set<OntologyAtom> getAllDepAtoms(Set<OntologyAtom> checked) {
        if (checked.contains(this)) {
            buildAllDepAtoms(checked);
        }
        return allDependencies;
    }

    /**
     * @return all the atom's axioms
     */
    public List<AxiomWrapper> getAtomAxioms() {
        return axioms;
    }

    // access to axioms

    /**
     * @return all the module axioms
     */
    public List<AxiomWrapper> getModule() {
        return module;
    }

    /**
     * set the module axioms
     *
     * @param module the module axioms
     */
    public void setModule(Collection<AxiomWrapper> module) {
        this.module = new ArrayList<>(module);
    }

    /**
     * @return atoms a given one depends on
     */
    public Set<OntologyAtom> getDependencies() {
        return dependencies;
    }

    /**
     * @return the value of the id
     */
    public int getId() {
        return id;
    }

    /**
     * @param id the id value
     */
    public void setId(int id) {
        this.id = id;
    }
}
