edu.stanford.smi.protegex.owl.swrl.bridge.builtins
Class BuiltInLibraryManager

java.lang.Object
  edu.stanford.smi.protegex.owl.swrl.bridge.builtins.BuiltInLibraryManager

public abstract class BuiltInLibraryManager
extends Object

This class manages the dynamic loading of SWRL built-in libraries and the invocation of built-ins in those libraries. A library is identified by a prefix and this prefix is used to find and dynamically load a Java class implementing the built-ins in this library. For example, the core SWRL built-in library is identified by the prefix swrlb; built-ins in this library can then be referred to in SWRL rules using this prefix followed by the built-in name, e.g., swrlb:lessThanOrEqual.

See here for documentation on defining these built-in libraries.

Constructor Summary

BuiltInLibraryManager()

Method Summary

static Set<List<BuiltInArgument>>	generateBuiltInArgumentBindings(String ruleName, String builtInURI, int builtInIndex, List<BuiltInArgument> arguments) This method is called with a list of built-in arguments.
static void	invokeAllBuiltInLibrariesResetMethod(SWRLBuiltInBridge bridge)
static boolean	invokeSWRLBuiltIn(TargetSWRLRuleEngine targetRuleEngine, SWRLBuiltInBridge bridge, String ruleName, String builtInURI, int builtInIndex, boolean isInConsequent, List<BuiltInArgument> arguments) Invoke a SWRL built-in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuiltInLibraryManager

public BuiltInLibraryManager()

Method Detail

invokeSWRLBuiltIn

public static boolean invokeSWRLBuiltIn(TargetSWRLRuleEngine targetRuleEngine,
                                        SWRLBuiltInBridge bridge,
                                        String ruleName,
                                        String builtInURI,
                                        int builtInIndex,
                                        boolean isInConsequent,
                                        List<BuiltInArgument> arguments)
                                 throws BuiltInException

Invoke a SWRL built-in. This method is called from the invokeSWRLBuiltIn method in the bridge and should not be called directly from a rule engine. The built-in name should be the fully qualified name of the built-in (e.g., http://www.w3.org/2003/11/swrlb#lessThanOrEqual).

Throws:

BuiltInException

invokeAllBuiltInLibrariesResetMethod

public static void invokeAllBuiltInLibrariesResetMethod(SWRLBuiltInBridge bridge)
                                                 throws SWRLBuiltInLibraryException

Throws:

SWRLBuiltInLibraryException

generateBuiltInArgumentBindings

public static Set<List<BuiltInArgument>> generateBuiltInArgumentBindings(String ruleName,
                                                                         String builtInURI,
                                                                         int builtInIndex,
                                                                         List<BuiltInArgument> arguments)
                                                                  throws BuiltInException

This method is called with a list of built-in arguments. Some argument positions may contain multi-arguments, indicating that there is more than one pattern. If the result has more than one multi-argument, each multi-argument must have the same number of elements.

Throws:

BuiltInException