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

All Known Implementing Classes:

DefaultSWRLBridge

public interface SWRLRuleEngineBridge

The SWRL Rule Engine Bridge defines the interface seen by a target implementation of a SWRL rule engine. The implementation uses this interface primarily to infer axioms and to invoke built-ins. Detailed documentation for this mechanism can be found here.

Method Summary

List<SWRLBuiltInAtomReference>	getBuiltInAtomsFromBody(SWRLRuleReference query, Set<String> builtInNames)
List<SWRLBuiltInAtomReference>	getBuiltInAtomsFromHead(SWRLRuleReference query, Set<String> builtInNames)
OWLDataFactory	getOWLDataFactory()
OWLDataValueFactory	getOWLDataValueFactory()
PrefixManager	getPrefixManager()
List<SWRLAtomReference>	getSQWRLPhase1BodyAtoms(SWRLRuleReference query)
List<SWRLAtomReference>	getSQWRLPhase2BodyAtoms(SWRLRuleReference query)
void	inferOWLAxiom(OWLAxiomReference axiom) The infer method can be used by a target rule engines to assert axioms that they infer into the bridge.
boolean	invokeSWRLBuiltIn(String ruleURI, String builtInURI, int builtInIndex, boolean isInConsequent, List<BuiltInArgument> arguments) This method can be used by a target rule engines to invoke built-ins.
boolean	isOWLClass(String uri)
boolean	isOWLDataProperty(String uri)
boolean	isOWLIndividual(String uri)
boolean	isOWLObjectProperty(String uri)
boolean	isSQWRLQuery(SWRLRuleReference query)
String	name2URI(String prefixedName)
void	setTargetRuleEngine(TargetSWRLRuleEngine targetRuleEngine)
String	uri2PrefixedName(String uri)
boolean	usesSQWRLCollections(SWRLRuleReference query)

Method Detail

setTargetRuleEngine

void setTargetRuleEngine(TargetSWRLRuleEngine targetRuleEngine)

inferOWLAxiom

void inferOWLAxiom(OWLAxiomReference axiom)
                   throws SWRLRuleEngineBridgeException

The infer method can be used by a target rule engines to assert axioms that they infer into the bridge.

Throws:

SWRLRuleEngineBridgeException

invokeSWRLBuiltIn

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

This method can be used by a target rule engines to invoke built-ins. If the invoked built-in generates an argument binding, the bridge will call the defineBuiltInArgumentBinding method in the target rule engine for each unique binding pattern.

Throws:

SWRLRuleEngineBridgeException

isOWLClass

boolean isOWLClass(String uri)

isOWLObjectProperty

boolean isOWLObjectProperty(String uri)

isOWLDataProperty

boolean isOWLDataProperty(String uri)

isOWLIndividual

boolean isOWLIndividual(String uri)

getOWLDataFactory

OWLDataFactory getOWLDataFactory()

getOWLDataValueFactory

OWLDataValueFactory getOWLDataValueFactory()

isSQWRLQuery

boolean isSQWRLQuery(SWRLRuleReference query)

usesSQWRLCollections

boolean usesSQWRLCollections(SWRLRuleReference query)

getSQWRLPhase1BodyAtoms

List<SWRLAtomReference> getSQWRLPhase1BodyAtoms(SWRLRuleReference query)

getSQWRLPhase2BodyAtoms

List<SWRLAtomReference> getSQWRLPhase2BodyAtoms(SWRLRuleReference query)

getBuiltInAtomsFromHead

List<SWRLBuiltInAtomReference> getBuiltInAtomsFromHead(SWRLRuleReference query,
                                                       Set<String> builtInNames)

getBuiltInAtomsFromBody

List<SWRLBuiltInAtomReference> getBuiltInAtomsFromBody(SWRLRuleReference query,
                                                       Set<String> builtInNames)

uri2PrefixedName

String uri2PrefixedName(String uri)

name2URI

String name2URI(String prefixedName)

getPrefixManager

PrefixManager getPrefixManager()