de.hawhamburg.reachability.reasoner

Interface ReasoningEngine

All Superinterfaces:

java.lang.Runnable, StopableObject

All Known Implementing Classes:

DroolsBasedEngine, ExampleReasoner, Reasoner

public interface ReasoningEngine
extends java.lang.Runnable, StopableObject

Default interface for reasoner which needs to be implemented by each reasoning engine.

This interface defines the methods which a reasoner needs to implement to be used in common with this reachability agent. Besides the specified methods in this interface, the reasoner needs to implement the interfaces Runnable and StopableObject as well.

Version:

"2013.42"

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_FILE_SOURCE_KEY The property key which leads to the path where the reasoning engine properties are stored.

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	handleFeedback(ReachabilityGroup group, ReachabilityStatus status) Handles the user feedback from a user interface supplied via the ActiveMQ for a certain ReachabilityGroup and the users estimation of his ReachabilityStatus related to this group.
void	start() This method of Thread has been added to the interface to make it public.

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface de.hawhamburg.reachability.StopableObject

isActive, shutDown

Field Detail

PROPERTY_FILE_SOURCE_KEY

static final java.lang.String PROPERTY_FILE_SOURCE_KEY

The property key which leads to the path where the reasoning engine properties are stored.

See Also:

Constant Field Values

Method Detail

getEstimatedReachability

ReachabilityStatus getEstimatedReachability(ReachabilityGroup group)

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

Parameters:

group - A ReachabilityGroup for which the state of reachability is requested.

Returns:

The current estimated state of reachability as ReachabilityStatus.

getEstimatedReachability

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

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

Returns:

A hash map containing each ReachabilityGroup and its currently estimated state of reachability as ReachabilityStatus.

handleFeedback

void handleFeedback(ReachabilityGroup group,
                  ReachabilityStatus status)

Handles the user feedback from a user interface supplied via the ActiveMQ for a certain ReachabilityGroup and the users estimation of his ReachabilityStatus related to this group.

Parameters:

group - A ReachabilityGroup for which the feedback is meant.

status - The ReachabilityStatus as users estimation related to the specified group.

dump

void dump()

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

start

void start()

This method of Thread has been added to the interface to make it public.