edu.stanford.smi.protegex.owl.swrl
Interface SWRLRuleEngine

All Superinterfaces:

SQWRLQueryEngine

All Known Implementing Classes:

DefaultSWRLRuleEngine

public interface SWRLRuleEngine
extends SQWRLQueryEngine

This interface defines methods that must be provided by a SWRL rule engine. Detailed documentation for this mechanism can be found here.

Method Summary

Set<OWLAxiomReference>	getImportedOWLAxioms()
Set<OWLClassReference>	getImportedOWLClasses()
Set<OWLNamedIndividualReference>	getImportedOWLIndividuals()
Set<SWRLRuleReference>	getImportedSWRLRules()
Set<OWLAxiomReference>	getInferredOWLAxioms()
Set<OWLAxiomReference>	getInjectedOWLAxioms()
Set<OWLClassReference>	getInjectedOWLClasses()
Set<OWLNamedIndividualReference>	getInjectedOWLIndividuals()
int	getNumberOfImportedOWLAxioms()
int	getNumberOfImportedOWLClasses()
int	getNumberOfImportedOWLIndividuals()
int	getNumberOfImportedSWRLRules()
int	getNumberOfInferredOWLAxioms()
int	getNumberOfInferredOWLIndividuals()
int	getNumberOfInjectedOWLAxioms()
int	getNumberOfInjectedOWLClasses()
int	getNumberOfInjectedOWLIndividuals()
OWLDataValueFactory	getOWLDataValueFactory()
Set<OWLNamedIndividualReference>	getReclassifiedOWLIndividuals()
String	getTargetRuleEngineName() Returns the name of the underlying targer rule engine.
String	getTargetRuleEngineVersion()
void	importSQWRLQueryAndOWLKnowledge(String queryName) Load specific query, all enabled rules, and relevant knowledge from OWL into bridge.
void	importSWRLRulesAndOWLKnowledge() Load rules and relevant knowledge from OWL into bridge.
void	infer() Load rules and knowledge from OWL into bridge, send them to a rule engine, run the rule engine, and write any inferred knowledge back to OWL.
String	name2URI(String prefixedName)
void	reset() Clear all inferred and injected knowledge from rule engine, deleted asserted knowledge from the bridge, and leave imported bridge knowledge intact.
void	run() Run the rule engine.
String	uri2PrefixedName(String uri)
void	writeInferredKnowledge2OWL() Write knowledge inferred by rule engine back to OWL.

Methods inherited from interface edu.stanford.smi.protegex.owl.swrl.sqwrl.SQWRLQueryEngine

createSQWRLQuery, deleteSQWRLQuery, getSQWRLQueries, getSQWRLQueryNames, getSQWRLResult, runSQWRLQueries, runSQWRLQuery, runSQWRLQuery, runStandaloneSQWRLQuery

Method Detail

infer

void infer()
           throws SWRLRuleEngineException

Load rules and knowledge from OWL into bridge, send them to a rule engine, run the rule engine, and write any inferred knowledge back to OWL.

Throws:

SWRLRuleEngineException

importSWRLRulesAndOWLKnowledge

void importSWRLRulesAndOWLKnowledge()
                                    throws SWRLRuleEngineException

Load rules and relevant knowledge from OWL into bridge. All existing bridge rules and knowledge will first be cleared and the associated rule engine will be reset.

Throws:

SWRLRuleEngineException

importSQWRLQueryAndOWLKnowledge

void importSQWRLQueryAndOWLKnowledge(String queryName)
                                     throws SWRLRuleEngineException

Load specific query, all enabled rules, and relevant knowledge from OWL into bridge. All existing bridge rules and knowledge will first be cleared and the associated rule engine will be reset.

Throws:

SWRLRuleEngineException

run

void run()
         throws SWRLRuleEngineException

Run the rule engine.

Throws:

SWRLRuleEngineException

writeInferredKnowledge2OWL

void writeInferredKnowledge2OWL()
                                throws SWRLRuleEngineException

Write knowledge inferred by rule engine back to OWL.

Throws:

SWRLRuleEngineException

reset

void reset()
           throws SWRLRuleEngineException

Clear all inferred and injected knowledge from rule engine, deleted asserted knowledge from the bridge, and leave imported bridge knowledge intact.

Throws:

SWRLRuleEngineException

getNumberOfImportedSWRLRules

int getNumberOfImportedSWRLRules()

getNumberOfImportedOWLAxioms

int getNumberOfImportedOWLAxioms()

getNumberOfInferredOWLAxioms

int getNumberOfInferredOWLAxioms()

getNumberOfInjectedOWLAxioms

int getNumberOfInjectedOWLAxioms()

getNumberOfImportedOWLClasses

int getNumberOfImportedOWLClasses()

getNumberOfImportedOWLIndividuals

int getNumberOfImportedOWLIndividuals()

getNumberOfInferredOWLIndividuals

int getNumberOfInferredOWLIndividuals()

getNumberOfInjectedOWLClasses

int getNumberOfInjectedOWLClasses()

getNumberOfInjectedOWLIndividuals

int getNumberOfInjectedOWLIndividuals()

getImportedOWLAxioms

Set<OWLAxiomReference> getImportedOWLAxioms()

getInferredOWLAxioms

Set<OWLAxiomReference> getInferredOWLAxioms()

getInjectedOWLAxioms

Set<OWLAxiomReference> getInjectedOWLAxioms()

getImportedSWRLRules

Set<SWRLRuleReference> getImportedSWRLRules()

getImportedOWLClasses

Set<OWLClassReference> getImportedOWLClasses()

getInjectedOWLClasses

Set<OWLClassReference> getInjectedOWLClasses()

getImportedOWLIndividuals

Set<OWLNamedIndividualReference> getImportedOWLIndividuals()

getReclassifiedOWLIndividuals

Set<OWLNamedIndividualReference> getReclassifiedOWLIndividuals()

getInjectedOWLIndividuals

Set<OWLNamedIndividualReference> getInjectedOWLIndividuals()

getTargetRuleEngineName

String getTargetRuleEngineName()

Description copied from interface: SQWRLQueryEngine

Returns the name of the underlying targer rule engine.

Specified by:

getTargetRuleEngineName in interface SQWRLQueryEngine

getTargetRuleEngineVersion

String getTargetRuleEngineVersion()

uri2PrefixedName

String uri2PrefixedName(String uri)

Specified by:

uri2PrefixedName in interface SQWRLQueryEngine

name2URI

String name2URI(String prefixedName)

Specified by:

name2URI in interface SQWRLQueryEngine

getOWLDataValueFactory

OWLDataValueFactory getOWLDataValueFactory()