org.semanticweb.owlapi.model.OWLEntity Maven / Gradle / Ivy
/* 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;
/**
* Represents Entities in the OWL 2 Specification.
*
* @author Matthew Horridge, The University Of Manchester, Bio-Health
* Informatics Group
* @since 2.0.0
*/
public interface OWLEntity extends OWLObject, OWLNamedObject, OWLPrimitive {
/**
* Gets the entity type for this entity
*
* @return The entity type
*/
@Nonnull
EntityType getEntityType();
/**
* Tests to see if this entity is of the specified type
*
* @param entityType
* The entity type
* @return {@code true} if this entity is of the specified type, otherwise
* {@code false}.
*/
boolean isType(@Nonnull EntityType entityType);
/**
* Determines if this entity is a built in entity. The entity is a built in
* entity if it is:
*
* - a class and the URI corresponds to owl:Thing or owl:Nothing
* - an object property and the URI corresponds to owl:topObjectProperty
* or owl:bottomObjectProperty
* - a data property and the URI corresponds to owl:topDataProperty or
* owl:bottomDataProperty
* - a datatype and the IRI is rdfs:Literal or is in the OWL 2 datatype
* map or is rdf:PlainLiteral
* - an annotation property and the URI is in the set of built in
* annotation property URIs, i.e. one of:
*
* - rdfs:label
* - rdfs:comment
* - rdfs:seeAlso
* - rdfs:isDefinedBy
* - owl:deprecated
* - owl:priorVersion
* - owl:backwardCompatibleWith
* - owl:incompatibleWith
*
*
*
*
* @return {@code true} if this entity is a built in entity, or
* {@code false} if this entity is not a builtin entity.
*/
boolean isBuiltIn();
/**
* A convenience method that determines if this entity is an OWLClass
*
* @return {@code true} if this entity is an OWLClass, otherwise
* {@code false}
*/
boolean isOWLClass();
/**
* A convenience method that obtains this entity as an OWLClass (in order to
* avoid explicit casting).
*
* @return The entity as an OWLClass.
* @throws OWLRuntimeException
* if this entity is not an OWLClass (check with the isOWLClass
* method first).
*/
@Nonnull
OWLClass asOWLClass();
/**
* A convenience method that determines if this entity is an
* OWLObjectProperty
*
* @return {@code true} if this entity is an OWLObjectProperty, otherwise
* {@code false}
*/
boolean isOWLObjectProperty();
/**
* A convenience method that obtains this entity as an OWLObjectProperty (in
* order to avoid explicit casting).
*
* @return The entity as an OWLObjectProperty.
* @throws OWLRuntimeException
* if this entity is not an OWLObjectProperty (check with the
* isOWLObjectProperty method first).
*/
@Nonnull
OWLObjectProperty asOWLObjectProperty();
/**
* A convenience method that determines if this entity is an OWLDataProperty
*
* @return {@code true} if this entity is an OWLDataProperty, otherwise
* {@code false}
*/
boolean isOWLDataProperty();
/**
* A convenience method that obtains this entity as an OWLDataProperty (in
* order to avoid explicit casting).
*
* @return The entity as an OWLDataProperty.
* @throws OWLRuntimeException
* if this entity is not an OWLDataProperty (check with the
* isOWLDataProperty method first).
*/
@Nonnull
OWLDataProperty asOWLDataProperty();
/**
* A convenience method that determines if this entity is an
* OWLNamedIndividual
*
* @return {@code true} if this entity is an OWLNamedIndividual, otherwise
* {@code false}
*/
boolean isOWLNamedIndividual();
/**
* A convenience method that obtains this entity as an OWLNamedIndividual
* (in order to avoid explicit casting).
*
* @return The entity as an OWLNamedIndividual.
* @throws OWLRuntimeException
* if this entity is not an OWLIndividual (check with the
* isOWLIndividual method first).
*/
@Nonnull
OWLNamedIndividual asOWLNamedIndividual();
/**
* A convenience method that determines if this entity is an OWLDatatype
*
* @return {@code true} if this entity is an OWLDatatype, otherwise
* {@code false}
*/
boolean isOWLDatatype();
/**
* A convenience method that obtains this entity as an OWLDatatype (in order
* to avoid explicit casting).
*
* @return The entity as an OWLDatatype.
* @throws OWLRuntimeException
* if this entity is not an OWLDatatype (check with the
* isOWLDatatype method first).
*/
@Nonnull
OWLDatatype asOWLDatatype();
/**
* A convenience method that determines if this entity is an
* OWLAnnotationProperty
*
* @return {@code true} if this entity is an OWLAnnotationProperty,
* otherwise {@code false}
*/
boolean isOWLAnnotationProperty();
/**
* A convenience method that obtains this entity as an OWLAnnotationProperty
* (in order to avoid explicit casting).
*
* @return The entity as an OWLAnnotationProperty.
* @throws OWLRuntimeException
* if this entity is not an OWLAnnotationProperty
*/
@Nonnull
OWLAnnotationProperty asOWLAnnotationProperty();
/**
* Returns a string representation that can be used as the ID of this
* entity. This is the toString representation of the IRI
*
* @return A string representing the toString of the IRI of this entity.
*/
@Nonnull
String toStringID();
/**
* @param visitor
* visitor
*/
void accept(@Nonnull OWLEntityVisitor visitor);
/**
* @param visitor
* visitor
* @param
* visitor return type
* @return visitor return value
*/
@Nonnull
O accept(@Nonnull OWLEntityVisitorEx visitor);
}