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

public interface TargetSWRLRuleEngine

This interface defines the methods that must be provided by an implementation of a SWRL rule engine.

A rule engine can communicate with the bridge using the SWRLRuleEngineBridge interface. The engine can use the bridge to, for example, infer axioms or to invoke built-ins.

Detailed documentation for this mechanism can be found here.

Method Summary

void	defineBuiltInArgumentBinding(String ruleName, String builtInName, int builtInIndex, List<BuiltInArgument> arguments) Define a rule engine representation of one set of the arguments generated by a built-in that binds one or more of its arguments.
void	defineOWLAxiom(OWLAxiomReference axiom) Define a target rule engine representation of an OWL axiom.
String	getName()
String	getVersion()
void	initialize(SWRLRuleEngineBridge bridge) Initialize the target engine.
void	resetRuleEngine() Reset the rule engine.
void	runRuleEngine() Run the rule engine.

Method Detail

getName

String getName()

getVersion

String getVersion()

initialize

void initialize(SWRLRuleEngineBridge bridge)
                throws TargetSWRLRuleEngineException

Initialize the target engine. Supply it with the bridge.

Throws:

TargetSWRLRuleEngineException

resetRuleEngine

void resetRuleEngine()
                     throws TargetSWRLRuleEngineException

Reset the rule engine.

Throws:

TargetSWRLRuleEngineException

runRuleEngine

void runRuleEngine()
                   throws TargetSWRLRuleEngineException

Run the rule engine.

Throws:

TargetSWRLRuleEngineException

defineOWLAxiom

void defineOWLAxiom(OWLAxiomReference axiom)
                    throws TargetSWRLRuleEngineException

Define a target rule engine representation of an OWL axiom. SWRL rules are a type of OWL axiom.

Throws:

TargetSWRLRuleEngineException

defineBuiltInArgumentBinding

void defineBuiltInArgumentBinding(String ruleName,
                                  String builtInName,
                                  int builtInIndex,
                                  List<BuiltInArgument> arguments)
                                  throws TargetSWRLRuleEngineException

Define a rule engine representation of one set of the arguments generated by a built-in that binds one or more of its arguments.

For example, if tbox:isSubClassOf(?x, Person) is called with unbound argument ?x and Person has subclasses Male and Female then two arguments bindings (Male, Person) and (Female, Person) will be generated by the built-in bridge and passed to this method.

Throws:

TargetSWRLRuleEngineException