org.semanticweb.owlapi.model.OWLPropertyExpression 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 (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 property or possibly the inverse
* of a property.
* @param
* range
* @param
* property expression
*/
public interface OWLPropertyExpression>
extends OWLObject {
/**
* Gets the asserted domains of this property.
*
* @param ontology
* The ontology that should be examined for axioms which assert a
* domain of this property
* @return A set of {@code OWLClassExpression}s corresponding to the domains
* of this property (the domain of the property is essentially the
* intersection of these class expressions).
*/
Set getDomains(OWLOntology ontology);
/**
* Gets the asserted domains of this property by examining the axioms in the
* specified ontologies.
*
* @param ontologies
* The ontologies to be examined.
* @return A set of {@code OWLClassExpression}s that represent the asserted
* domains of this property.
*/
Set getDomains(Set ontologies);
/**
* Gets the ranges of this property that have been asserted in the specified
* ontology.
*
* @param ontology
* The ontology to be searched for axioms which assert a range for
* this property.
* @return A set of ranges for this property.
*/
Set getRanges(OWLOntology ontology);
/**
* Gets the asserted ranges of this property by examining the axioms in the
* specified ontologies.
*
* @param ontologies
* The ontologies to be examined for range axioms.
* @return A set of ranges for this property, which have been asserted by
* axioms in the specified ontologies.
*/
Set getRanges(Set ontologies);
/**
* Gets the asserted/told super properties by examining the axioms in the
* specified ontology.
*
* @param ontology
* The ontology which will be examined for subproperty axioms.
* @return A set of properties which represent the explicitly asserted/told
* superproperties of this property.
*/
Set getSuperProperties(OWLOntology ontology);
/**
* Gets the asserted super properties by examining the axioms in the
* specified set of ontologies.
*
* @param ontologies
* The ontologies which will bne examined for axioms
* @return A set of properties which represent the asserted super properties
* of this property.
*/
Set
getSuperProperties(Set ontologies);
/**
* Gets the asserted/told sub properties by examining the axioms in the
* specified ontology.
*
* @param ontology
* The ontology which will be examined for subproperty axioms.
* @return A set of properties which represent the explicitly asserted/told
* subproperties of this property.
*/
Set getSubProperties(OWLOntology ontology);
/**
* Gets the asserted sub properties by examining the axioms in the specified
* ontologies.
*
* @param ontologies
* The ontologies which will be examined for subproperty axioms.
* @return A set of properties which represent the explicitly asserted
* subproperties of this property.
*/
Set
getSubProperties(Set ontologies);
/**
* Gets the asserted/told equivalent properties by examining the axioms in
* the specified ontology.
*
* @param ontology
* The ontology which will be examined for equivalent properties
* axioms.
* @return A set of properties which represent the explicitly asserted/told
* equivalent properties of this property.
*/
Set getEquivalentProperties(OWLOntology ontology);
/**
* Gets the asserted equivalent properties by examining the axioms in the
* specified ontologies.
*
* @param ontologies
* The ontologies which will be examined for equivalent properties
* axioms.
* @return A set of properties which represent the explicitly asserted/told
* equivalent properties of this property.
*/
Set
getEquivalentProperties(Set ontologies);
/**
* @param ontology
* the ontology to use
* @return the properties disjoint with this one declared in ontology
*/
Set getDisjointProperties(OWLOntology ontology);
/**
* @param ontologies
* the ontologies to use
* @return the properties disjoint with this one declared in ontologies
*/
Set
getDisjointProperties(Set ontologies);
/**
* Determines if this property is functional in the specified ontology.
*
* @param ontology
* The ontology to be tested for a functional property axiom.
* @return {@code true} if the specified ontology contains an axiom stating
* that the property is functional, other wise {@code false}.
*/
boolean isFunctional(OWLOntology ontology);
/**
* Determines if the property is functional because there is an axiom in one
* of the specified ontologies that assert this to be the case.
*
* @param ontologies
* The ontologies which will be searched for axioms which specify
* that this property is fuctional.
* @return {@code true} if the property is functional, or {@code false} if
* the property is not functional.
*/
boolean isFunctional(Set ontologies);
/**
* Determines if this property expression is anonymous.
*
* @return {@code true} if the property expression is anonymous (because it
* is the inverse of a property). {@code false} if this property is
* a named object property or named data property.
*/
boolean isAnonymous();
/**
* @param visitor
* visitor to accept
*/
void accept(OWLPropertyExpressionVisitor visitor);
/**
* @param visitor
* visitor to accept
* @param
* visitor return type
* @return visitor value
*/
O accept(OWLPropertyExpressionVisitorEx visitor);
/** @return true if this is a data property */
boolean isDataPropertyExpression();
/** @return true if this is an object property */
boolean isObjectPropertyExpression();
/**
* Determines if this is the owl:topObjectProperty.
*
* @return {@code true} if this property is the owl:topObjectProperty
* otherwise {@code false}
*/
boolean isOWLTopObjectProperty();
/**
* Determines if this is the owl:bottomObjectProperty.
*
* @return {@code true} if this property is the owl:bottomObjectProperty
* otherwise {@code false}
*/
boolean isOWLBottomObjectProperty();
/**
* Determines if this is the owl:topDataProperty.
*
* @return {@code true} if this property is the owl:topDataProperty
* otherwise {@code false}
*/
boolean isOWLTopDataProperty();
/**
* Determines if this is the owl:bottomDataProperty.
*
* @return {@code true} if this property is the owl:bottomDataProperty
* otherwise {@code false}
*/
boolean isOWLBottomDataProperty();
}