de.hawhamburg.reachability.reasoner.engine

Class DroolsBasedEngine

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.reasoner.Reasoner

de.hawhamburg.reachability.reasoner.engine.DroolsBasedEngine

All Implemented Interfaces:

PropertyServiceNotifiable, ReasoningEngine, StopableObject, java.lang.Runnable

public class DroolsBasedEngine
extends Reasoner

A JBoss Drools rule based reasoning engine.

This Reasoner implementation is based on the JBoss Drools rule engine by using several classes of org.drools. It provides the compilation of author defined XML-Code to drools code by WorkingMemoryRuleGenerator and is able to handle active user feedback from user interface. Internal sensor data will be added to the KnowledgeBase together with the compiled rule set. The rules then will set the current reachability map of this class which will be published onto the ActiveMQ result topic.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private long	accessKey The access key which is generated randomly on class creation.
private java.util.Map<ReasonerDimension,org.drools.runtime.rule.FactHandle>	factHandles All handles to facts actual known to Drools working memory.
private org.drools.KnowledgeBase	kbase The Drools knowledge base.
private java.util.Map<ReachabilityGroup,java.lang.Long>	lastFeedback The time of the last given user feedback.
private org.drools.runtime.StatefulKnowledgeSession	memory The Drools working memory.
private java.util.Map<ReachabilityGroup,ReachabilityStatus>	memoryStatus The current status in memory.
private static java.lang.String	MIND_FEEDBACK_KEY The name of the property which contains the time for how long active feedback shall be minded.
private static java.lang.String	PHENOTYPE_FILE_PROPERTY_KEY The name of the property which contains the name of the current rule-set file.
private java.util.Properties	reasonerProps Basic (user-defined) properties.
private long	startingAt Starting time of the reasoner.
private java.util.Map<ReachabilityGroup,ReachabilityStatus>	userFeedback Current given user feedback.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface de.hawhamburg.reachability.reasoner.ReasoningEngine

PROPERTY_FILE_SOURCE_KEY

Constructor Summary

Constructors

Constructor and Description
DroolsBasedEngine() Create a new rule based reasoning engine (Using Jess Rule Engine).

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanUp() Cleans up by freeing all resources.
void	dump() If this method is called, the reasoner dumps its current internal state using the OutputUtil.info(String) method.
java.util.Map<ReachabilityGroup,ReachabilityStatus>	getEstimatedReachability() Returns the current estimated state of reachability of all registered groups as hash map.
ReachabilityStatus	getEstimatedReachability(ReachabilityGroup group) Returns the current estimated state of reachability for a certain group from the reasoner.
java.util.Map<java.lang.String,java.lang.String>	getValuesForProperty(java.lang.String property) It may occur that a property is defined as DisplayType.AGENT_DEFINED, which means that the value range is dynamically defined at runtime.
private boolean	globalExists(java.lang.String name) Checks if a global is defined within the StatefulKnowledgeSession or not.
void	handleFeedback(ReachabilityGroup group, ReachabilityStatus status) Observes the input topic and handles feedback delivered on this topic.
java.util.Properties	loadCurrentProperties(ConfigType type) The PropertyService requests the actual properties of a certain ConfigType from its creator.
private void	loadKBase() Load default or cached knowledge base for drools CEP.
static void	main(java.lang.String[] args) Main procedure to start and run this reasoning engine as ReasonerAgent.
private void	setGlobal(java.lang.String name, java.lang.Object value) Sets a global variable of the StatefulKnowledgeSession to a certain value.
void	setReachabilityStatus(ReachabilityGroup group, ReachabilityStatus status, long accessKeyIn) This method will the the ReachabilityStatus of a certain ReachabilityGroup.
void	setSensorData(JsonReachabilitySensorData sensorData) Adds a new SensorData object to the StatefulKnowledgeSession or replaces the last known SensorData of this dimension.
void	updateProperties(java.util.Properties newProps, java.util.Properties changedProps, ConfigType type) The PropertyService informs its creator, that there was a change of properties and that the creator should update his properties according to the new ones.

Methods inherited from class de.hawhamburg.reachability.reasoner.Reasoner

getID, getVersion, isActive, isSilent, pushProperties, run, setSilent, shutDown, stopped

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hawhamburg.reachability.reasoner.ReasoningEngine

start

Field Detail

PHENOTYPE_FILE_PROPERTY_KEY

private static final java.lang.String PHENOTYPE_FILE_PROPERTY_KEY

The name of the property which contains the name of the current rule-set file.

See Also:

Constant Field Values

MIND_FEEDBACK_KEY

private static final java.lang.String MIND_FEEDBACK_KEY

The name of the property which contains the time for how long active feedback shall be minded.

See Also:

Constant Field Values

reasonerProps

private java.util.Properties reasonerProps

Basic (user-defined) properties.

kbase

private org.drools.KnowledgeBase kbase

The Drools knowledge base.

memory

private org.drools.runtime.StatefulKnowledgeSession memory

The Drools working memory.

startingAt

private long startingAt

Starting time of the reasoner.

factHandles

private java.util.Map<ReasonerDimension,org.drools.runtime.rule.FactHandle> factHandles

All handles to facts actual known to Drools working memory.

userFeedback

private java.util.Map<ReachabilityGroup,ReachabilityStatus> userFeedback

Current given user feedback.

memoryStatus

