org.openksavi.sponge.core.kb

Class BaseScriptKnowledgeBaseInterpreter

java.lang.Object

org.openksavi.sponge.core.kb.BaseKnowledgeBaseInterpreter

org.openksavi.sponge.core.kb.BaseScriptKnowledgeBaseInterpreter

All Implemented Interfaces:

KnowledgeBaseInterpreter, KnowledgeBaseOperations, ScriptKnowledgeBaseInterpreter

Direct Known Subclasses:

EngineScriptKnowledgeBaseInterpreter

public abstract class BaseScriptKnowledgeBaseInterpreter
extends BaseKnowledgeBaseInterpreter
implements ScriptKnowledgeBaseInterpreter

Script based knowledge base interpreter.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	interpteterSynchro Synchronization processor.
static String	PROP_PATH_SEPARATOR
protected ScriptClassInstanceProvider	scriptClassInstancePovider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseScriptKnowledgeBaseInterpreter(KnowledgeBaseEngineOperations engineOperations, KnowledgeBaseType type) Creates a new knowledge base interpreter.

Method Summary

Modifier and Type	Method and Description
protected abstract ScriptKnowledgeBaseInterpreter	createInterpreterInstance(SpongeEngine engine, KnowledgeBase knowledgeBase)
ProcessorInstanceHolder	createProcessorInstanceByProcessorClass(KnowledgeBase knowledgeBase, Object processorClass, Class<?> javaClass)
protected abstract <T> ScriptClassInstanceProvider<T>	createScriptClassInstancePovider()
protected <T> T	doCreateInstance(String className, Class<T> javaClass) Creates an instance of the given class.
protected void	doLoad(Reader reader, String name)
protected void	doReload(List<KnowledgeBaseScript> scripts)
abstract <T> T	eval(Reader reader, String filename)
<T> T	eval(String expression, Class<T> cls)
protected Map<Class<?>,Class<?>>	getProcessorClasses()
protected Map<Class<?>,Class<?>>	getSimplifiedImportClasses()
protected List<Class<?>>	getStandardImportClasses()
protected void	invalidateCache()
protected boolean	isProcessorAbstract(String className)
void	load(KnowledgeBaseScript script)
void	load(List<KnowledgeBaseScript> scripts)
void	load(String filename) Loads the knowledge base from the file.
void	load(String filename, Charset charset)
void	load(String filename, Charset charset, boolean required)
void	load(String filename, String charset) Loads the knowledge base from the file.
void	onAfterLoad()
void	onAfterReload() Calls onAfterReload method in the knowledge base.
void	onBeforeLoad()
void	onBeforeReload() Calls onBeforeReload method in the knowledge base.
void	onInit()
void	onLoad()
boolean	onRun()
void	onShutdown() Calls onShutdown method in the knowledge base.
void	onStartup() Calls onStartup method in the knowledge base.
protected void	overwriteProcessorBuilderClass(Class<?> interfaceCls, Class<?> processorBuilderCls)
protected void	overwriteProcessorClass(Class<?> interfaceCls, Class<?> processorCls)
protected abstract void	prepareInterpreter() Prepares the interpreter.
void	reload(List<KnowledgeBaseScript> scripts)

Methods inherited from class org.openksavi.sponge.core.kb.BaseKnowledgeBaseInterpreter

createPluginInstance, createProcessorInstance, getCustomRuleEventSpec, getEngineOperations, getLogger, getRuleEventSpec, getSpecificExceptionMessage, getType, getVariable, resolveEventNameAndAlias

Methods inherited from class java.lang.Object

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

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

eval, invokeFunction, invokeOptionalFunction, scanToAutoEnable

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

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

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

onClear

Field Detail

PROP_PATH_SEPARATOR

public static final String PROP_PATH_SEPARATOR

See Also:

Constant Field Values

interpteterSynchro

protected Object interpteterSynchro

Synchronization processor.

scriptClassInstancePovider

protected ScriptClassInstanceProvider scriptClassInstancePovider

Constructor Detail

BaseScriptKnowledgeBaseInterpreter

protected BaseScriptKnowledgeBaseInterpreter(KnowledgeBaseEngineOperations engineOperations,
                                             KnowledgeBaseType type)

Creates a new knowledge base interpreter.

