com.dpsframework.core.engines

Class RBEngineCLIPS

java.lang.Object

com.dpsframework.core.engines.RBEngineCLIPSRouter

com.dpsframework.core.engines.RBEngineCLIPS

All Implemented Interfaces:

RBEngine, net.sf.clipsrules.jni.Router

public class RBEngineCLIPS
extends RBEngineCLIPSRouter
implements RBEngine

CLIPS Engine Prototype. It is used by PsNodeAgents to connect to its CLIPS-Engine instance.

Since:

2015, update at: 2018-08-24

Version:

1.7 (Build.1814)

Author:

Francisco J. Aguayo (Leon University / IEEE Power & Energy Systems Society Member)

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	dateHistory
private net.sf.clipsrules.jni.Environment	innEng
private boolean	isExecuting
private java.lang.String	shellHistory
private java.lang.Thread	thread

Fields inherited from interface com.dpsframework.core.engines.RBEngine

APPEND_INPUT_BUFFER, crosscommands, ENGINE_IDLE, ENGINE_RUNNING, ENGINE_UNKNOWN_STATE, EVAL_COMMAND, EXPAND_INPUT_BUFFER, FACT_INDEX, GET_FACT_SLOT, LOAD_ASSERT_STRING, LOAD_BLOAD, LOAD_FACTS, LOAD_FILE, LOAD_FROM_RESOURCE, LOAD_FROM_STRING, LOAD_SLOAD, MAKE_ADD_ROUTER_CLIPS, MAKE_ADD_ROUTER_JTEXTAR, MAKE_ASSERT_STRING, MAKE_BUILD, MAKE_CLEAR, MAKE_MEMORY_DUMP, MAKE_RESET, RUN_INFINITELY, RUN_INNER_SHELL, RUN_NUMBER_OF_CYCLES, RUN_ONCE_THEN_BATCH, SET_INPUT_BUFFER, SET_INPUT_BUFFER_COUNT, SET_UNWATCH, SET_WATCH, TEST_ACTIVATIONS

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RBEngineCLIPS() A default constructor with following functions: to lock instancing without parameters, to test machine architecture, to initialize a Log file inside Agent directories or Framework /logs/, and to add CLIPS - JNI path Library at runtime.
	RBEngineCLIPS(net.sf.clipsrules.jni.Environment outEnv) Constructor was calling from an Agent, which connects to external CLIPS Engine.
	RBEngineCLIPS(int mode) Constructor was calling from Console-command-line.
	RBEngineCLIPS(java.lang.Object outEnv) Constructor was calling with a previous CLIPS Environment as a wrapper object.
	RBEngineCLIPS(java.lang.Object outEnv, java.lang.ThreadGroup tg, java.lang.String tn) Constructor was calling from an Agent running inside JADE Platform.
	RBEngineCLIPS(java.lang.ThreadGroup tg, java.lang.String tn) Constructor was calling from an Agent, which requests a new CLIPS-Engine instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBanner()
java.lang.String	getMethodByKey(int key) Helper method for get Number of Process by Key of Process.
int	getMethodByName(java.lang.String name) Helper method for get the Integer Process by Process name.
net.sf.clipsrules.jni.Environment	getRBEngine()
int	getState()
java.lang.String	getVersion()
java.lang.String	innerCommand()
java.lang.Object[]	innerCommand(int iCode, java.lang.String sValue)
java.lang.Object[]	innerCommand(int iCode, java.lang.String sValue, java.lang.String sContent)
java.lang.Object[]	innerCommand(java.lang.String sValue)
java.lang.Object[]	innerCommand(java.lang.String sCode, java.lang.String sValue)
java.lang.Object[]	innerCommand(java.lang.String sCode, java.lang.String sValue, java.lang.String sContent) Execute on CLIPS-Engine a normalized Process by its code-IDentifier.
void	innerShell() Open new CLIPS-Shell inside Java-BeanShell connected to CLIPSJNI.
java.lang.String	printEngMethods()
private void	setExecuting(boolean value)
boolean	setRouter(java.lang.Object router)
void	setThGroup(java.lang.ThreadGroup tg)
void	setThName(java.lang.String name)
java.lang.String	suprimeTail()
java.lang.String	suprimeTail(java.lang.String evalResult) It eliminates the tail from CLIPS-Engine answers.

Methods inherited from class com.dpsframework.core.engines.RBEngineCLIPSRouter

bufferStatus, exit, getBuffer, getchar, getName, getPriority, outputBuffer, print, query, resetBuffer, retainedBuffer, startBuffer, stopBuffer, ungetchar

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dpsframework.core.engines.RBEngine

getBuffer, outputBuffer, resetBuffer, retainedBuffer, startBuffer, stopBuffer

Field Detail

innEng

