org.semanticweb.owlapi.model

Interface SWRLDataFactory

All Known Subinterfaces:

OWLDataFactory

All Known Implementing Classes:

OWLDataFactoryImpl

public interface SWRLDataFactory

An interface to a factory that can create SWRL objects.

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Medical Informatics Group

Method Summary

Modifier and Type	Method and Description
SWRLBuiltInAtom	getSWRLBuiltInAtom(IRI builtInIRI, List<SWRLDArgument> args) Creates a SWRL Built-In atom.
SWRLClassAtom	getSWRLClassAtom(OWLClassExpression predicate, SWRLIArgument arg) Gets a SWRL atom where the predicate is a class expression i.e.
SWRLDataPropertyAtom	getSWRLDataPropertyAtom(OWLDataPropertyExpression property, SWRLIArgument arg0, SWRLDArgument arg1) Gets a SWRL data property atom, i.e.
SWRLDataRangeAtom	getSWRLDataRangeAtom(OWLDataRange predicate, SWRLDArgument arg) Gets a SWRL atom where the predicate is a data range, i.e.
SWRLDifferentIndividualsAtom	getSWRLDifferentIndividualsAtom(SWRLIArgument arg0, SWRLIArgument arg1)
SWRLIndividualArgument	getSWRLIndividualArgument(OWLIndividual individual) Gets a SWRLIndividualArgument, which is used to wrap and OWLIndividual as an argument for an atom.
SWRLLiteralArgument	getSWRLLiteralArgument(OWLLiteral literal) Gets a SWRLLiteralArgument, which is used to wrap an OWLLiteral to provide an argument for an atom.
SWRLObjectPropertyAtom	getSWRLObjectPropertyAtom(OWLObjectPropertyExpression property, SWRLIArgument arg0, SWRLIArgument arg1) Gets a SWRL object property atom, i.e.
SWRLRule	getSWRLRule(Set<? extends SWRLAtom> body, Set<? extends SWRLAtom> head) Gets an anonymous SWRL Rule.
SWRLRule	getSWRLRule(Set<? extends SWRLAtom> body, Set<? extends SWRLAtom> head, Set<OWLAnnotation> annotations) Gets an anonymous SWRL Rule.
SWRLSameIndividualAtom	getSWRLSameIndividualAtom(SWRLIArgument arg0, SWRLIArgument arg1)
SWRLVariable	getSWRLVariable(IRI var) Gets a SWRLVariable.

Method Detail

getSWRLRule

@Nonnull
SWRLRule getSWRLRule(@Nonnull
                              Set<? extends SWRLAtom> body,
                              @Nonnull
                              Set<? extends SWRLAtom> head)

Gets an anonymous SWRL Rule.

Parameters:

body - The atoms that make up the body

head - The atoms that make up the head

Returns:

An anonymous rule with the specified body and head

getSWRLRule

@Nonnull
SWRLRule getSWRLRule(@Nonnull
                              Set<? extends SWRLAtom> body,
                              @Nonnull
                              Set<? extends SWRLAtom> head,
                              @Nonnull
                              Set<OWLAnnotation> annotations)

Gets an anonymous SWRL Rule.

Parameters:

body - The atoms that make up the body

head - The atoms that make up the head

annotations - The annotations for the rule (may be an empty set)

Returns:

An anonymous rule with the specified body and head

getSWRLClassAtom

@Nonnull
SWRLClassAtom getSWRLClassAtom(@Nonnull
                                        OWLClassExpression predicate,
                                        @Nonnull
                                        SWRLIArgument arg)

Gets a SWRL atom where the predicate is a class expression i.e. C(x) where C is a class expression and x is either an individual or a variable for an individual

Parameters:

predicate - The class expression that represents the predicate of the atom

arg - The argument (x)

Returns:

The class atom with the specified class expression predicate and the specified argument.

getSWRLDataRangeAtom

@Nonnull
SWRLDataRangeAtom getSWRLDataRangeAtom(@Nonnull
                                                OWLDataRange predicate,
                                                @Nonnull
                                                SWRLDArgument arg)

