All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 5.5.1
Show 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;

/**
 * Represents an AnnotationProperty in the OWL 2 specification.
 * 
 * @author Matthew Horridge, The University of Manchester, Information
 *         Management Group, Date: 13-Jan-2009
 */
public interface OWLAnnotationProperty extends OWLEntity {

    /**
     * Determines if this annotation property has an IRI corresponding to
     * {@code rdfs:comment}.
     * 
     * @return {@code true} if the IRI of this annotation property is
     *         {@code rdfs:comment}, where {@code rdfs:} expands to the usual
     *         prefix, otherwise {@code false}.
     */
    boolean isComment();

    /**
     * Determines if this annotation property has an IRI corresponding to
     * {@code rdfs:label}.
     * 
     * @return {@code true} if the IRI of this annotation property is
     *         {@code rdfs:label}, where {@code rdfs:} expands to the usual
     *         prefix, otherwise {@code false}.
     */
    boolean isLabel();

    /**
     * Determines if this annotation property has an IRI corresponding to
     * {@code owl:deprecated}. An annotation along the {@code owl:deprecated}
     * property which has a value of {@code "true"^^xsd:boolean} can be used to
     * deprecate IRIs. (See Section 5.5
     *  of the OWL 2 specification.
     * 
     * @return {@code true} if the IRI of this annotation property is
     *         {@code owl:deprecated}, where {@code owl:} expands to the usual
     *         prefix, otherwise {@code false}.
     */
    boolean isDeprecated();

    /**
     * Gets the annotation properties which are asserted to be sub-properties of
     * this annotation property in the specified ontology.
     * 
     * @param ontology
     *        The ontology to be examined for {@code SubAnnotationPropertyOf}
     *        axioms.
     * @return A set of annotation properties such that for each property
     *         {@code p} in the set, it is the case that {@code ontology}
     *         contains an {@code SubAnnotationPropertyOf(p, this)} axiom where
     *         {@code this} refers to this annotation property.
     * @since 3.2
     */
    Set getSubProperties(OWLOntology ontology);

    /**
     * Gets the annotation properties which are asserted to be sub-properties of
     * this annotation property in the specified ontology and potentially its
     * imports closure.
     * 
     * @param ontology
     *        The ontology to be examined for {@code SubAnnotationPropertyOf}
     *        axioms.
     * @param includeImportsClosure
     *        if {@code true} then the imports closure of this ontology is
     *        searched for {@code SubAnnotationPropertyOf} axioms that assert
     *        this property is the super property of some other annotation
     *        property. If {@code false} then only {@code ontology} is searched.
     * @return If {@code includeImportsClosure} is {@code true}, a set of
     *         annotation properties such that for each property {@code p} in
     *         the set, it is the case that at least one {@code ontology} in the
     *         imports closure contains a
     *         {@code SubAnnotationPropertyOf(p, this)} axiom where {@code this}
     *         refers to this annotation property. If
     *         {@code includeImportsClosure} is {@code false}, a set of
     *         annotation properties such that for each property {@code p} in
     *         the set, it is the case that {@code ontology} contains a
     *         {@code SubAnnotationPropertyOf(p, this)} axiom where {@code this}
     *         refers to this annotation property.
     * @since 3.2
     */
    Set getSubProperties(OWLOntology ontology,
            boolean includeImportsClosure);

    /**
     * Gets the annotation properties which are asserted to be sub-properties of
     * this annotation property in the specified set of ontologies.
     * 
     * @param ontologies
     *        The set of ontologies to be examined for
     *        {@code SubAnnotationPropertyOf} axioms.
     * @return A set of annotation properties such that for each property
     *         {@code p} in the set, it is the case that at least one
     *         {@code ontology} in {@code ontologies} contains a
     *         {@code SubAnnotationPropertyOf(p, this)} axiom where {@code this}
     *         refers to this annotation property.
     * @since 3.2
     */
    Set getSubProperties(Set ontologies);

    /**
     * Gets the annotation properties which are asserted to be super-properties
     * of this annotation property in the specified ontology.
     * 
     * @param ontology
     *        The ontology to be examined for {@code SubAnnotationPropertyOf}
     *        axioms.
     * @return A set of annotation properties such that for each property
     *         {@code p} in the set, it is the case that {@code ontology}
     *         contains an {@code SubAnnotationPropertyOf(this, p)} axiom where
     *         {@code this} refers to this annotation property.
     * @since 3.2
     */
    Set getSuperProperties(OWLOntology ontology);

    /**
     * Gets the annotation properties which are asserted to be super-properties
     * of this annotation property in the specified ontology and potentially its
     * imports closure.
     * 
     * @param ontology
     *        The ontology to be examined for {@code SubAnnotationPropertyOf}
     *        axioms.
     * @param includeImportsClosure
     *        if {@code true} then the imports closure of this ontology is
     *        searched for {@code SubAnnotationPropertyOf} axioms that assert
     *        this property is the super property of some other annotation
     *        property. If {@code false} then only {@code ontology} is searched.
     * @return If {@code includeImportsClosure} is {@code true}, a set of
     *         annotation properties such that for each property {@code p} in
     *         the set, it is the case that at least one {@code ontology} in the
     *         imports closure contains a
     *         {@code SuperAnnotationPropertyOf(this, p)} axiom where
     *         {@code this} refers to this annotation property. If
     *         {@code includeImportsClosure} is {@code false}, a set of
     *         annotation properties such that for each property {@code p} in
     *         the set, it is the case that {@code ontology} contains a
     *         {@code SuperAnnotationPropertyOf(this, p)} axiom where
     *         {@code this} refers to this annotation property.
     * @since 3.2
     */
    Set getSuperProperties(OWLOntology ontology,
            boolean includeImportsClosure);

    /**
     * Gets the annotation properties which are asserted to be super-properties
     * of this annotation property in the specified set of ontologies.
     * 
     * @param ontologies
     *        The set of ontologies to be examined for
     *        {@code SubAnnotationPropertyOf} axioms.
     * @return A set of annotation properties such that for each property
     *         {@code p} in the set, it is the case that at least one
     *         {@code ontology} in {@code ontologies} contains a
     *         {@code SubAnnotationPropertyOf(this, p)} axiom where {@code this}
     *         refers to this annotation property.
     * @since 3.2
     */
    Set getSuperProperties(Set ontologies);
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy