org.openksavi.sponge.kb

Interface KnowledgeBaseInterpreter

All Known Subinterfaces:

ScriptKnowledgeBaseInterpreter

public interface KnowledgeBaseInterpreter

Knowledge base interpreter.

Method Summary

Modifier and Type	Method and Description
Plugin	createPluginInstance(String pluginClassName) Creates a plugin instance.
<T extends Processor> T	createProcessorInstance(String processorClassName, Class<T> javaClass) Creates a new processor instance.
ProcessorInstanceHolder	createProcessorInstanceByProcessorClass(KnowledgeBase knowledgeBase, Object processorClass, Class<?> javaClass) Returns the processor new instance holder.
boolean	existsVariable(String name) Returns true if a variable named name exists.
KnowledgeBaseEngineOperations	getEngineOperations() Returns engine operations associated with this knowledge base interpreter.
Throwable	getJavaException(Throwable knowledgeBaseException) Returns a Java exception corresponding to the knowledge base specific exception.
RuleEventSpec	getRuleEventSpec(Object eventSpecEntry) Returns event specification for rule defined in the knowledge base.
String	getScriptKnowledgeBaseProcessorClassName(Object processorClass) Returns script knowledge base processor class name.
String	getSpecificExceptionMessage(Throwable e) Returns the implementation-specific error message or null if no specific message is necessary.
KnowledgeBaseType	getType() Returns knowledge base interpreter type.
Object	getVariable(String name) Returns the value of the variable.
<T> T	getVariable(String name, Class<T> cls) Returns the value of the variable.
Object	invokeMethod(Object target, String name, Object... args) Invokes a method.
boolean	isKnowledgeBaseException(Throwable exception) Verifies if the given exception is a knowledge base specific one.
void	setVariable(String name, Object value) Sets the variable value.

Method Detail

getType

KnowledgeBaseType getType()

Returns knowledge base interpreter type.

Returns:

knowledge base interpreter type.

invokeMethod

Object invokeMethod(Object target,
                    String name,
                    Object... args)

Invokes a method.

Parameters:

target - the processor containing the method to be invoked.

name - method name.

args - method arguments.

Returns:

method result.

setVariable

void setVariable(String name,
                 Object value)

Sets the variable value.

Parameters:

name - variable name.

value - variable value.

getVariable

Object getVariable(String name)

Returns the value of the variable. Throws exception if not found.

Parameters:

name - variable name.

Returns:

variable value.

getVariable

<T> T getVariable(String name,
                  Class<T> cls)

Returns the value of the variable. Throws exception if not found.

Type Parameters:

T - variable.

Parameters:

name - variable name.

cls - variable class.

Returns:

variable value.

existsVariable

boolean existsVariable(String name)

Returns true if a variable named name exists.

Parameters:

name - variable name.

Returns:

true if a variable named name exists.

createProcessorInstance

<T extends Processor> T createProcessorInstance(String processorClassName,
                                                Class<T> javaClass)

Creates a new processor instance.

Type Parameters:

T - processor type.

Parameters:

processorClassName - processor class name.

javaClass - processor class.

Returns:

a new processor instance.

createPluginInstance

Plugin createPluginInstance(String pluginClassName)

Creates a plugin instance.

Parameters:

pluginClassName - a plugin class name.

Returns:

the plugin instance.

getRuleEventSpec

RuleEventSpec getRuleEventSpec(Object eventSpecEntry)

Returns event specification for rule defined in the knowledge base.

Parameters:

eventSpecEntry - event specification entry.

Returns:

event specification.

isKnowledgeBaseException

boolean isKnowledgeBaseException(Throwable exception)

Verifies if the given exception is a knowledge base specific one.

Parameters:

exception - an exception to be verified.

Returns:

is the exception knowledge base specific.

getJavaException

Throwable getJavaException(Throwable knowledgeBaseException)

Returns a Java exception corresponding to the knowledge base specific exception.

Parameters:

knowledgeBaseException - the knowledge base specific exception.

Returns:

Java exception.

getScriptKnowledgeBaseProcessorClassName

String getScriptKnowledgeBaseProcessorClassName(Object processorClass)

Returns script knowledge base processor class name.

Parameters:

processorClass - processor class.

Returns:

script knowledge base processor class name or null if processorClass doesn't represent a script knowledge base processor.

createProcessorInstanceByProcessorClass

ProcessorInstanceHolder createProcessorInstanceByProcessorClass(KnowledgeBase knowledgeBase,
                                                                Object processorClass,
                                                                Class<?> javaClass)

Returns the processor new instance holder.

Parameters:

knowledgeBase - the knowledge base.

processorClass - the processor class.

javaClass - the Java class of the processor.

Returns:

the processor new instance holder or null if this interpreter doesn't support the given processor class.

getEngineOperations

KnowledgeBaseEngineOperations getEngineOperations()

Returns engine operations associated with this knowledge base interpreter.

Returns:

engine operations associated with this knowledge base interpreter.

getSpecificExceptionMessage

String getSpecificExceptionMessage(Throwable e)

Returns the implementation-specific error message or null if no specific message is necessary.

Parameters:

e - the exception.

Returns:

the implementation-specific error message.