Gets a SWRL atom where the predicate is a data range, i.e. D(x) where D is an OWL data range and x is either a literal or variable for a literal

Parameters:

predicate - The data range that represents the predicate of the atom

arg - The argument (x)

Returns:

An atom with the specified data range predicate and the specified argument

getSWRLObjectPropertyAtom

@Nonnull
SWRLObjectPropertyAtom getSWRLObjectPropertyAtom(@Nonnull
                                                          OWLObjectPropertyExpression property,
                                                          @Nonnull
                                                          SWRLIArgument arg0,
                                                          @Nonnull
                                                          SWRLIArgument arg1)

Gets a SWRL object property atom, i.e. P(x, y) where P is an OWL object property (expression) and x and y are are either individuals or variables for individuals.

Parameters:

property - The property (P) representing the atom predicate

arg0 - The first argument (x)

arg1 - The second argument (y)

Returns:

A SWRLObjectPropertyAtom that has the specified predicate and the specified arguments

getSWRLDataPropertyAtom

@Nonnull
SWRLDataPropertyAtom getSWRLDataPropertyAtom(@Nonnull
                                                      OWLDataPropertyExpression property,
                                                      @Nonnull
                                                      SWRLIArgument arg0,
                                                      @Nonnull
                                                      SWRLDArgument arg1)

Gets a SWRL data property atom, i.e. R(x, y) where R is an OWL data property (expression) and x and y are are either literals or variables for literals

Parameters:

property - The property (P) that represents the atom predicate

arg0 - The first argument (x)

arg1 - The second argument (y)

Returns:

A SWRLDataPropertyAtom that has the specified predicate and the specified arguments

getSWRLBuiltInAtom

@Nonnull
SWRLBuiltInAtom getSWRLBuiltInAtom(@Nonnull
                                            IRI builtInIRI,
                                            @Nonnull
                                            List<SWRLDArgument> args)

Creates a SWRL Built-In atom. Builtins have predicates that are identified by IRIs. SWRL provides a core set of builtins, which are described in the OWL API by the SWRLBuiltInsVocabulary.

Parameters:

builtInIRI - The builtin predicate IRI

args - A non-empty set of SWRL Arguments.

Returns:

A SWRLBuiltInAtom whose predicate is identified by the specified builtInIRI and that has the specified arguments

Throws:

IllegalArgumentException - if the list of arguments is empty

getSWRLVariable

@Nonnull
SWRLVariable getSWRLVariable(@Nonnull
                                      IRI var)

Gets a SWRLVariable.

Parameters:

var - The id (IRI) of the variable

Returns:

A SWRLVariable that has the name specified by the IRI

getSWRLIndividualArgument

@Nonnull
SWRLIndividualArgument getSWRLIndividualArgument(@Nonnull
                                                          OWLIndividual individual)

Gets a SWRLIndividualArgument, which is used to wrap and OWLIndividual as an argument for an atom.

Parameters:

individual - The individual that is the object argument

Returns:

A SWRLIndividualArgument that wraps the specified individual

getSWRLLiteralArgument

@Nonnull
SWRLLiteralArgument getSWRLLiteralArgument(@Nonnull
                                                    OWLLiteral literal)

Gets a SWRLLiteralArgument, which is used to wrap an OWLLiteral to provide an argument for an atom.

Parameters:

literal - The constant that is the object argument

Returns:

A SWRLLiteralArgument that wraps the specified literal

getSWRLSameIndividualAtom

@Nonnull
SWRLSameIndividualAtom getSWRLSameIndividualAtom(@Nonnull
                                                          SWRLIArgument arg0,
                                                          @Nonnull
                                                          SWRLIArgument arg1)

Parameters:

arg0 - first individual

arg1 - second individual

Returns:

a sameindividual atom

getSWRLDifferentIndividualsAtom

@Nonnull
SWRLDifferentIndividualsAtom getSWRLDifferentIndividualsAtom(@Nonnull
                                                                      SWRLIArgument arg0,
                                                                      @Nonnull
                                                                      SWRLIArgument arg1)

Parameters:

arg0 - first individual

arg1 - second individual

Returns:

a differentindividual atom