org.semanticweb.owlapi.model

Interface OWLNaryClassAxiom

All Superinterfaces:

Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnnotations, HasAnonymousIndividuals, HasClassesInSignature, HasComponents, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasHashIndex, HasIndex, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasOperands<OWLClassExpression>, HasSignature, IsAnonymous, OWLAxiom, OWLClassAxiom, OWLLogicalAxiom, OWLNaryAxiom<OWLClassExpression>, OWLObject, OWLSubClassOfAxiomSetShortCut, Serializable

All Known Subinterfaces:

OWLDisjointClassesAxiom, OWLEquivalentClassesAxiom

All Known Implementing Classes:

OWLDisjointClassesAxiomImpl, OWLEquivalentClassesAxiomImpl, OWLNaryClassAxiomImpl

public interface OWLNaryClassAxiom
extends OWLClassAxiom, OWLNaryAxiom<OWLClassExpression>, OWLSubClassOfAxiomSetShortCut, HasOperands<OWLClassExpression>

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

Method Summary

Modifier and Type	Method and Description
Stream<OWLClassExpression>	classExpressions() Gets all of the top level class expressions that appear in this axiom.
default Stream<?>	components()
default Stream<?>	componentsAnnotationsFirst()
default Stream<?>	componentsWithoutAnnotations()
boolean	contains(OWLClassExpression ce) Determines if this class axiom contains the specified class expression as an operand.
default Set<OWLClassExpression>	getClassExpressions() Gets all of the top level class expressions that appear in this axiom.
default List<OWLClassExpression>	getClassExpressionsAsList() Deprecated. use HasOperands.getOperandsAsList()
Set<OWLClassExpression>	getClassExpressionsMinus(OWLClassExpression... desc) Gets the set of class expressions that appear in this axiom minus the specified class expressions.
default int	initHashCode()
default Stream<OWLClassExpression>	operands() Gets the operands - e.g., the individuals in a sameAs axiom, or the classes in an equivalent classes axiom.

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

isLogicalAxiom

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, isOfType, isOfType, isOfType, typeIndex

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

accept, accept, getNestedClassExpressions, hashIteration, hasSharedStructure, 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.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.OWLNaryAxiom

allMatch, allMatchAllPairs, anyMatch, anyMatchAllPairs, asPairwiseAxioms, forEach, forEachAllPairs, splitToAnnotatedPairs, walkAllPairwise, walkPairwise

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

getOperandsAsList

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

asOWLSubClassOfAxioms

Method Detail

components

default Stream<?> components()

Specified by:

components in interface HasComponents

Returns:

components as a stream. The stream is ordered (by visit order) but not sorted. Implementations that override components() must ensure the order is compatible with equals() and hashCode().

initHashCode

default int initHashCode()

Specified by:

initHashCode in interface OWLObject

Returns:

hash code for the object; called on first use, cached by OWLObjectImpl in the default implementation.

componentsWithoutAnnotations

default Stream<?> componentsWithoutAnnotations()

Specified by:

componentsWithoutAnnotations in interface HasComponents

Returns:

components as a stream; for objects that can have annotations on them, these are skipped. This is useful for comparing axioms without taking annotations into account. Note: annotations on nested objects are not affected. The stream is ordered (by visit order) but not sorted. Implementations that override components() must ensure the order is compatible with equals() and hashCode().

componentsAnnotationsFirst

default Stream<?> componentsAnnotationsFirst()

Specified by:

componentsAnnotationsFirst in interface HasComponents

Returns:

components as a stream; for objects that can have annotations on them, annotation streams appear first. This is useful in renderers. The stream is ordered (by visit order) but not sorted. Implementations that override components() must ensure the order is compatible with equals() and hashCode().

getClassExpressions

default Set<OWLClassExpression> getClassExpressions()

Gets all of the top level class expressions that appear in this axiom.

Returns:

A Set of class expressions that appear in the axiom. The set that is returned is a copy; modifications to the returned set will not be reflected in this object.

classExpressions

Stream<OWLClassExpression> classExpressions()

Gets all of the top level class expressions that appear in this axiom.

Returns:

Sorted stream of class expressions that appear in the axiom.

operands

default Stream<OWLClassExpression> 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<OWLClassExpression>

Specified by:

operands in interface OWLNaryAxiom<OWLClassExpression>

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.

getClassExpressionsAsList

@Deprecated
default List<OWLClassExpression> getClassExpressionsAsList()

Deprecated. use HasOperands.getOperandsAsList()

A convenience method that obtains the class expression returned by the getClassExpressions() method as a list of class expressions.

Returns:

A list of the class expressions in this axiom.

contains

boolean contains(OWLClassExpression ce)

Determines if this class axiom contains the specified class expression as an operand.

Parameters:

ce - The class expression to test for

Returns:

true if this axiom contains the specified class expression as an operand, otherwise false.

getClassExpressionsMinus

Set<OWLClassExpression> getClassExpressionsMinus(OWLClassExpression... desc)

Gets the set of class expressions that appear in this axiom minus the specified class expressions.

Parameters:

desc - The class expressions to subtract from the class expressions in this axiom

Returns:

A set containing all of the class expressions in this axiom (the class expressions returned by getClassExpressions()) minus the specified list of class expressions