Parameters:

engineOperations - an engine operations.

type - a knowledge base type.

Method Detail

prepareInterpreter

protected abstract void prepareInterpreter()

Prepares the interpreter.

createScriptClassInstancePovider

protected abstract <T> ScriptClassInstanceProvider<T> createScriptClassInstancePovider()

doCreateInstance

protected <T> T doCreateInstance(String className,
                                 Class<T> javaClass)

Description copied from class: BaseKnowledgeBaseInterpreter

Creates an instance of the given class.

Specified by:

doCreateInstance in class BaseKnowledgeBaseInterpreter

Type Parameters:

T - instance type

Parameters:

className - class name.

javaClass - processor class.

Returns:

processor instance.

invalidateCache

protected final void invalidateCache()

load

public final void load(List<KnowledgeBaseScript> scripts)

Specified by:

load in interface ScriptKnowledgeBaseInterpreter

load

public final void load(String filename)

Loads the knowledge base from the file.

Specified by:

load in interface ScriptKnowledgeBaseInterpreter

Parameters:

filename - filename.

load

public final void load(String filename,
                       String charset)

Loads the knowledge base from the file.

Specified by:

load in interface ScriptKnowledgeBaseInterpreter

Parameters:

filename - filename.

charset - charset.

load

public final void load(String filename,
                       Charset charset)

Specified by:

load in interface ScriptKnowledgeBaseInterpreter

load

public final void load(String filename,
                       Charset charset,
                       boolean required)

Specified by:

load in interface ScriptKnowledgeBaseInterpreter

load

public final void load(KnowledgeBaseScript script)

Specified by:

load in interface ScriptKnowledgeBaseInterpreter

doLoad

protected void doLoad(Reader reader,
                      String name)

reload

public final void reload(List<KnowledgeBaseScript> scripts)

Specified by:

reload in interface ScriptKnowledgeBaseInterpreter

doReload

protected void doReload(List<KnowledgeBaseScript> scripts)

onInit

public void onInit()

Specified by:

onInit in interface KnowledgeBaseOperations

onBeforeLoad

public void onBeforeLoad()

Specified by:

onBeforeLoad in interface KnowledgeBaseOperations

onLoad

public void onLoad()

Specified by:

onLoad in interface KnowledgeBaseOperations

onAfterLoad

public void onAfterLoad()

Specified by:

onAfterLoad in interface KnowledgeBaseOperations

onStartup

public void onStartup()

Calls onStartup method in the knowledge base.

Specified by:

onStartup in interface KnowledgeBaseOperations

onRun

public boolean onRun()

Specified by:

onRun in interface KnowledgeBaseOperations

onShutdown

public void onShutdown()

Calls onShutdown method in the knowledge base.

Specified by:

onShutdown in interface KnowledgeBaseOperations

onBeforeReload

public void onBeforeReload()

Calls onBeforeReload method in the knowledge base.

Specified by:

onBeforeReload in interface KnowledgeBaseOperations

onAfterReload

public void onAfterReload()

Calls onAfterReload method in the knowledge base.

Specified by:

onAfterReload in interface KnowledgeBaseOperations

eval

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

Specified by:

eval in interface ScriptKnowledgeBaseInterpreter

eval

public abstract <T> T eval(Reader reader,
                           String filename)

createInterpreterInstance

protected abstract ScriptKnowledgeBaseInterpreter createInterpreterInstance(SpongeEngine engine,
                                                                            KnowledgeBase knowledgeBase)

getStandardImportClasses

protected List<Class<?>> getStandardImportClasses()

isProcessorAbstract

protected boolean isProcessorAbstract(String className)

createProcessorInstanceByProcessorClass

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

Specified by:

createProcessorInstanceByProcessorClass in interface KnowledgeBaseInterpreter

getProcessorClasses

protected Map<Class<?>,Class<?>> getProcessorClasses()

overwriteProcessorClass

protected void overwriteProcessorClass(Class<?> interfaceCls,
                                       Class<?> processorCls)

overwriteProcessorBuilderClass

protected void overwriteProcessorBuilderClass(Class<?> interfaceCls,
                                              Class<?> processorBuilderCls)

getSimplifiedImportClasses

protected Map<Class<?>,Class<?>> getSimplifiedImportClasses()