org.semanticweb.owlapi.model

Interface OWLAxiomCollection

All Superinterfaces:

HasAxioms, HasAxiomsByType, HasContainsAxiom, HasLogicalAxioms

All Known Subinterfaces:

OWLMutableOntology, OWLOntology

public interface OWLAxiomCollection
extends HasAxioms, HasLogicalAxioms, HasAxiomsByType, HasContainsAxiom

Ontology methods related to it being a collection of axioms.

Since:

4.0.0

Author:

ignazio

Method Summary

Modifier and Type	Method and Description
boolean	containsAxiom(OWLAxiom axiom, Imports includeImportsClosure, AxiomAnnotations ignoreAnnotations) Determines if this ontology contains the specified axiom, optionally including the imports closure.
<T extends OWLAxiom> int	getAxiomCount(AxiomType<T> axiomType, Imports includeImportsClosure) Gets the axiom count of a specific type of axiom, optionally including the imports closure.
int	getAxiomCount(Imports includeImportsClosure)
<T extends OWLAxiom> Set<T>	getAxioms(AxiomType<T> axiomType, Imports includeImportsClosure) Gets all axioms of the specified type.
Set<OWLAxiom>	getAxioms(Imports includeImportsClosure)
Set<OWLAnnotationAxiom>	getAxioms(OWLAnnotationProperty property, Imports includeImportsClosure) Gets the axioms that form the definition/description of an annotation property.
Set<OWLClassAxiom>	getAxioms(OWLClass cls, Imports includeImportsClosure) Gets the axioms that form the definition/description of a class.
Set<OWLDataPropertyAxiom>	getAxioms(OWLDataProperty property, Imports includeImportsClosure) Gets the axioms that form the definition/description of a data property.
Set<OWLDatatypeDefinitionAxiom>	getAxioms(OWLDatatype datatype, Imports includeImportsClosure) Gets the datatype definition axioms for the specified datatype.
Set<OWLIndividualAxiom>	getAxioms(OWLIndividual individual, Imports includeImportsClosure) Gets the axioms that form the definition/description of an individual.
Set<OWLObjectPropertyAxiom>	getAxioms(OWLObjectPropertyExpression property, Imports includeImportsClosure) Gets the axioms that form the definition/description of an object property.
Set<OWLAxiom>	getAxiomsIgnoreAnnotations(OWLAxiom axiom, Imports includeImportsClosure) Gets the set of axioms contained in this collection that have the same "logical structure" as the specified axiom; i.e., all axioms that equal the specified axiom, when ignoring annotations.
int	getLogicalAxiomCount(Imports includeImportsClosure) Gets the number of logical axioms in this collection, optionally including the imports closure.
Set<OWLLogicalAxiom>	getLogicalAxioms(Imports includeImportsClosure) Gets all axioms semantically relevant, i.e., all axioms that are not annotation axioms or declaration axioms.
Set<OWLAxiom>	getReferencingAxioms(OWLPrimitive owlEntity, Imports includeImportsClosure) Gets the axioms where the specified OWLPrimitive appears in the signature of the axiom. Note that currently signatures contain OWLEntity only.

Methods inherited from interface org.semanticweb.owlapi.model.HasAxioms

getAxioms

Methods inherited from interface org.semanticweb.owlapi.model.HasLogicalAxioms

getLogicalAxioms

Methods inherited from interface org.semanticweb.owlapi.model.HasAxiomsByType

getAxioms

Methods inherited from interface org.semanticweb.owlapi.model.HasContainsAxiom

containsAxiom

Method Detail

getAxioms

@Nonnull
Set<OWLAxiom> getAxioms(@Nonnull
                                 Imports includeImportsClosure)

Parameters:

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

All of the axioms in this collection, and optionally in the import closure. The set that is returned is a copy of the data.

getAxiomCount

int getAxiomCount(@Nonnull
                  Imports includeImportsClosure)

Parameters:

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

