org.openksavi.sponge.kb

Interface ScriptKnowledgeBaseInterpreter

All Superinterfaces:

KnowledgeBaseInterpreter, KnowledgeBaseOperations

public interface ScriptKnowledgeBaseInterpreter
extends KnowledgeBaseInterpreter, KnowledgeBaseOperations

Script based knowledge base interpreter.

Method Summary

Modifier and Type	Method and Description
<T> T	eval(String expression) Evaluates an expression.
<T> T	eval(String expression, Class<T> cls) Evaluates an expression.
<T> T	invokeFunction(String name, Class<T> cls, Object... args) Invokes a knowledge base function.
<T> T	invokeOptionalFunction(String name, T defaultValue) Invokes a knowledge base function.
void	load(KnowledgeBaseScript script) Loads the knowledge base from the script.
void	load(List<KnowledgeBaseScript> scripts) Loads scripts.
void	load(String fileName) Loads the knowledge base from the file.
void	load(String fileName, Charset charset) Loads the knowledge base from the file.
void	load(String fileName, Charset charset, boolean required) Loads the knowledge base from the file.
void	load(String fileName, String charset) Loads the knowledge base from the file.
void	reload(List<KnowledgeBaseScript> scripts) Reloads scripts.
void	scanToAutoEnable() Scans this knowledge base interpreter for processor definitions (classes) in order to auto enable.

Methods inherited from interface org.openksavi.sponge.kb.KnowledgeBaseInterpreter

createPluginInstance, createProcessorInstance, createProcessorInstanceByProcessorClass, existsVariable, getEngineOperations, getJavaException, getRuleEventSpec, getScriptKnowledgeBaseProcessorClassName, getSpecificExceptionMessage, getType, getVariable, getVariable, invokeMethod, isKnowledgeBaseException, setVariable

Methods inherited from interface org.openksavi.sponge.kb.KnowledgeBaseOperations

onAfterReload, onBeforeReload, onClear, onInit, onLoad, onRun, onShutdown, onStartup

Method Detail

load

void load(List<KnowledgeBaseScript> scripts)

Loads scripts.

Parameters:

scripts - knowledge base scripts.

load

void load(String fileName)

Loads the knowledge base from the file.

Parameters:

fileName - file name.

load

void load(String fileName,
          String charset)

Loads the knowledge base from the file.

Parameters:

fileName - file name.

charset - charset.

load

void load(String fileName,
          Charset charset)

Loads the knowledge base from the file.

Parameters:

fileName - file name.

charset - charset.

load

void load(String fileName,
          Charset charset,
          boolean required)

Loads the knowledge base from the file.

Parameters:

fileName - file name.

charset - charset.

required - true if the file is required.

load

void load(KnowledgeBaseScript script)

Loads the knowledge base from the script.

Parameters:

script - the knowledge base script.

reload

void reload(List<KnowledgeBaseScript> scripts)

Reloads scripts.

Parameters:

scripts - knowledge base scripts.

invokeOptionalFunction

<T> T invokeOptionalFunction(String name,
                             T defaultValue)

Invokes a knowledge base function.

Type Parameters:

T - return value type.

Parameters:

name - a function name.

defaultValue - a default value that will be returned when there is no such function.

Returns:

a function return value.

invokeFunction

<T> T invokeFunction(String name,
                     Class<T> cls,
                     Object... args)

Invokes a knowledge base function.

Type Parameters:

T - return value type.

Parameters:

name - function name.

cls - result type.

args - function arguments.

Returns:

function return value.

eval

<T> T eval(String expression)

Evaluates an expression.

Type Parameters:

T - result type.

Parameters:

expression - expression.

Returns:

result.

eval

<T> T eval(String expression,
           Class<T> cls)

Evaluates an expression.

Type Parameters:

T - result type.

Parameters:

expression - expression.

cls - result class.

Returns:

result.

scanToAutoEnable

void scanToAutoEnable()

Scans this knowledge base interpreter for processor definitions (classes) in order to auto enable.