org.semanticweb.owlapi.model.OWLAxiomIndex Maven / Gradle / Ivy
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 static org.semanticweb.owlapi.model.parameters.Imports.EXCLUDED;
import static org.semanticweb.owlapi.model.parameters.Navigation.IN_SUB_POSITION;
import static org.semanticweb.owlapi.model.parameters.Navigation.IN_SUPER_POSITION;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.asSet;
import java.util.Collection;
import java.util.Set;
import java.util.stream.Stream;
import org.semanticweb.owlapi.model.parameters.Imports;
import org.semanticweb.owlapi.model.parameters.Navigation;
import org.semanticweb.owlapi.util.OWLAxiomSearchFilter;
/**
* Axiom accessor methods - all OWLOntology methods that return sets (or streams) of axioms of a
* certain type or with a certain entity referred.
*
* @author ignazio
* @since 4.0.0
*/
public interface OWLAxiomIndex extends HasImportsClosure {
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param includeImports if INCLUDED, include imports closure.
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return set of axioms satisfying the conditions. The set that is returned is a copy;
* modifications to the returned set will not be reflected in this object.
*/
default Set getAxioms(Class type, OWLObject entity,
Imports includeImports, Navigation forSubPosition) {
return asSet(axioms(type, entity, includeImports, forSubPosition));
}
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param imports if INCLUDED, include imports closure.
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return stream of axioms satisfying the conditions.
*/
default Stream axioms(Class type, OWLObject entity, Imports imports,
Navigation forSubPosition) {
return imports.stream(this)
.flatMap(o -> o.axioms(type, entity.getClass(), entity, forSubPosition));
}
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return set of axioms satisfying the conditions. The set that is returned is a copy;
* modifications to the returned set will not be reflected in this object.
*/
default Set getAxioms(Class type, OWLObject entity,
Navigation forSubPosition) {
return asSet(axioms(type, entity, forSubPosition));
}
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return stream of axioms satisfying the conditions.
*/
default Stream axioms(Class type, OWLObject entity,
Navigation forSubPosition) {
return axioms(type, entity.getClass(), entity, forSubPosition);
}
/**
* Generic filter type for further refining search by axiom type. The returned axioms are both
* belonging to one of the types listed by the filter and satisfying its pass condition.
*
* @param type of returned axioms
* @param filter the filter to match
* @param key the key. Its type is generic and it is used only by the filter.
* @param includeImportsClosure if INCLUDED, include imports closure.
* @return a collection of axioms matching the request. The axioms are collected from a set,
* therefore the collection contains no duplicates. The collection that is returned is a
* copy; modifications to the returned collection will not be reflected in this object.
*/
default Collection filterAxioms(OWLAxiomSearchFilter filter, Object key,
Imports includeImportsClosure) {
return asSet(axioms(filter, key, includeImportsClosure));
}
/**
* Generic filter type for further refining search by axiom type. The returned axioms are both
* belonging to one of the types listed by the filter and satisfying its pass condition.
*
* @param type of returned axioms
* @param filter the filter to match
* @param key the key. Its type is generic and it is used only by the filter.
* @param includeImportsClosure if INCLUDED, include imports closure.
* @return a stream of axioms matching the request. The axioms are collected from a set,
* therefore it contains no duplicates.
*/
Stream axioms(OWLAxiomSearchFilter filter, Object key,
Imports includeImportsClosure);
/**
* Generic filter type for further refining search by axiom type. The returned axioms are both
* belonging to one of the types listed by the filter and satisfying its pass condition.
*
* @param type of returned axioms
* @param filter the filter to match
* @param key the key. Its type is generic and it is used only by the filter.
* @return a collection of axioms matching the request. The axioms are collected from a set,
* therefore the collection contains no duplicates. The collection that is returned is a
* copy; modifications to the returned collection will not be reflected in this object.
*/
default Collection filterAxioms(OWLAxiomSearchFilter filter,
Object key) {
return asSet(axioms(filter, key));
}
/**
* Generic filter type for further refining search by axiom type. The returned axioms are both
* belonging to one of the types listed by the filter and satisfying its pass condition.
*
* @param type of returned axioms
* @param filter the filter to match
* @param key the key. Its type is generic and it is used only by the filter.
* @return a stream of axioms matching the request. The axioms are collected from a set,
* therefore it contains no duplicates.
*/
Stream axioms(OWLAxiomSearchFilter filter, Object key);
/**
* Generic containment check type for further refining search by axiom type. The method returns
* true if there is at least one result matching the filter.
*
* @param filter the filter to match
* @param key the key. Its type is generic and it is used only by the filter.
* @return true if there is at least one result matching the filter.
*/
boolean contains(OWLAxiomSearchFilter filter, Object key);
/**
* Generic containment check type for further refining search by axiom type. The method returns
* true if there is at least one result matching the filter.
*
* @param filter the filter to match
* @param key the key. Its type is generic and it is used only by the filter.
* @param includeImportsClosure if INCLUDED, include imports closure.
* @return true if there is at least one result matching the filter.
*/
boolean contains(OWLAxiomSearchFilter filter, Object key, Imports includeImportsClosure);
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param explicitClass for overlapping indexes in the ontology internals, an explicit class
* rather than the entity class might be necessary
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return set of axioms satisfying the conditions. The set that is returned is a copy;
* modifications to the returned set will not be reflected in this object.
*/
default Set getAxioms(Class type,
Class explicitClass, OWLObject entity, Navigation forSubPosition) {
return asSet(axioms(type, explicitClass, entity, forSubPosition));
}
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param explicitClass for overlapping indexes in the ontology internals, an explicit class
* rather than the entity class might be necessary
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return stream of axioms satisfying the conditions.
*/
Stream axioms(Class type, Class explicitClass,
OWLObject entity, Navigation forSubPosition);
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param explicitClass for overlapping indexes in the ontology internals, an explicit class
* rather than the entity class might be necessary
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param includeImports if INCLUDED, include imports closure.
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return set of axioms satisfying the conditions. The set that is returned is a copy;
* modifications to the returned set will not be reflected in this object.
*/
default Set getAxioms(Class type,
Class explicitClass, OWLObject entity, Imports includeImports,
Navigation forSubPosition) {
return asSet(axioms(type, explicitClass, entity, includeImports, forSubPosition));
}
/**
* Generic search method: returns all axioms which refer entity, are instances of type,
* optionally including the imports closure in the results.
*
* @param type of returned axioms
* @param type type of axioms
* @param explicitClass for overlapping indexes in the ontology internals, an explicit class
* rather than the entity class might be necessary
* @param entity referred entity (OWLPrimitive or property/class expression)
* @param imports if INCLUDED, include imports closure.
* @param forSubPosition for sub axioms (subclass, subproperty), the value specifies whether
* entity should appear as sub or super entity in the axioms returned. For axiom types
* that have no sub/super entities, this parameter is ignored.
* @return stream of axioms satisfying the conditions.
*/
default Stream axioms(Class type,
Class explicitClass, OWLObject entity, Imports imports,
Navigation forSubPosition) {
return imports.stream(this)
.flatMap(o -> o.axioms(type, explicitClass, entity, forSubPosition));
}
// Annotation axioms
/**
* Gets the {@code OWLSubAnnotationPropertyOfAxiom} objects where the specified property is the
* sub-property.
*
* @param subProperty The sub-property of the axioms to be retrieved.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getSubAnnotationPropertyOfAxioms(
OWLAnnotationProperty subProperty) {
return asSet(subAnnotationPropertyOfAxioms(subProperty));
}
/**
* Gets the {@code OWLSubAnnotationPropertyOfAxiom} objects where the specified property is the
* sub-property.
*
* @param subProperty The sub-property of the axioms to be retrieved.
* @return the axioms matching the search.
*/
Stream subAnnotationPropertyOfAxioms(
OWLAnnotationProperty subProperty);
/**
* Gets the {@code OWLAnnotationPropertyDomainAxiom} objects where the specified property is the
* property in the domain axiom.
*
* @param property The property that the axiom specifies a domain for.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getAnnotationPropertyDomainAxioms(
OWLAnnotationProperty property) {
return asSet(annotationPropertyDomainAxioms(property));
}
/**
* Gets the {@code OWLAnnotationPropertyDomainAxiom} objects where the specified property is the
* property in the domain axiom.
*
* @param property The property that the axiom specifies a domain for.
* @return the axioms matching the search.
*/
Stream annotationPropertyDomainAxioms(
OWLAnnotationProperty property);
/**
* Gets the {@code OWLAnnotationPropertyRangeAxiom} objects where the specified property is the
* property in the range axiom.
*
* @param property The property that the axiom specifies a range for.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getAnnotationPropertyRangeAxioms(
OWLAnnotationProperty property) {
return asSet(annotationPropertyRangeAxioms(property));
}
/**
* Gets the {@code OWLAnnotationPropertyRangeAxiom} objects where the specified property is the
* property in the range axiom.
*
* @param property The property that the axiom specifies a range for.
* @return the axioms matching the search.
*/
Stream annotationPropertyRangeAxioms(
OWLAnnotationProperty property);
// Various methods that provide axioms relating to specific entities that
// allow frame style views to be composed for a particular entity. Such
// functionality is useful for ontology editors and browsers.
/**
* Gets the declaration axioms for specified entity.
*
* @param subject The entity that is the subject of the returned axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDeclarationAxioms(OWLEntity subject) {
return getAxioms(OWLDeclarationAxiom.class, subject, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the declaration axioms for specified entity.
*
* @param subject The entity that is the subject of the returned axioms.
* @return the axioms matching the search.
*/
default Stream declarationAxioms(OWLEntity subject) {
return axioms(OWLDeclarationAxiom.class, subject, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the axioms that annotate the specified entity.
*
* @param entity The entity whose annotations are to be retrieved.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getAnnotationAssertionAxioms(
OWLAnnotationSubject entity) {
return asSet(annotationAssertionAxioms(entity, EXCLUDED));
}
/**
* Gets the axioms that annotate the specified entity.
*
* @param entity The entity whose annotations are to be retrieved.
* @param imports imports included or excluded
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getAnnotationAssertionAxioms(
OWLAnnotationSubject entity, Imports imports) {
return asSet(annotationAssertionAxioms(entity, imports));
}
/**
* Gets the axioms that annotate the specified entity.
*
* @param entity The entity whose annotations are to be retrieved.
* @return the axioms matching the search.
*/
default Stream annotationAssertionAxioms(
OWLAnnotationSubject entity) {
return annotationAssertionAxioms(entity, EXCLUDED);
}
/**
* Gets the axioms that annotate the specified entity.
*
* @param entity The entity whose annotations are to be retrieved.
* @param imports imports included or excluded
* @return the axioms matching the search.
*/
default Stream annotationAssertionAxioms(
OWLAnnotationSubject entity, Imports imports) {
return axioms(OWLAnnotationAssertionAxiom.class, OWLAnnotationSubject.class, entity,
imports, IN_SUB_POSITION);
}
// Classes
/**
* Gets all of the subclass axioms where the left hand side (the subclass) is equal to the
* specified class.
*
* @param cls The class that is equal to the left hand side of the axiom (subclass).
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getSubClassAxiomsForSubClass(OWLClass cls) {
return asSet(subClassAxiomsForSubClass(cls));
}
/**
* Gets all of the subclass axioms where the left hand side (the subclass) is equal to the
* specified class.
*
* @param cls The class that is equal to the left hand side of the axiom (subclass).
* @return the axioms matching the search.
*/
default Stream subClassAxiomsForSubClass(OWLClass cls) {
return axioms(OWLSubClassOfAxiom.class, OWLClass.class, cls, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets all of the subclass axioms where the right hand side (the superclass) is equal to the
* specified class.
*
* @param cls The class
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getSubClassAxiomsForSuperClass(OWLClass cls) {
return asSet(subClassAxiomsForSuperClass(cls));
}
/**
* Gets all of the subclass axioms where the right hand side (the superclass) is equal to the
* specified class.
*
* @param cls The class
* @return the axioms matching the search.
*/
default Stream subClassAxiomsForSuperClass(OWLClass cls) {
return axioms(OWLSubClassOfAxiom.class, OWLClass.class, cls, EXCLUDED, IN_SUPER_POSITION);
}
/**
* Gets all of the equivalent axioms in this ontology that contain the specified class as an
* operand.
*
* @param cls The class to search
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getEquivalentClassesAxioms(OWLClass cls) {
return asSet(equivalentClassesAxioms(cls));
}
/**
* Gets all of the equivalent axioms in this ontology that contain the specified class as an
* operand.
*
* @param cls The class to search
* @return the axioms matching the search.
*/
default Stream equivalentClassesAxioms(OWLClass cls) {
return axioms(OWLEquivalentClassesAxiom.class, OWLClass.class, cls, EXCLUDED,
IN_SUB_POSITION);
}
/**
* Gets the set of disjoint class axioms that contain the specified class as an operand.
*
* @param cls The class to search
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDisjointClassesAxioms(OWLClass cls) {
return asSet(disjointClassesAxioms(cls));
}
/**
* Gets the stream of disjoint class axioms that contain the specified class as an operand.
*
* @param cls The class to search
* @return the axioms matching the search.
*/
default Stream disjointClassesAxioms(OWLClass cls) {
return axioms(OWLDisjointClassesAxiom.class, OWLClass.class, cls, EXCLUDED,
IN_SUB_POSITION);
}
/**
* Gets the set of disjoint union axioms that have the specified class as the named class that
* is equivalent to the disjoint union of operands. For example, if the ontology contained the
* axiom DisjointUnion(A, propP some C, D, E) this axiom would be returned for class A (but not
* for D or E).
*
* @param owlClass The class that indexes the axioms to be retrieved.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDisjointUnionAxioms(OWLClass owlClass) {
return asSet(disjointUnionAxioms(owlClass));
}
/**
* Gets the stream of disjoint union axioms that have the specified class as the named class
* that is equivalent to the disjoint union of operands. For example, if the ontology contained
* the axiom DisjointUnion(A, propP some C, D, E) this axiom would be returned for class A (but
* not for D or E).
*
* @param owlClass The class that indexes the axioms to be retrieved.
* @return the axioms matching the search.
*/
default Stream disjointUnionAxioms(OWLClass owlClass) {
return axioms(OWLDisjointUnionAxiom.class, OWLClass.class, owlClass, EXCLUDED,
IN_SUB_POSITION);
}
/**
* Gets the has key axioms that have the specified class as their subject.
*
* @param cls The subject of the has key axioms
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getHasKeyAxioms(OWLClass cls) {
return asSet(hasKeyAxioms(cls));
}
/**
* Gets the has key axioms that have the specified class as their subject.
*
* @param cls The subject of the has key axioms
* @return the axioms matching the search.
*/
default Stream hasKeyAxioms(OWLClass cls) {
return axioms(OWLHasKeyAxiom.class, OWLClass.class, cls, EXCLUDED, IN_SUB_POSITION);
}
// Object properties
/**
* Gets the {@link OWLSubObjectPropertyOfAxiom} objects where the sub-property is equal to the
* specified property.
*
* @param subProperty The property which is equal to the sub property of the retrieved axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getObjectSubPropertyAxiomsForSubProperty(
OWLObjectPropertyExpression subProperty) {
return asSet(objectSubPropertyAxiomsForSubProperty(subProperty));
}
/**
* Gets the {@link OWLSubObjectPropertyOfAxiom} objects where the sub-property is equal to the
* specified property.
*
* @param subProperty The property which is equal to the sub property of the retrieved axioms.
* @return the axioms matching the search.
*/
default Stream objectSubPropertyAxiomsForSubProperty(
OWLObjectPropertyExpression subProperty) {
return axioms(OWLSubObjectPropertyOfAxiom.class, OWLObjectPropertyExpression.class,
subProperty, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLSubObjectPropertyOfAxiom} objects where the super-property is equal to the
* specified property.
*
* @param superProperty The property which is equal to the super-property of the retrieved
* axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getObjectSubPropertyAxiomsForSuperProperty(
OWLObjectPropertyExpression superProperty) {
return asSet(objectSubPropertyAxiomsForSuperProperty(superProperty));
}
/**
* Gets the {@link OWLSubObjectPropertyOfAxiom} objects where the super-property is equal to the
* specified property.
*
* @param superProperty The property which is equal to the super-property of the retrieved
* axioms.
* @return the axioms matching the search.
*/
default Stream objectSubPropertyAxiomsForSuperProperty(
OWLObjectPropertyExpression superProperty) {
return axioms(OWLSubObjectPropertyOfAxiom.class, OWLObjectPropertyExpression.class,
superProperty, EXCLUDED, IN_SUPER_POSITION);
}
/**
* Gets the {@link OWLObjectPropertyDomainAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getObjectPropertyDomainAxioms(
OWLObjectPropertyExpression property) {
return asSet(objectPropertyDomainAxioms(property));
}
/**
* Gets the {@link OWLObjectPropertyDomainAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search.
*/
default Stream objectPropertyDomainAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLObjectPropertyDomainAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLObjectPropertyRangeAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getObjectPropertyRangeAxioms(
OWLObjectPropertyExpression property) {
return asSet(objectPropertyRangeAxioms(property));
}
/**
* Gets the {@link OWLObjectPropertyRangeAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search.
*/
default Stream objectPropertyRangeAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLObjectPropertyRangeAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLInverseObjectPropertiesAxiom} objects where the specified property is
* contained in the set returned by {@link OWLInverseObjectPropertiesAxiom#properties()} .
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getInverseObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(inverseObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLInverseObjectPropertiesAxiom} objects where the specified property is
* contained in the stream returned by {@link OWLInverseObjectPropertiesAxiom#properties()} .
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search.
*/
default Stream inverseObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLInverseObjectPropertiesAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLEquivalentObjectPropertiesAxiom} objects that make the specified property
* equivalent to some other object property expression(s).
*
* @param property The property that the retrieved axioms make equivalent to some other property
* expressions.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getEquivalentObjectPropertiesAxioms(
OWLObjectPropertyExpression property) {
return asSet(equivalentObjectPropertiesAxioms(property));
}
/**
* Gets the {@link OWLEquivalentObjectPropertiesAxiom} objects that make the specified property
* equivalent to some other object property expression(s).
*
* @param property The property that the retrieved axioms make equivalent to some other property
* expressions.
* @return the axioms matching the search.
*/
default Stream equivalentObjectPropertiesAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLEquivalentObjectPropertiesAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLDisjointObjectPropertiesAxiom} objects that make the specified property
* disjoint with some other object property expression(s).
*
* @param property The property that the retrieved axioms makes disjoint to some other property
* expressions.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDisjointObjectPropertiesAxioms(
OWLObjectPropertyExpression property) {
return asSet(disjointObjectPropertiesAxioms(property));
}
/**
* Gets the {@link OWLDisjointObjectPropertiesAxiom} objects that make the specified property
* disjoint with some other object property expression(s).
*
* @param property The property that the retrieved axioms makes disjoint to some other property
* expressions.
* @return the axioms matching the search.
*/
default Stream disjointObjectPropertiesAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLDisjointObjectPropertiesAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLFunctionalObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property functional.
*
* @param property The property that is made functional by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getFunctionalObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(functionalObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLFunctionalObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property functional.
*
* @param property The property that is made functional by the axioms.
* @return the axioms matching the search.
*/
default Stream functionalObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLFunctionalObjectPropertyAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLInverseFunctionalObjectPropertyAxiom} objects contained in this ontology
* that make the specified object property inverse functional.
*
* @param property The property that is made inverse functional by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getInverseFunctionalObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(inverseFunctionalObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLInverseFunctionalObjectPropertyAxiom} objects contained in this ontology
* that make the specified object property inverse functional.
*
* @param property The property that is made inverse functional by the axioms.
* @return the axioms matching the search.
*/
default Stream inverseFunctionalObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLInverseFunctionalObjectPropertyAxiom.class,
OWLObjectPropertyExpression.class, property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLSymmetricObjectPropertyAxiom} objects contained in this ontology that make
* the specified object property symmetric.
*
* @param property The property that is made symmetric by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getSymmetricObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(symmetricObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLSymmetricObjectPropertyAxiom} objects contained in this ontology that make
* the specified object property symmetric.
*
* @param property The property that is made symmetric by the axioms.
* @return the axioms matching the search.
*/
default Stream symmetricObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLSymmetricObjectPropertyAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLAsymmetricObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property asymmetric.
*
* @param property The property that is made asymmetric by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getAsymmetricObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(asymmetricObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLAsymmetricObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property asymmetric.
*
* @param property The property that is made asymmetric by the axioms.
* @return the axioms matching the search.
*/
default Stream asymmetricObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLAsymmetricObjectPropertyAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLReflexiveObjectPropertyAxiom} objects contained in this ontology that make
* the specified object property reflexive.
*
* @param property The property that is made reflexive by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getReflexiveObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(reflexiveObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLReflexiveObjectPropertyAxiom} objects contained in this ontology that make
* the specified object property reflexive.
*
* @param property The property that is made reflexive by the axioms.
* @return the axioms matching the search.
*/
default Stream reflexiveObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLReflexiveObjectPropertyAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLIrreflexiveObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property irreflexive.
*
* @param property The property that is made irreflexive by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getIrreflexiveObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(irreflexiveObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLIrreflexiveObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property irreflexive.
*
* @param property The property that is made irreflexive by the axioms.
* @return the axioms matching the search.
*/
default Stream irreflexiveObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLIrreflexiveObjectPropertyAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLTransitiveObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property transitive.
*
* @param property The property that is made transitive by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getTransitiveObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return asSet(transitiveObjectPropertyAxioms(property));
}
/**
* Gets the {@link OWLTransitiveObjectPropertyAxiom} objects contained in this ontology that
* make the specified object property transitive.
*
* @param property The property that is made transitive by the axioms.
* @return the axioms matching the search.
*/
default Stream transitiveObjectPropertyAxioms(
OWLObjectPropertyExpression property) {
return axioms(OWLTransitiveObjectPropertyAxiom.class, OWLObjectPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
// Data properties
/**
* Gets the {@link OWLSubDataPropertyOfAxiom} objects where the sub-property is equal to the
* specified property.
*
* @param subProperty The property which is equal to the sub property of the retrieved axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDataSubPropertyAxiomsForSubProperty(
OWLDataProperty subProperty) {
return asSet(dataSubPropertyAxiomsForSubProperty(subProperty));
}
/**
* Gets the {@link OWLSubDataPropertyOfAxiom} objects where the sub-property is equal to the
* specified property.
*
* @param subProperty The property which is equal to the sub property of the retrieved axioms.
* @return the axioms matching the search.
*/
default Stream dataSubPropertyAxiomsForSubProperty(
OWLDataProperty subProperty) {
return axioms(OWLSubDataPropertyOfAxiom.class, OWLDataPropertyExpression.class, subProperty,
EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLSubDataPropertyOfAxiom} objects where the super-property is equal to the
* specified property.
*
* @param superProperty The property which is equal to the super-property of the retrieved
* axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDataSubPropertyAxiomsForSuperProperty(
OWLDataPropertyExpression superProperty) {
return asSet(dataSubPropertyAxiomsForSuperProperty(superProperty));
}
/**
* Gets the {@link OWLSubDataPropertyOfAxiom} objects where the super-property is equal to the
* specified property.
*
* @param superProperty The property which is equal to the super-property of the retrieved
* axioms.
* @return the axioms matching the search.
*/
default Stream dataSubPropertyAxiomsForSuperProperty(
OWLDataPropertyExpression superProperty) {
return axioms(OWLSubDataPropertyOfAxiom.class, OWLDataPropertyExpression.class,
superProperty, EXCLUDED, IN_SUPER_POSITION);
}
/**
* Gets the {@link OWLDataPropertyDomainAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDataPropertyDomainAxioms(OWLDataProperty property) {
return asSet(dataPropertyDomainAxioms(property));
}
/**
* Gets the {@link OWLDataPropertyDomainAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search.
*/
default Stream dataPropertyDomainAxioms(OWLDataProperty property) {
return axioms(OWLDataPropertyDomainAxiom.class, OWLDataPropertyExpression.class, property,
EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLDataPropertyRangeAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDataPropertyRangeAxioms(OWLDataProperty property) {
return asSet(dataPropertyRangeAxioms(property));
}
/**
* Gets the {@link OWLDataPropertyRangeAxiom} objects where the property is equal to the
* specified property.
*
* @param property The property which is equal to the property of the retrieved axioms.
* @return the axioms matching the search.
*/
default Stream dataPropertyRangeAxioms(OWLDataProperty property) {
return axioms(OWLDataPropertyRangeAxiom.class, OWLDataPropertyExpression.class, property,
EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLEquivalentDataPropertiesAxiom} objects that make the specified property
* equivalent to some other data property expression(s).
*
* @param property The property that the retrieved axioms make equivalent to some other property
* expressions.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getEquivalentDataPropertiesAxioms(
OWLDataProperty property) {
return asSet(equivalentDataPropertiesAxioms(property));
}
/**
* Gets the {@link OWLEquivalentDataPropertiesAxiom} objects that make the specified property
* equivalent to some other data property expression(s).
*
* @param property The property that the retrieved axioms make equivalent to some other property
* expressions.
* @return the axioms matching the search.
*/
default Stream equivalentDataPropertiesAxioms(
OWLDataProperty property) {
return axioms(OWLEquivalentDataPropertiesAxiom.class, OWLDataPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLDisjointDataPropertiesAxiom} objects that make the specified property
* disjoint with some other data property expression(s).
*
* @param property The property that the retrieved axioms makes disjoint to some other property
* expressions.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDisjointDataPropertiesAxioms(
OWLDataProperty property) {
return asSet(disjointDataPropertiesAxioms(property));
}
/**
* Gets the {@link OWLDisjointDataPropertiesAxiom} objects that make the specified property
* disjoint with some other data property expression(s).
*
* @param property The property that the retrieved axioms makes disjoint to some other property
* expressions.
* @return the axioms matching the search.
*/
default Stream disjointDataPropertiesAxioms(
OWLDataProperty property) {
return axioms(OWLDisjointDataPropertiesAxiom.class, OWLDataPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLFunctionalDataPropertyAxiom} objects contained in this ontology that make
* the specified data property functional.
*
* @param property The property that is made functional by the axioms.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getFunctionalDataPropertyAxioms(
OWLDataPropertyExpression property) {
return asSet(functionalDataPropertyAxioms(property));
}
/**
* Gets the {@link OWLFunctionalDataPropertyAxiom} objects contained in this ontology that make
* the specified data property functional.
*
* @param property The property that is made functional by the axioms.
* @return the axioms matching the search.
*/
default Stream functionalDataPropertyAxioms(
OWLDataPropertyExpression property) {
return axioms(OWLFunctionalDataPropertyAxiom.class, OWLDataPropertyExpression.class,
property, EXCLUDED, IN_SUB_POSITION);
}
// Individuals
/**
* Gets the {@link OWLClassAssertionAxiom} objects contained in this ontology that make the
* specified {@code individual} an instance of some class expression.
*
* @param individual The individual that the returned axioms make an instance of some class
* expression.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getClassAssertionAxioms(OWLIndividual individual) {
return asSet(classAssertionAxioms(individual));
}
/**
* Gets the {@link OWLClassAssertionAxiom} objects contained in this ontology that make the
* specified {@code individual} an instance of some class expression.
*
* @param individual The individual that the returned axioms make an instance of some class
* expression.
* @return the axioms matching the search.
*/
default Stream classAssertionAxioms(OWLIndividual individual) {
return axioms(OWLClassAssertionAxiom.class, OWLIndividual.class, individual, EXCLUDED,
IN_SUB_POSITION);
}
/**
* Gets the {@link OWLClassAssertionAxiom} objects contained in this ontology that make the
* specified class expression, {@code ce}, a type for some individual.
*
* @param ce The class expression that the returned axioms make a type for some individual.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getClassAssertionAxioms(OWLClassExpression ce) {
return asSet(classAssertionAxioms(ce));
}
/**
* Gets the {@link OWLClassAssertionAxiom} objects contained in this ontology that make the
* specified class expression, {@code ce}, a type for some individual.
*
* @param ce The class expression that the returned axioms make a type for some individual.
* @return the axioms matching the search.
*/
default Stream classAssertionAxioms(OWLClassExpression ce) {
return axioms(OWLClassAssertionAxiom.class, OWLClassExpression.class, ce, EXCLUDED,
IN_SUB_POSITION);
}
/**
* Gets the {@link OWLDataPropertyAssertionAxiom} objects contained in this ontology that have
* the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDataPropertyAssertionAxioms(
OWLIndividual individual) {
return asSet(dataPropertyAssertionAxioms(individual));
}
/**
* Gets the {@link OWLDataPropertyAssertionAxiom} objects contained in this ontology that have
* the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search.
*/
default Stream dataPropertyAssertionAxioms(
OWLIndividual individual) {
return axioms(OWLDataPropertyAssertionAxiom.class, OWLIndividual.class, individual,
EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLObjectPropertyAssertionAxiom} objects contained in this ontology that have
* the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getObjectPropertyAssertionAxioms(
OWLIndividual individual) {
return asSet(objectPropertyAssertionAxioms(individual));
}
/**
* Gets the {@link OWLObjectPropertyAssertionAxiom} objects contained in this ontology that have
* the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search.
*/
default Stream objectPropertyAssertionAxioms(
OWLIndividual individual) {
return axioms(OWLObjectPropertyAssertionAxiom.class, OWLIndividual.class, individual,
EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLNegativeObjectPropertyAssertionAxiom} objects contained in this ontology
* that have the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getNegativeObjectPropertyAssertionAxioms(
OWLIndividual individual) {
return asSet(negativeObjectPropertyAssertionAxioms(individual));
}
/**
* Gets the {@link OWLNegativeObjectPropertyAssertionAxiom} objects contained in this ontology
* that have the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search.
*/
default Stream negativeObjectPropertyAssertionAxioms(
OWLIndividual individual) {
return axioms(OWLNegativeObjectPropertyAssertionAxiom.class, OWLIndividual.class,
individual, EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLNegativeDataPropertyAssertionAxiom} objects contained in this ontology
* that have the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getNegativeDataPropertyAssertionAxioms(
OWLIndividual individual) {
return asSet(negativeDataPropertyAssertionAxioms(individual));
}
/**
* Gets the {@link OWLNegativeDataPropertyAssertionAxiom} objects contained in this ontology
* that have the specified {@code individual} as the subject of the axiom.
*
* @param individual The individual that the returned axioms have as a subject.
* @return the axioms matching the search.
*/
default Stream negativeDataPropertyAssertionAxioms(
OWLIndividual individual) {
return axioms(OWLNegativeDataPropertyAssertionAxiom.class, OWLIndividual.class, individual,
EXCLUDED, IN_SUB_POSITION);
}
/**
* Gets the {@link OWLSameIndividualAxiom} objects contained in this ontology that make the
* specified {@code individual} the same as some other individual.
*
* @param individual The individual that the returned axioms make the same as some other
* individual.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getSameIndividualAxioms(OWLIndividual individual) {
return asSet(sameIndividualAxioms(individual));
}
/**
* Gets the {@link OWLSameIndividualAxiom} objects contained in this ontology that make the
* specified {@code individual} the same as some other individual.
*
* @param individual The individual that the returned axioms make the same as some other
* individual.
* @return the axioms matching the search.
*/
default Stream sameIndividualAxioms(OWLIndividual individual) {
return axioms(OWLSameIndividualAxiom.class, OWLIndividual.class, individual, EXCLUDED,
IN_SUB_POSITION);
}
/**
* Gets the {@link OWLDifferentIndividualsAxiom} objects contained in this ontology that make
* the specified {@code individual} different to some other individual.
*
* @param individual The individual that the returned axioms make the different as some other
* individual.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDifferentIndividualAxioms(
OWLIndividual individual) {
return asSet(differentIndividualAxioms(individual));
}
/**
* Gets the {@link OWLDifferentIndividualsAxiom} objects contained in this ontology that make
* the specified {@code individual} different to some other individual.
*
* @param individual The individual that the returned axioms make the different as some other
* individual.
* @return the axioms matching the search.
*/
default Stream differentIndividualAxioms(
OWLIndividual individual) {
return axioms(OWLDifferentIndividualsAxiom.class, OWLIndividual.class, individual, EXCLUDED,
IN_SUB_POSITION);
}
/**
* Gets the {@link OWLDatatypeDefinitionAxiom} objects contained in this ontology that provide a
* definition for the specified datatype.
*
* @param datatype The datatype for which the returned axioms provide a definition.
* @return the axioms matching the search. The set that is returned is a copy; modifications to
* the returned set will not be reflected in this object.
*/
default Set getDatatypeDefinitions(OWLDatatype datatype) {
return asSet(datatypeDefinitions(datatype));
}
/**
* Gets the {@link OWLDatatypeDefinitionAxiom} objects contained in this ontology that provide a
* definition for the specified datatype.
*
* @param datatype The datatype for which the returned axioms provide a definition.
* @return the axioms matching the search.
*/
Stream datatypeDefinitions(OWLDatatype datatype);
}