private java.util.Map<ReachabilityGroup,ReachabilityStatus> memoryStatus

The current status in memory. Important in common the rule base changes in updateProperties(Properties, Properties, ConfigType).

lastFeedback

private java.util.Map<ReachabilityGroup,java.lang.Long> lastFeedback

The time of the last given user feedback.

accessKey

private long accessKey

The access key which is generated randomly on class creation. It is necessary to know this key to externally update the reachability status using setReachabilityStatus(ReachabilityGroup, ReachabilityStatus, long).

Constructor Detail

DroolsBasedEngine

public DroolsBasedEngine()

Create a new rule based reasoning engine (Using Jess Rule Engine).

Method Detail

loadKBase

private void loadKBase()

Load default or cached knowledge base for drools CEP.

setGlobal

private void setGlobal(java.lang.String name,
             java.lang.Object value)

Sets a global variable of the StatefulKnowledgeSession to a certain value.

Parameters:

name - The name of the global variable within the StatefulKnowledgeSession as String.

value - The new value of the global as Object.

globalExists

private boolean globalExists(java.lang.String name)

Checks if a global is defined within the StatefulKnowledgeSession or not.

Parameters:

name - The name of the global variable as String.

Returns:

true if the global is defined, otherwise false.

cleanUp

public final void cleanUp()

Description copied from class: Reasoner

Cleans up by freeing all resources.

Specified by:

cleanUp in class Reasoner

See Also:

StopableObject.shutDown()

setSensorData

public final void setSensorData(JsonReachabilitySensorData sensorData)

Adds a new SensorData object to the StatefulKnowledgeSession or replaces the last known SensorData of this dimension. The ReasonerDimension and the SensorData will be extracted from the JsonReachabilitySensorData object.

Specified by:

setSensorData in class Reasoner

Parameters:

sensorData - The JsonReachabilitySensorData which has been measured.

setReachabilityStatus

public final void setReachabilityStatus(ReachabilityGroup group,
                         ReachabilityStatus status,
                         long accessKeyIn)

This method will the the ReachabilityStatus of a certain ReachabilityGroup. It will only work, if the correct accessKey is supplied. For this reason, the method can only be called by an internal method or the drools rule base.

Parameters:

group - A ReachabilityGroup.

status - A ReachabilityStatus.

accessKeyIn - The previously shared access key.

updateProperties

public final void updateProperties(java.util.Properties newProps,
                    java.util.Properties changedProps,
                    ConfigType type)

Description copied from interface: PropertyServiceNotifiable

The PropertyService informs its creator, that there was a change of properties and that the creator should update his properties according to the new ones.

Parameters:

newProps - The actual defined and correct Properties set.

changedProps - The changed Properties set.

type - The properties type which shall be updated as ConfigType.

See Also:

PropertyServiceNotifiable.updateProperties(Properties, Properties, ConfigType)

loadCurrentProperties

public final java.util.Properties loadCurrentProperties(ConfigType type)

Description copied from interface: PropertyServiceNotifiable

The PropertyService requests the actual properties of a certain ConfigType from its creator. The creator should reload its local property set and return them to the PropertyService.

Parameters:

type - Loads the current configuration of a certain type defined as ConfigType.

Returns:

The requested configuration as Properties object.

See Also:

PropertyServiceNotifiable.loadCurrentProperties(ConfigType)

getValuesForProperty

public final java.util.Map<java.lang.String,java.lang.String> getValuesForProperty(java.lang.String property)

Description copied from interface: PropertyServiceNotifiable

It may occur that a property is defined as DisplayType.AGENT_DEFINED, which means that the value range is dynamically defined at runtime. In this case, the PropertyService asks its creator about the current value range of this property by using this method.

Parameters:

property - The requested property as String.

Returns:

An empty Map of String to String.

See Also:

PropertyServiceNotifiable.getValuesForProperty(String)

getEstimatedReachability

public final java.util.Map<ReachabilityGroup,ReachabilityStatus> getEstimatedReachability()

Description copied from interface: ReasoningEngine

Returns the current estimated state of reachability of all registered groups as hash map.

Returns:

A Map of estimated ReachabilityStatus.

See Also:

ReasoningEngine.getEstimatedReachability()

getEstimatedReachability

public final ReachabilityStatus getEstimatedReachability(ReachabilityGroup group)

Description copied from interface: ReasoningEngine

Returns the current estimated state of reachability for a certain group from the reasoner.

Parameters:

group - The ReachabilityGroup for which the estimated ReachabilityStatus shall be returned.

Returns:

The ReachabilityStatus related to the requested ReachabilityGroup.

See Also:

ReasoningEngine.getEstimatedReachability(ReachabilityGroup)

handleFeedback

public final void handleFeedback(ReachabilityGroup group,
                  ReachabilityStatus status)

Observes the input topic and handles feedback delivered on this topic.

Parameters:

group - The ReachabilityGroup for which the feedback has been given.

status - The user expected ReachabilityStatus to this ReachabilityGroup.

dump

public final void dump()

Description copied from interface: ReasoningEngine

If this method is called, the reasoner dumps its current internal state using the OutputUtil.info(String) method.

See Also:

ReasoningEngine.dump()

main

public static void main(java.lang.String[] args)

Main procedure to start and run this reasoning engine as ReasonerAgent.

Parameters:

args - The system supplied start arguments as array of String.