edu.stanford.smi.protegex.owl.swrl.bridge
Interface SWRLBuiltInBridge

All Known Implementing Classes:

DefaultSWRLBridge

public interface SWRLBuiltInBridge

The SWRL Built-in Bridge defines the methods seen by built-in implementations at run time. Ideally, built-in implementations should only use this interface to operate on the active ontology. However, some specialized libraries (e.g., abox and tbox) require direct access to the active ontology so will use the provided getOWLModel method. It will be removed shortly. Detailed documentation for the SWRL rule engine bridge mechanism can be found here.

Method Summary

OWLOntology	getActiveOntology()
OWLDataFactory	getOWLDataFactory()
OWLDataValueFactory	getOWLDataValueFactory()
Set<OWLNamedIndividualReference>	getOWLIndividuals()
Set<OWLPropertyAssertionAxiomReference>	getOWLPropertyAssertionAxioms(String individualURI, String propertyURI)
SQWRLResultImpl	getSQWRLUnpreparedResult(String queryURI)
void	injectOWLAxiom(OWLAxiomReference axiom)
OWLClassReference	injectOWLClassDeclaration()
void	injectOWLClassDeclaration(String className)
OWLNamedIndividualReference	injectOWLIndividualDeclaration()
OWLNamedIndividualReference	injectOWLIndividualDeclaration(OWLClassReference owlClass)
void	injectOWLIndividualDeclaration(OWLNamedIndividualReference owlIndividual)
boolean	invokeSWRLBuiltIn(String ruleName, String builtInName, int builtInIndex, boolean isInConsequent, List<BuiltInArgument> arguments)
boolean	isOWLClass(String classURI)
boolean	isOWLDataProperty(String propertyURI)
boolean	isOWLIndividual(String individualURI)
boolean	isOWLIndividualOfClass(String individualURI, String classURI)
boolean	isOWLObjectProperty(String propertyURI)

Method Detail

getActiveOntology

OWLOntology getActiveOntology()

injectOWLAxiom

void injectOWLAxiom(OWLAxiomReference axiom)
                    throws SWRLBuiltInBridgeException

Throws:

SWRLBuiltInBridgeException

injectOWLClassDeclaration

OWLClassReference injectOWLClassDeclaration()
                                            throws SWRLBuiltInBridgeException

Throws:

SWRLBuiltInBridgeException

injectOWLClassDeclaration

void injectOWLClassDeclaration(String className)
                               throws SWRLBuiltInBridgeException

Throws:

SWRLBuiltInBridgeException

injectOWLIndividualDeclaration

OWLNamedIndividualReference injectOWLIndividualDeclaration()
                                                           throws SWRLBuiltInBridgeException

Throws:

SWRLBuiltInBridgeException

injectOWLIndividualDeclaration

void injectOWLIndividualDeclaration(OWLNamedIndividualReference owlIndividual)
                                    throws SWRLBuiltInBridgeException

Throws:

SWRLBuiltInBridgeException

injectOWLIndividualDeclaration

OWLNamedIndividualReference injectOWLIndividualDeclaration(OWLClassReference owlClass)
                                                           throws SWRLBuiltInBridgeException

Throws:

SWRLBuiltInBridgeException

isOWLClass

boolean isOWLClass(String classURI)

isOWLObjectProperty

boolean isOWLObjectProperty(String propertyURI)

isOWLDataProperty

boolean isOWLDataProperty(String propertyURI)

isOWLIndividual

boolean isOWLIndividual(String individualURI)

isOWLIndividualOfClass

boolean isOWLIndividualOfClass(String individualURI,
                               String classURI)

getOWLIndividuals

Set<OWLNamedIndividualReference> getOWLIndividuals()

getOWLPropertyAssertionAxioms

Set<OWLPropertyAssertionAxiomReference> getOWLPropertyAssertionAxioms(String individualURI,
                                                                      String propertyURI)
                                                                      throws SWRLBuiltInBridgeException

Throws:

SWRLBuiltInBridgeException

getSQWRLUnpreparedResult

SQWRLResultImpl getSQWRLUnpreparedResult(String queryURI)
                                         throws SQWRLException

Throws:

SQWRLException

getOWLDataFactory

OWLDataFactory getOWLDataFactory()

getOWLDataValueFactory

OWLDataValueFactory getOWLDataValueFactory()

invokeSWRLBuiltIn

boolean invokeSWRLBuiltIn(String ruleName,
                          String builtInName,
                          int builtInIndex,
                          boolean isInConsequent,
                          List<BuiltInArgument> arguments)
                          throws SWRLRuleEngineBridgeException

Throws:

SWRLRuleEngineBridgeException