org.semanticweb.owlapi.model

Interface OWLNaryAxiom<C extends OWLObject>

Type Parameters:

C - class of contained objects

All Superinterfaces:

Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnnotations, HasAnonymousIndividuals, HasClassesInSignature, HasComponents, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasHashIndex, HasIndex, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasOperands<C>, HasSignature, IsAnonymous, OWLAxiom, OWLObject, Serializable

All Known Subinterfaces:

OWLDifferentIndividualsAxiom, OWLDisjointClassesAxiom, OWLDisjointDataPropertiesAxiom, OWLDisjointObjectPropertiesAxiom, OWLEquivalentClassesAxiom, OWLEquivalentDataPropertiesAxiom, OWLEquivalentObjectPropertiesAxiom, OWLInverseObjectPropertiesAxiom, OWLNaryClassAxiom, OWLNaryIndividualAxiom, OWLNaryPropertyAxiom<P>, OWLSameIndividualAxiom

All Known Implementing Classes:

OWLDifferentIndividualsAxiomImpl, OWLDisjointClassesAxiomImpl, OWLDisjointDataPropertiesAxiomImpl, OWLDisjointObjectPropertiesAxiomImpl, OWLEquivalentClassesAxiomImpl, OWLEquivalentDataPropertiesAxiomImpl, OWLEquivalentObjectPropertiesAxiomImpl, OWLInverseObjectPropertiesAxiomImpl, OWLNaryClassAxiomImpl, OWLNaryIndividualAxiomImpl, OWLNaryPropertyAxiomImpl, OWLSameIndividualAxiomImpl

public interface OWLNaryAxiom<C extends OWLObject>
extends OWLAxiom, HasOperands<C>

Represents an axiom that contains two or more operands that could also be represented with multiple pairwise axioms.

Since:

3.0.0

Author:

Matthew Horridge, The University of Manchester, Information Management Group

Method Summary

Modifier and Type	Method and Description
default boolean	allMatch(OWLPairwiseBooleanVisitor<C> visitor)
default boolean	allMatchAllPairs(OWLPairwiseBooleanVisitor<C> visitor)
default boolean	anyMatch(OWLPairwiseBooleanVisitor<C> visitor)
default boolean	anyMatchAllPairs(OWLPairwiseBooleanVisitor<C> visitor)
Collection<? extends OWLNaryAxiom<C>>	asPairwiseAxioms() Gets this axiom as a set of pairwise axioms; if the axiom contains only two operands, the axiom itself is returned unchanged, including its annotations.
default void	forEach(OWLPairwiseVoidVisitor<C> visitor)
default void	forEachAllPairs(OWLPairwiseVoidVisitor<C> visitor)
Stream<C>	operands() Gets the operands - e.g., the individuals in a sameAs axiom, or the classes in an equivalent classes axiom.
Collection<? extends OWLAxiom>	splitToAnnotatedPairs() Splits this axiom to pairs, including annotations.
default <T> Collection<T>	walkAllPairwise(OWLPairwiseVisitor<T,C> visitor)
default <T> Collection<T>	walkPairwise(OWLPairwiseVisitor<T,C> visitor)

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

accept, accept, equalsIgnoreAnnotations, getAnnotatedAxiom, getAnnotatedAxiom, getAnnotatedAxiom, getAnnotatedAxiom, getAnnotatedAxiom, getAxiomType, getAxiomWithoutAnnotations, getAxiomWithoutAnnotations, getAxiomWithoutAnnotations, getNNF, isAnnotated, isAnnotationAxiom, isAxiom, isIndividual, isLogicalAxiom, isOfType, isOfType, isOfType, typeIndex

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

accept, accept, getNestedClassExpressions, hashIteration, hasSharedStructure, initHashCode, isAnonymousExpression, isBottomEntity, isIRI, isOntology, isTopEntity, nestedClassExpressions

Methods inherited from interface java.lang.Comparable

compareTo

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

getSignature, signature, unsortedSignature

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

containsEntityInSignature

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