The number of axioms in this ontology, and optionally in the imports closure.

getLogicalAxioms

@Nonnull
Set<OWLLogicalAxiom> getLogicalAxioms(@Nonnull
                                               Imports includeImportsClosure)

Gets all axioms semantically relevant, i.e., all axioms that are not annotation axioms or declaration axioms.

Parameters:

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

A set of axioms which are of type OWLLogicalAxiom, optionally including the imports closure. The set that is returned is a copy of the data.

getLogicalAxiomCount

int getLogicalAxiomCount(@Nonnull
                         Imports includeImportsClosure)

Gets the number of logical axioms in this collection, optionally including the imports closure.

Parameters:

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

The number of axioms in this collection, optionally including the imports closure.

getAxioms

@Nonnull
<T extends OWLAxiom> Set<T> getAxioms(@Nonnull
                                               AxiomType<T> axiomType,
                                               @Nonnull
                                               Imports includeImportsClosure)

Gets all axioms of the specified type.

Type Parameters:

T - axiom type

Parameters:

axiomType - The type of axioms to be retrived.

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

all axioms of the specified type. The set is a copy of the data.

getAxiomCount

<T extends OWLAxiom> int getAxiomCount(@Nonnull
                                       AxiomType<T> axiomType,
                                       @Nonnull
                                       Imports includeImportsClosure)

Gets the axiom count of a specific type of axiom, optionally including the imports closure.

Type Parameters:

T - axiom type

Parameters:

axiomType - The type of axiom to count

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

The number of the specified types of axioms in this collection

containsAxiom

boolean containsAxiom(@Nonnull
                      OWLAxiom axiom,
                      @Nonnull
                      Imports includeImportsClosure,
                      @Nonnull
                      AxiomAnnotations ignoreAnnotations)

Determines if this ontology contains the specified axiom, optionally including the imports closure.

Parameters:

axiom - The axiom to search.

includeImportsClosure - if INCLUDED, include imports closure.

ignoreAnnotations - if IGNORE_ANNOTATIONS, annotations are ignored when searching for the axiom. For example, if the collection contains SubClassOf(Annotation(p V) A B) then this method will return true if the ontology contains SubClassOf(A B) or SubClassOf(Annotation(q S) A B) for any annotation property q and any annotation value S.

Returns:

true if the ontology contains the specified axiom.

getAxiomsIgnoreAnnotations

@Nonnull
Set<OWLAxiom> getAxiomsIgnoreAnnotations(@Nonnull
                                                  OWLAxiom axiom,
                                                  @Nonnull
                                                  Imports includeImportsClosure)

Gets the set of axioms contained in this collection that have the same "logical structure" as the specified axiom; i.e., all axioms that equal the specified axiom, when ignoring annotations. Optionally the imports closure is included.

Parameters:

axiom - The axiom that the returned axioms must equal, ignoring annotations.

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

The set of axioms such that for any two axioms, axiomA and axiomB in the set, axiomA.getAxiomWithoutAnnotations() is equal to axiomB.getAxiomWithoutAnnotations(). The specified axiom will be contained in the set.

getReferencingAxioms

@Nonnull
Set<OWLAxiom> getReferencingAxioms(@Nonnull
                                            OWLPrimitive owlEntity,
                                            @Nonnull
                                            Imports includeImportsClosure)

Gets the axioms where the specified OWLPrimitive appears in the signature of the axiom.
Note that currently signatures contain OWLEntity only. This method accepts OWLPrimitive so that also anonymous individuals, literals, IRIs and annotation values can be passed in, although they are not included in the axioms' signatures.

Parameters:

owlEntity - The entity that should be directly referred to by all axioms in the results set.

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

All axioms referencing the entity. The set is a copy of the data.

getAxioms

@Nonnull
Set<OWLClassAxiom> getAxioms(@Nonnull
                                      OWLClass cls,
                                      @Nonnull
                                      Imports includeImportsClosure)

