owlapi-version5/api/src/main/java/org/semanticweb/owlapi/model/OWLNaryAxiom.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.model;

import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.allPairs;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.asList;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.minimalPairs;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.pairs;

import java.util.Collection;
import java.util.Objects;
import java.util.stream.Stream;

/**
 * Represents an axiom that contains two or more operands that could also be represented with
 * multiple pairwise axioms.
 *
 * @param <C> class of contained objects
 * @author Matthew Horridge, The University of Manchester, Information Management Group
 * @since 3.0.0
 */
public interface OWLNaryAxiom<C extends OWLObject> extends OWLAxiom, HasOperands<C> {

    /**
     * @return a stream of all operands for this n-ary axiom. This provides a platform for common
     *         operations across different types, e.g., this will be the properties() stream for a
     *         DisjointObjectProperties, or a classExpressions() stream for a DisjointClasses.
     */
    @Override
    Stream<C> operands();

    /**
     * Gets this axiom as a set of pairwise axioms; if the axiom contains only two operands, the
     * axiom itself is returned unchanged, including its annotations. Note that, aside from this
     * exception, annotations on this axiom will not be copied to each axiom returned in the set of
     * pairwise axioms.<br>
     * Note: This will contain all pairs, i.e., for the set "a, b, c" the pairs "a, b", "a, c", "b,
     * c" will be returned. For some applications, only "a, b", "b, c" are required.
     *
     * @return This axiom as a set of pairwise axioms.
     */
    Collection<? extends OWLNaryAxiom<C>> asPairwiseAxioms();

    /**
     * @param <T> type returned by visitor
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are not
     *        ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.
     * @return collection of all visitor return values that are not null
     */
    default <T> Collection<T> walkPairwise(OWLPairwiseVisitor<T, C> visitor) {
        return asList(
            minimalPairs(operands()).map(v -> visitor.visit(v.i, v.j)).filter(Objects::nonNull));
    }

    /**
     * @param <T> type returned by visitor
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are ordered,
     *        i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.
     * @return collection of all visitor return values that are not null
     */
    default <T> Collection<T> walkAllPairwise(OWLPairwiseVisitor<T, C> visitor) {
        return asList(
            allPairs(operands()).map(v -> visitor.visit(v.i, v.j)).filter(Objects::nonNull));
    }

    /**
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are not
     *        ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.
     */
    default void forEach(OWLPairwiseVoidVisitor<C> visitor) {
        pairs(operands()).forEach(v -> visitor.visit(v.i, v.j));
    }

    /**
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are not
     *        ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.
     * @return true if at least one pair evaluation is true
     */
    default boolean anyMatch(OWLPairwiseBooleanVisitor<C> visitor) {
        return pairs(operands()).anyMatch(v -> visitor.visit(v.i, v.j));
    }

    /**
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are not
     *        ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.
     * @return true if all pairs evaluation is true
     */
    default boolean allMatch(OWLPairwiseBooleanVisitor<C> visitor) {
        return pairs(operands()).allMatch(v -> visitor.visit(v.i, v.j));
    }

    /**
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are ordered,
     *        i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.
     */
    default void forEachAllPairs(OWLPairwiseVoidVisitor<C> visitor) {
        allPairs(operands()).forEach(v -> visitor.visit(v.i, v.j));
    }

    /**
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are ordered,
     *        i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.
     * @return true if at least one pair evaluation is true
     */
    default boolean anyMatchAllPairs(OWLPairwiseBooleanVisitor<C> visitor) {
        return allPairs(operands()).anyMatch(v -> visitor.visit(v.i, v.j));
    }

    /**
     * @param visitor visitor to apply to all pairwise elements in this axiom; pairs are ordered,
     *        i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.
     * @return true if all pairs evaluation is true
     */
    default boolean allMatchAllPairs(OWLPairwiseBooleanVisitor<C> visitor) {
        return allPairs(operands()).allMatch(v -> visitor.visit(v.i, v.j));
    }

    /**
     * Splits this axiom to pairs, including annotations. This method implements the process
     * described at http://www.w3.org/TR/owl2-mapping-to-rdf/#
     * Axioms_that_are_Translated_to_Multiple_Triples which is used, for example, in serializing
     * EquivalentProperty axioms with three operands. Note that annotations on this axiom will be
     * copied to each axiom returned in the set of pairwise axioms. Note: This will contain only the
     * "An, An+1" pairs, i.e., for the set "a, b, c" the pairs "a, b" and "b, c" will be returned,
     * but not "a, c".
     *
     * @return This axiom as a set of pairwise axioms, annotations included.
     */
    Collection<? extends OWLAxiom> splitToAnnotatedPairs();
}