anonymousIndividuals, getAnonymousIndividuals

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

classesInSignature, getClassesInSignature

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

getObjectPropertiesInSignature, objectPropertiesInSignature

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

dataPropertiesInSignature, getDataPropertiesInSignature

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

getIndividualsInSignature, individualsInSignature

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

datatypesInSignature, getDatatypesInSignature

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

annotationPropertiesInSignature, getAnnotationPropertiesInSignature

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

hashIndex

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

components, componentsAnnotationsFirst, componentsWithoutAnnotations

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

isAnonymous, isNamed

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

annotations, annotations, annotations, annotationsAsList, getAnnotations, getAnnotations

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

getOperandsAsList

Method Detail

operands

Stream<C> operands()

Description copied from interface: HasOperands

Gets the operands - e.g., the individuals in a sameAs axiom, or the classes in an equivalent classes axiom.

Specified by:

operands in interface HasOperands<C extends OWLObject>

Returns:

a stream of all operands for this n-ary axiom. This provides a platform for common operations across different types, e.g., this will be the properties() stream for a DisjointObjectProperties, or a classExpressions() stream for a DisjointClasses.

asPairwiseAxioms

Collection<? extends OWLNaryAxiom<C>> asPairwiseAxioms()

Gets this axiom as a set of pairwise axioms; if the axiom contains only two operands, the axiom itself is returned unchanged, including its annotations. Note that, aside from this exception, annotations on this axiom will not be copied to each axiom returned in the set of pairwise axioms.
Note: This will contain all pairs, i.e., for the set "a, b, c" the pairs "a, b", "a, c", "b, c" will be returned. For some applications, only "a, b", "b, c" are required.

Returns:

This axiom as a set of pairwise axioms.

walkPairwise

default <T> Collection<T> walkPairwise(OWLPairwiseVisitor<T,C> visitor)

Type Parameters:

T - type returned by visitor

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are not ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.

Returns:

collection of all visitor return values that are not null

walkAllPairwise

default <T> Collection<T> walkAllPairwise(OWLPairwiseVisitor<T,C> visitor)

Type Parameters:

T - type returned by visitor

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are ordered, i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.

Returns:

collection of all visitor return values that are not null

forEach

default void forEach(OWLPairwiseVoidVisitor<C> visitor)

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are not ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.

anyMatch

default boolean anyMatch(OWLPairwiseBooleanVisitor<C> visitor)

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are not ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.

Returns:

true if at least one pair evaluation is true

allMatch

default boolean allMatch(OWLPairwiseBooleanVisitor<C> visitor)

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are not ordered, i.e., only (i,j) will be considered, for i!=j; (j, i) is not considered.

Returns:

true if all pairs evaluation is true

forEachAllPairs

default void forEachAllPairs(OWLPairwiseVoidVisitor<C> visitor)

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are ordered, i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.

anyMatchAllPairs

default boolean anyMatchAllPairs(OWLPairwiseBooleanVisitor<C> visitor)

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are ordered, i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.

Returns:

true if at least one pair evaluation is true

allMatchAllPairs

default boolean allMatchAllPairs(OWLPairwiseBooleanVisitor<C> visitor)

Parameters:

visitor - visitor to apply to all pairwise elements in this axiom; pairs are ordered, i.e., (i, j) and (j, i) will be considered. (i,i) is skipped.

Returns:

true if all pairs evaluation is true

splitToAnnotatedPairs

Collection<? extends OWLAxiom> splitToAnnotatedPairs()

Splits this axiom to pairs, including annotations. This method implements the process described at http://www.w3.org/TR/owl2-mapping-to-rdf/# Axioms_that_are_Translated_to_Multiple_Triples which is used, for example, in serializing EquivalentProperty axioms with three operands. Note that annotations on this axiom will be copied to each axiom returned in the set of pairwise axioms. Note: This will contain only the "An, An+1" pairs, i.e., for the set "a, b, c" the pairs "a, b" and "b, c" will be returned, but not "a, c".

Returns:

This axiom as a set of pairwise axioms, annotations included.