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

import java.util.Set;
import java.util.stream.Stream;

import org.semanticweb.owlapi.model.parameters.Imports;

/**
 * Ontology methods related to its signature.
 *
 * @author ignazio
 * @since 4.0.0
 */
public interface OWLSignature
    extends HasGetEntitiesInSignature, HasClassesInSignature, HasAnnotationPropertiesInSignature,
    HasObjectPropertiesInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature,
    HasIndividualsInSignature, HasContainsEntityInSignature, HasImportsClosure {

    /**
     * Gets the classes in the signature and optionally the imports closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return the set of classes in the signature, optionally including the import closure. The set
     *         that is returned is a copy; modifications to the returned set will not be reflected
     *         in this object.
     */
    default Set<OWLClass> getClassesInSignature(Imports imports) {
        return asSet(classesInSignature(imports));
    }

    /**
     * Gets the classes in the signature and optionally the imports closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return the stream of classes in the signature, optionally including the import closure.
     */
    default Stream<OWLClass> classesInSignature(Imports imports) {
        return imports.stream(this).flatMap(OWLOntology::classesInSignature).distinct().sorted();
    }

    /**
     * Gets the object properties in the signature and optionally the imports closure.
     *
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return the set of object properties in the signature, optionally including the import
     *         closure. The set that is returned is a copy; modifications to the returned set will
     *         not be reflected in this object.
     */
    default Set<OWLObjectProperty> getObjectPropertiesInSignature(Imports includeImportsClosure) {
        return asSet(objectPropertiesInSignature(includeImportsClosure));
    }

    /**
     * Gets the object properties in the signature and optionally the imports closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return the stream of object properties in the signature, optionally including the import
     *         closure.
     */
    default Stream<OWLObjectProperty> objectPropertiesInSignature(Imports imports) {
        return imports.stream(this).flatMap(OWLOntology::objectPropertiesInSignature).distinct()
            .sorted();
    }

    /**
     * Gets the data properties in the signature and optionally the imports closure.
     *
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return the set of data properties in the signature, optionally including the import closure.
     *         The set that is returned is a copy; modifications to the returned set will not be
     *         reflected in this object.
     */
    default Set<OWLDataProperty> getDataPropertiesInSignature(Imports includeImportsClosure) {
        return asSet(dataPropertiesInSignature(includeImportsClosure));
    }

    /**
     * Gets the data properties in the signature and optionally the imports closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return the stream of data properties in the signature, optionally including the import
     *         closure.
     */
    default Stream<OWLDataProperty> dataPropertiesInSignature(Imports imports) {
        return imports.stream(this).flatMap(OWLOntology::dataPropertiesInSignature).distinct()
            .sorted();
    }

    /**
     * Gets the named individuals in the signature and optionally the imports closure.
     *
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return the set of individuals in the signature, optionally including the import closure. The
     *         set that is returned is a copy; modifications to the returned set will not be
     *         reflected in this object.
     */
    default Set<OWLNamedIndividual> getIndividualsInSignature(Imports includeImportsClosure) {
        return asSet(individualsInSignature(includeImportsClosure));
    }

    /**
     * Gets the named individuals in the signature and optionally the imports closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return the stream of individuals in the signature, optionally including the import closure.
     */
    default Stream<OWLNamedIndividual> individualsInSignature(Imports imports) {
        return imports.stream(this).flatMap(OWLOntology::individualsInSignature).distinct()
            .sorted();
    }

    /**
     * Gets the referenced anonymous individuals in the signature and optionally the imports
     * closure.
     *
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return The set of referenced anonymous individuals. The set that is returned is a copy;
     *         modifications to the returned set will not be reflected in this object.
     */
    default Set<OWLAnonymousIndividual> getReferencedAnonymousIndividuals(
        Imports includeImportsClosure) {
        return asSet(referencedAnonymousIndividuals(includeImportsClosure));
    }

    /**
     * Gets the referenced anonymous individuals in the signature and optionally the imports
     * closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return The stream of referenced anonymous individuals
     */
    default Stream<OWLAnonymousIndividual> referencedAnonymousIndividuals(Imports imports) {
        return imports.stream(this).flatMap(OWLOntology::referencedAnonymousIndividuals).distinct()
            .sorted();
    }

    /**
     * Gets the referenced anonymous individuals.
     *
     * @return The set of referenced anonymous individuals. The set that is returned is a copy;
     *         modifications to the returned set will not be reflected in this object.
     */
    default Set<OWLAnonymousIndividual> getReferencedAnonymousIndividuals() {
        return asSet(referencedAnonymousIndividuals());
    }

    /**
     * Gets the referenced anonymous individuals.
     *
     * @return Sorted stream of referenced anonymous individuals
     */
    Stream<OWLAnonymousIndividual> referencedAnonymousIndividuals();

    /**
     * Gets the datatypes in the signature and optionally the imports closure.
     *
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return the set of datatypes in the signature of this ontology, optionally including the
     *         import closure. The set that is returned is a copy; modifications to the returned set
     *         will not be reflected in this object.
     */
    default Set<OWLDatatype> getDatatypesInSignature(Imports includeImportsClosure) {
        return asSet(datatypesInSignature(includeImportsClosure));
    }

    /**
     * Gets the datatypes in the signature and optionally the imports closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return the stream of datatypes in the signature of this ontology, optionally including the
     *         import closure.
     */
    default Stream<OWLDatatype> datatypesInSignature(Imports imports) {
        return imports.stream(this).flatMap(OWLOntology::datatypesInSignature).distinct().sorted();
    }

    /**
     * Gets the annotation properties in the signature and optionally the imports closure.
     *
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return the set of annotation properties in the signature, optionally including the import
     *         closure. The set that is returned is a copy; modifications to the returned set will
     *         not be reflected in this object.
     */
    default Set<OWLAnnotationProperty> getAnnotationPropertiesInSignature(
        Imports includeImportsClosure) {
        return asSet(annotationPropertiesInSignature(includeImportsClosure));
    }

    /**
     * Gets the annotation properties in the signature and optionally the imports closure.
     *
     * @param imports if INCLUDED, include imports closure.
     * @return the stream of annotation properties in the signature, optionally including the import
     *         closure.
     */
    default Stream<OWLAnnotationProperty> annotationPropertiesInSignature(Imports imports) {
        return imports.stream(this).flatMap(OWLOntology::annotationPropertiesInSignature).distinct()
            .sorted();
    }

    /**
     * Determines if the signature contains the specified entity.
     *
     * @param owlEntity The entity
     * @param imports if INCLUDED, include imports closure.
     * @return {@code true} if the signature or the import closure contains a reference to the
     *         specified entity.
     */
    default boolean containsEntityInSignature(OWLEntity owlEntity, Imports imports) {
        return imports.stream(this).anyMatch(o -> o.containsEntityInSignature(owlEntity));
    }

    /**
     * Determines if the signature contains an entity with the specified IRI.
     *
     * @param entityIRI The IRI to test for.
     * @param imports if INCLUDED, include imports closure.
     * @return true if the signature or the import closure contains an entity with the specified
     *         IRI.
     */
    default boolean containsEntityInSignature(IRI entityIRI, Imports imports) {
        return imports.stream(this).anyMatch(o -> o.containsEntityInSignature(entityIRI));
    }

    // Access by IRI

    /**
     * Determines if the signature contains an OWLClass that has the specified IRI.
     *
     * @param owlClassIRI The IRI of the class to check for
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return true if the signature or the import closure contains an entity with the specified
     *         IRI.
     */
    boolean containsClassInSignature(IRI owlClassIRI, Imports includeImportsClosure);

    /**
     * Determines if the signature contains an OWLObjectProperty that has the specified IRI.
     *
     * @param owlObjectPropertyIRI The IRI of the OWLObjectProperty to check for
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return true if the signature or the import closure contains an object property with the
     *         specified IRI.
     */
    boolean containsObjectPropertyInSignature(IRI owlObjectPropertyIRI,
        Imports includeImportsClosure);

    /**
     * Determines if the signature contains an OWLDataProperty that has the specified IRI.
     *
     * @param owlDataPropertyIRI The IRI of the OWLDataProperty to check for
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return true if the signature or the import closure contains a data property with the
     *         specified IRI.
     */
    boolean containsDataPropertyInSignature(IRI owlDataPropertyIRI, Imports includeImportsClosure);

    /**
     * Determines if the signature contains an OWLAnnotationProperty that has the specified IRI.
     *
     * @param owlAnnotationPropertyIRI The IRI of the OWLAnnotationProperty to check for
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return true if the signature or the import closure contains an annotation property with the
     *         specified IRI.
     */
    boolean containsAnnotationPropertyInSignature(IRI owlAnnotationPropertyIRI,
        Imports includeImportsClosure);

    /**
     * Determines if the signature contains an OWLDatatype that has the specified IRI.
     *
     * @param owlDatatypeIRI The IRI of the OWLDatatype to check for
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return true if the signature or the import closure contains a datatype with the specified
     *         IRI.
     */
    boolean containsDatatypeInSignature(IRI owlDatatypeIRI, Imports includeImportsClosure);

    /**
     * Determines if the signature contains an OWLNamedIndividual that has the specified IRI.
     *
     * @param owlIndividualIRI The IRI of the OWLNamedIndividual to check for
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return true if the signature or the import closure contains an individual with the specified
     *         IRI.
     */
    boolean containsIndividualInSignature(IRI owlIndividualIRI, Imports includeImportsClosure);

    /**
     * Determines if the signature contains an OWLDatatype that has the specified IRI.
     *
     * @param owlDatatypeIRI The IRI of the OWLDatatype to check for
     * @return true if the signature or the import closure contains a datatype with the specified
     *         IRI.
     */
    boolean containsDatatypeInSignature(IRI owlDatatypeIRI);

    /**
     * Determines if the signature contains an entity with the specified IRI.
     *
     * @param entityIRI The IRI to test for.
     * @return true if the signature or the import closure contains an entity with the specified
     *         IRI.
     */
    default boolean containsEntityInSignature(IRI entityIRI) {
        return containsClassInSignature(entityIRI) || containsObjectPropertyInSignature(entityIRI)
            || containsDataPropertyInSignature(entityIRI)
            || containsIndividualInSignature(entityIRI) || containsDatatypeInSignature(entityIRI)
            || containsAnnotationPropertyInSignature(entityIRI);
    }

    // Access by IRI

    /**
     * Determines if the signature contains an OWLClass that has the specified IRI.
     *
     * @param owlClassIRI The IRI of the class to check for
     * @return true if the signature or the import closure contains an entity with the specified
     *         IRI.
     */
    boolean containsClassInSignature(IRI owlClassIRI);

    /**
     * Determines if the signature contains an OWLObjectProperty that has the specified IRI.
     *
     * @param owlObjectPropertyIRI The IRI of the OWLObjectProperty to check for
     * @return true if the signature or the import closure contains an object property with the
     *         specified IRI.
     */
    boolean containsObjectPropertyInSignature(IRI owlObjectPropertyIRI);

    /**
     * Determines if the signature contains an OWLDataProperty that has the specified IRI.
     *
     * @param owlDataPropertyIRI The IRI of the OWLDataProperty to check for
     * @return true if the signature or the import closure contains a data property with the
     *         specified IRI.
     */
    boolean containsDataPropertyInSignature(IRI owlDataPropertyIRI);

    /**
     * Determines if the signature contains an OWLAnnotationProperty that has the specified IRI.
     *
     * @param owlAnnotationPropertyIRI The IRI of the OWLAnnotationProperty to check for
     * @return true if the signature or the import closure contains an annotation property with the
     *         specified IRI.
     */
    boolean containsAnnotationPropertyInSignature(IRI owlAnnotationPropertyIRI);

    /**
     * Determines if the signature contains an OWLNamedIndividual that has the specified IRI.
     *
     * @param owlIndividualIRI The IRI of the OWLNamedIndividual to check for
     * @return true if the signature or the import closure contains an individual with the specified
     *         IRI.
     */
    boolean containsIndividualInSignature(IRI owlIndividualIRI);

    /**
     * Determine whether the instance has entities of the specified type in its signature - e.g.,
     * whether an ontology has classes, object properties, or named individuals in its signature.
     * Anonymous individuals are not included.
     * 
     * @param type type of entity to check
     * @return true if entities of the specified type are in the signature
     */
    default boolean containsEntitiesOfTypeInSignature(EntityType<?> type) {
        // default implementation - inefficient but avoids backwards compatibility issues with other
        // implementations
        if (EntityType.CLASS.equals(type)) {
            return classesInSignature().count() > 0;
        }
        if (EntityType.DATA_PROPERTY.equals(type)) {
            return dataPropertiesInSignature().count() > 0;
        }
        if (EntityType.OBJECT_PROPERTY.equals(type)) {
            return objectPropertiesInSignature().count() > 0;
        }
        if (EntityType.ANNOTATION_PROPERTY.equals(type)) {
            return annotationPropertiesInSignature().count() > 0;
        }
        if (EntityType.DATATYPE.equals(type)) {
            return datatypesInSignature().count() > 0;
        }
        if (EntityType.NAMED_INDIVIDUAL.equals(type)) {
            return individualsInSignature().count() > 0;
        }
        throw new IllegalArgumentException(
            "Entity type " + type + " is not valid for entity presence check");
    }

    /**
     * Determine whether the instance has entities of the specified type in its signature or in its
     * import closure - e.g., whether an ontology has classes, object properties, or named
     * individuals in its signature. Anonymous individuals are not included.
     * 
     * @param type type of entity to check
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return true if entities of the specified type are in the signature
     */
    default boolean containsEntitiesOfTypeInSignature(EntityType<?> type,
        Imports includeImportsClosure) {
        return includeImportsClosure.stream(this)
            .anyMatch(o -> o.containsEntitiesOfTypeInSignature(type));
    }

    /**
     * Gets the entities in the signature that have the specified IRI.
     *
     * @param iri The IRI of the entities to be retrieved.
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return the set of entities with the specified IRI, optionally including the ones in the
     *         import closure. The set that is returned is a copy; modifications to the returned set
     *         will not be reflected in this object.
     */
    default Set<OWLEntity> getEntitiesInSignature(IRI iri, Imports includeImportsClosure) {
        return asSet(entitiesInSignature(iri, includeImportsClosure));
    }

    /**
     * Gets the entities in the signature that have the specified IRI.
     *
     * @param iri The IRI of the entities to be retrieved.
     * @param imports if INCLUDED, include imports closure.
     * @return the stream of entities with the specified IRI, optionally including the ones in the
     *         import closure.
     */
    default Stream<OWLEntity> entitiesInSignature(IRI iri, Imports imports) {
        return imports.stream(this).flatMap(o -> o.entitiesInSignature(iri)).distinct().sorted();
    }

    /**
     * Calculates the set of IRIs that are used for more than one entity type.
     *
     * @param includeImportsClosure if INCLUDED, include imports closure.
     * @return punned IRIs.
     */
    Set<IRI> getPunnedIRIs(Imports includeImportsClosure);

    /**
     * @param entity entity to check
     * @param imports if INCLUDED, include imports closure.
     * @return true if entity is referenced
     * @deprecated use {@link #containsEntityInSignature(OWLEntity, Imports)}
     */
    @Deprecated
    default boolean containsReference(OWLEntity entity, Imports imports) {
        return imports.stream(this).anyMatch(o -> o.containsReference(entity));
    }

    /**
     * @param entity entity to check
     * @return true if entity is referenced
     * @deprecated use {@link #containsEntityInSignature(OWLEntity)}
     */
    @Deprecated
    boolean containsReference(OWLEntity entity);
}
