org.semanticweb.owlapi.model.OWLAnnotationProperty 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 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 javax.annotation.Nonnull;
import org.semanticweb.owlapi.vocab.OWLRDFVocabulary;

/**
 * Represents an
 * 
 * AnnotationProperty in the OWL 2 specification.
 *
 * @author Matthew Horridge, The University of Manchester, Information Management Group
 * @since 3.0.0
 */
public interface OWLAnnotationProperty extends OWLProperty {

    @Override
    default int hashIndex() {
        return 857;
    }

    @Override
    default int typeIndex() {
        return 1006;
    }

    @Override
    default EntityType getEntityType() {
        return EntityType.ANNOTATION_PROPERTY;
    }

    /**
     * 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}.
     */
    default boolean isComment() {
        return getIRI().equals(OWLRDFVocabulary.RDFS_COMMENT.getIRI());
    }

    /**
     * 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}.
     */
    default boolean isLabel() {
        return getIRI().equals(OWLRDFVocabulary.RDFS_LABEL.getIRI());
    }

    /**
     * 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}.
     */
    default boolean isDeprecated() {
        return getIRI().equals(OWLRDFVocabulary.OWL_DEPRECATED.getIRI());
    }

    @Override
    default boolean isOWLAnnotationProperty() {
        return true;
    }

    @Override
    default void accept(@Nonnull OWLObjectVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    default  O accept(@Nonnull OWLObjectVisitorEx visitor) {
        return visitor.visit(this);
    }

    @Override
    default void accept(@Nonnull OWLPropertyExpressionVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    default  O accept(@Nonnull OWLPropertyExpressionVisitorEx visitor) {
        return visitor.visit(this);
    }

    @Override
    default void accept(@Nonnull OWLEntityVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    default  O accept(@Nonnull OWLEntityVisitorEx visitor) {
        return visitor.visit(this);
    }

    @Override
    default void accept(@Nonnull OWLNamedObjectVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    default  O accept(@Nonnull OWLNamedObjectVisitorEx visitor) {
        return visitor.visit(this);
    }
}