Gets the axioms that form the definition/description of a class.

Parameters:

cls - The class whose describing axioms are to be retrieved.

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

A set of class axioms that describe the class. This set includes

• Subclass axioms where the subclass is equal to the specified class
• Equivalent class axioms where the specified class is an operand in the equivalent class axiom
• Disjoint class axioms where the specified class is an operand in the disjoint class axiom
• Disjoint union axioms, where the specified class is the named class that is equivalent to the disjoint union

The returned set is a copy of the data.

getAxioms

@Nonnull
Set<OWLObjectPropertyAxiom> getAxioms(@Nonnull
                                               OWLObjectPropertyExpression property,
                                               @Nonnull
                                               Imports includeImportsClosure)

Gets the axioms that form the definition/description of an object property.

Parameters:

property - The property whose defining axioms are to be retrieved.

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

A set of object property axioms that includes

• Sub-property axioms where the sub property is the specified property
• Equivalent property axioms where the axiom contains the specified property
• Equivalent property axioms that contain the inverse of the specified property
• Disjoint property axioms that contain the specified property
• Domain axioms that specify a domain of the specified property
• Range axioms that specify a range of the specified property
• Any property characteristic axiom (i.e. Functional, Symmetric, Reflexive etc.) whose subject is the specified property
• Inverse properties axioms that contain the specified property

The set that is returned is a copy of the data.

getAxioms

@Nonnull
Set<OWLDataPropertyAxiom> getAxioms(@Nonnull
                                             OWLDataProperty property,
                                             @Nonnull
                                             Imports includeImportsClosure)

Gets the axioms that form the definition/description of a data property.

Parameters:

property - The property whose defining axioms are to be retrieved.

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

A set of data property axioms that includes

• Sub-property axioms where the sub property is the specified property
• Equivalent property axioms where the axiom contains the specified property
• Disjoint property axioms that contain the specified property
• Domain axioms that specify a domain of the specified property
• Range axioms that specify a range of the specified property
• Any property characteristic axiom (i.e. Functional, Symmetric, Reflexive etc.) whose subject is the specified property

The set is a copy of the data.

getAxioms

@Nonnull
Set<OWLIndividualAxiom> getAxioms(@Nonnull
                                           OWLIndividual individual,
                                           @Nonnull
                                           Imports includeImportsClosure)

Gets the axioms that form the definition/description of an individual.

Parameters:

individual - The individual whose defining axioms are to be retrieved.

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

A set of individual axioms that includes

• Individual type assertions that assert the type of the specified individual
• Same individuals axioms that contain the specified individual
• Different individuals axioms that contain the specified individual
• Object property assertion axioms whose subject is the specified individual
• Data property assertion axioms whose subject is the specified individual
• Negative object property assertion axioms whose subject is the specified individual
• Negative data property assertion axioms whose subject is the specified individual

The set is a copy of the data.

getAxioms

@Nonnull
Set<OWLAnnotationAxiom> getAxioms(@Nonnull
                                           OWLAnnotationProperty property,
                                           @Nonnull
                                           Imports includeImportsClosure)

Gets the axioms that form the definition/description of an annotation property.

Parameters:

property - The property whose definition axioms are to be retrieved

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

A set of axioms that includes

• Annotation subpropertyOf axioms where the specified property is the sub property
• Annotation property domain axioms that specify a domain for the specified property
• Annotation property range axioms that specify a range for the specified property

The set is a copy of the data.

getAxioms

@Nonnull
Set<OWLDatatypeDefinitionAxiom> getAxioms(@Nonnull
                                                   OWLDatatype datatype,
                                                   @Nonnull
                                                   Imports includeImportsClosure)

Gets the datatype definition axioms for the specified datatype.

Parameters:

datatype - The datatype

includeImportsClosure - if INCLUDED, include imports closure.

Returns:

The set of datatype definition axioms for the specified datatype. The set is a copy of the data.