private net.sf.clipsrules.jni.Environment innEng

thread

private java.lang.Thread thread

isExecuting

private boolean isExecuting

dateHistory

private java.lang.String dateHistory

shellHistory

private java.lang.String shellHistory

Constructor Detail

RBEngineCLIPS

private RBEngineCLIPS()

A default constructor with following functions: to lock instancing without parameters, to test machine architecture, to initialize a Log file inside Agent directories or Framework /logs/, and to add CLIPS - JNI path Library at runtime.

RBEngineCLIPS

public RBEngineCLIPS(int mode)

Constructor was calling from Console-command-line.

Parameters:

mode - outside CLIPS Environment.

RBEngineCLIPS

public RBEngineCLIPS(net.sf.clipsrules.jni.Environment outEnv)

Constructor was calling from an Agent, which connects to external CLIPS Engine.

NOTE: It is only used to control engines that runs inside another systems o applications (e.g. a Jess-Tab plugging from Protegee OWL Ontology IDE).

Parameters:

outEnv - outside CLIPS Environment.

RBEngineCLIPS

public RBEngineCLIPS(java.lang.Object outEnv)

Constructor was calling with a previous CLIPS Environment as a wrapper object.

Parameters:

outEnv - outside CLIPS Environment.

RBEngineCLIPS

public RBEngineCLIPS(java.lang.ThreadGroup tg,
             java.lang.String tn)

Constructor was calling from an Agent, which requests a new CLIPS-Engine instance.

Parameters:

tg - ThreadGroup is imposed by JADE Platform.

tn - ThreadName is imposed by PsNodeAgent.

RBEngineCLIPS

public RBEngineCLIPS(java.lang.Object outEnv,
             java.lang.ThreadGroup tg,
             java.lang.String tn)

Constructor was calling from an Agent running inside JADE Platform.

Parameters:

tg - ThreadGroup is imposed by JADE Platform.

tn - ThreadName is imposed by JADE PsNodeAgent.

outEnv - Environment is imposed by some external system.

Method Detail

getRBEngine

public net.sf.clipsrules.jni.Environment getRBEngine()

Specified by:

getRBEngine in interface RBEngine

setThGroup

public void setThGroup(java.lang.ThreadGroup tg)

Specified by:

setThGroup in interface RBEngine

setThName

public void setThName(java.lang.String name)

Specified by:

setThName in interface RBEngine

setExecuting

private void setExecuting(boolean value)

setRouter

public boolean setRouter(java.lang.Object router)

Specified by:

setRouter in interface RBEngine

innerShell

public void innerShell()

Open new CLIPS-Shell inside Java-BeanShell connected to CLIPSJNI.

Specified by:

innerShell in interface RBEngine

See Also:

RBEngine.innerShell()

suprimeTail

public java.lang.String suprimeTail(java.lang.String evalResult)

It eliminates the tail from CLIPS-Engine answers.

Parameters:

evalResult - move the tail off from buffer response.

Returns:

Engine response without CLIPS> from response.

suprimeTail

public java.lang.String suprimeTail()

getBanner

public java.lang.String getBanner()

innerCommand

public java.lang.Object[] innerCommand(java.lang.String sCode,
                              java.lang.String sValue,
                              java.lang.String sContent)

Execute on CLIPS-Engine a normalized Process by its code-IDentifier.

Specified by:

innerCommand in interface RBEngine

Parameters:

sCode - Process identifier String (or Integer).

sValue - Usually is a string used like comma separated container (or command to evaluate)

sContent - Usually large data inside Envelope().Comments Field

innerCommand

public java.lang.Object[] innerCommand(java.lang.String sCode,
                              java.lang.String sValue)

Specified by:

innerCommand in interface RBEngine

innerCommand

public java.lang.Object[] innerCommand(int iCode,
                              java.lang.String sValue)

Specified by:

innerCommand in interface RBEngine

innerCommand

public java.lang.Object[] innerCommand(java.lang.String sValue)

Specified by:

innerCommand in interface RBEngine

innerCommand

public java.lang.String innerCommand()

innerCommand

public java.lang.Object[] innerCommand(int iCode,
                              java.lang.String sValue,
                              java.lang.String sContent)

Specified by:

innerCommand in interface RBEngine

getState

public int getState()

Specified by:

getState in interface RBEngine

printEngMethods

public java.lang.String printEngMethods()

Returns:

Formated list of Proposal Engine's Methods

getMethodByKey

public java.lang.String getMethodByKey(int key)

Helper method for get Number of Process by Key of Process.

Parameters:

key - Code-key of Process

Returns:

The label string for this key

getMethodByName

public int getMethodByName(java.lang.String name)

Helper method for get the Integer Process by Process name.

Parameters:

name - Name of Process

Returns:

The integer for this label Method

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface RBEngine