org.semanticweb.owlapi.model.OWLClass Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owlapi-api Show documentation
The newest version!
/*
 * This file is part of the OWL API.
 *
 * The contents of this file are subject to the LGPL License, Version 3.0.
 *
 * Copyright (C) 2011, 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.
 *
 * Copyright 2011, University of Manchester
 *
 * 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 java.util.Set;


/**
 * Author: Matthew Horridge

 * The University Of Manchester

 * Bio-Health Informatics Group
 * Date: 24-Oct-2006
 * Represents a Class in the OWL 2 specification.
 */
public interface OWLClass extends OWLClassExpression, OWLLogicalEntity, OWLNamedObject {

    /**
     * A convenience method that examines the axioms in the specified ontology
     * and return the class expressions corresponding to super classes of this class.
     * @param ontology The ontology to be examined
     * @return A Set of OWLClassExpressions that represent
     *         the superclasses of this class, which have been asserted in the specified
     *         ontology.
     */
    Set getSuperClasses(OWLOntology ontology);

    /**
     * A convenience method that examines the axioms in the specified ontologies
     * and returns the class expression corresponding to the asserted super classes
     * of this class.
     * @param ontologies The set of ontologies to be examined.
     * @return A set of OWLClassExpressionss that represent the super classes
     *         of this class
     */
    Set getSuperClasses(Set ontologies);


    /**
     * Gets the classes which have been asserted to be subclasses of this class
     * in the specified ontology.
     * @param ontology The ontology which should be examined for subclass axioms.
     * @return A Set of OWLClassExpressions that represet the
     *         asserted subclasses of this class.
     */
    Set getSubClasses(OWLOntology ontology);

    /**
     * Gets the classes which have been asserted to be subclasses of this class
     * in the specified ontologies.
     * @param ontologies The ontologies which should be examined for subclass axioms.
     * @return A Set of OWLClassExpressions that represet the
     *         asserted subclasses of this class.
     */
    Set getSubClasses(Set ontologies);

    /**
     * A convenience method that examines the axioms in the specified ontology
     * and returns the class expressions corresponding to equivalent classes of this
     * class.
     * @param ontology The ontology to be examined for axioms
     * @return A Set of OWLClassExpressions that represent
     *         the equivalent classes of this class, that have been asserted in the specified
     *         ontology.
     */
    Set getEquivalentClasses(OWLOntology ontology);

    /**
     * A convenience method that examines the axioms in the specified ontologies
     * and returns the class expressions corresponding to equivalent classes of this
     * class.
     * @param ontologies The ontologies to be examined for axioms
     * @return A Set of OWLClassExpressions that represent
     *         the equivalent classes of this class, that have been asserted in the specified
     *         ontologies.
     */
    Set getEquivalentClasses(Set ontologies);

    /**
     * Gets the classes which have been asserted to be disjoint with this class by
     * axioms in the specified ontology.
     * @param ontology The ontology to search for disjoint class axioms
     * @return A Set of OWLClassExpressions that represent
     *         the disjoint classes of this class.
     */
    Set getDisjointClasses(OWLOntology ontology);

    /**
     * Gets the classes which have been asserted to be disjoint with this class by
     * axioms in the specified ontologies.
     * @param ontologies The ontologies to search for disjoint class axioms
     * @return A Set of OWLClassExpressions that represent
     *         the disjoint classes of this class.
     */
    Set getDisjointClasses(Set ontologies);


    /**
     * Gets the individuals that have been asserted to be an instance of this
     * class by axioms in the specified ontology.
     * @param ontology The ontology to be examined for class assertion axioms that
     * assert an individual to be an instance of this class.
     * @return A Set of OWLIndividuals that represent
     *         the individual that have been asserted to be an instance of this class.
     */
    Set getIndividuals(OWLOntology ontology);


    /**
     * Gets the individuals that have been asserted to be an instance of this
     * class by axioms in the speficied ontologies.
     * @param ontologies The ontologies to be examined for class assertion axioms that
     * assert an individual to be an instance of this class.
     * @return A Set of OWLIndividuals that represent
     *         the individual that have been asserted to be an instance of this class.
     */
    Set getIndividuals(Set ontologies);

    /**
     * Determines if this class is a top level class in an {@link org.semanticweb.owlapi.model.OWLEquivalentClassesAxiom}
     * in the specified ontology.
     * @param ontology The ontology to examine for axioms.
     * @return true if ontology contains an EquivalentClassesAxiom where this
     *         class is a top level class in the axiom, other wise false.
     */
    boolean isDefined(OWLOntology ontology);


    /**
     * Determines if this class is a top level class in an {@link org.semanticweb.owlapi.model.OWLEquivalentClassesAxiom}
     * in at least one of the specified ontologies.
     * @param ontologies The ontologies to examine for axioms.
     * @return true if one or more of ontologies contains an EquivalentClassesAxiom where this
     *         class is a top level class in the axiom, other wise false.
     */
    boolean isDefined(Set ontologies);

}