de.hawhamburg.reachability.reasoner.engine

Class ExampleReasoner

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.reasoner.Reasoner

de.hawhamburg.reachability.reasoner.engine.ExampleReasoner

All Implemented Interfaces:

PropertyServiceNotifiable, ReasoningEngine, StopableObject, java.lang.Runnable

public class ExampleReasoner
extends Reasoner

An example reasoning engine to explain the basic reasoner implementation.

This Reasoner implementation is an example reasoner implementation for explanation reasons. It is able to handle active user feedback from user interface. Internal sensor data will be supplied at runtime through the setSensorData(JsonReachabilitySensorData) method. The reasoner estimates the user reachability and provides it by getEstimatedReachability().

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 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 java.util.Properties	reasonerProps Basic (user-defined) properties.
private long	startingAt Starting time of the reasoner.

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
ExampleReasoner() Create a new example reasoning engine.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cleanUp() Write current state to log and give all resources free.
void	dump() Write current state and configuration of this reasoning engine to log...
java.util.Map<ReachabilityGroup,ReachabilityStatus>	getEstimatedReachability() Supplies the actual estimated ReachabilityStatus to all ReachabilityGroups as Map of ReachabilityStatus to ReachabilityGroup.
ReachabilityStatus	getEstimatedReachability(ReachabilityGroup group) Supplies the actual estimated ReachabilityStatus to a specific ReachabilityGroup.
java.util.Map<java.lang.String,java.lang.String>	getValuesForProperty(java.lang.String property) Returns reasoner defined options for a specific property.
void	handleFeedback(ReachabilityGroup group, ReachabilityStatus status) Handle active user feedback which sets a certain ReachabilityGroup to a specified ReachabilityStatus.
java.util.Properties	loadCurrentProperties(ConfigType type) Loads and returns the current local properties of a specified ConfigType.
static void	main(java.lang.String[] args) Main procedure to start and run this reasoning engine as ReasonerAgent.
protected void	setSensorData(JsonReachabilitySensorData data) Adds a new sensor object or replaces the last known of this dimension.
void	updateProperties(java.util.Properties newProps, java.util.Properties changed, ConfigType type) Update local properties.

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

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.

startingAt

private long startingAt

Starting time of the reasoner.

Constructor Detail

ExampleReasoner

public ExampleReasoner()

Create a new example reasoning engine.

Method Detail

setSensorData

protected final void setSensorData(JsonReachabilitySensorData data)

Adds a new sensor object or replaces the last known of this dimension. The dimension and the sensor object can be extracted from the JsonReachabilitySensorData object. This method will be called by the super class Reasoner at runtime if a new internal sensor data arrives.

Specified by:

setSensorData in class Reasoner

Parameters:

data - The JsonReachabilitySensorData which has been measured.

getEstimatedReachability

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

Supplies the actual estimated ReachabilityStatus to all ReachabilityGroups as Map of ReachabilityStatus to ReachabilityGroup. This method will be called by the super class Reasoner at runtime to publish the actual estimated reachability.

Returns:

A Map of estimated ReachabilityStatus .

getEstimatedReachability

public final ReachabilityStatus getEstimatedReachability(ReachabilityGroup group)

Supplies the actual estimated ReachabilityStatus to a specific ReachabilityGroup.

Parameters:

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

Returns:

The ReachabilityStatus related to the requested ReachabilityGroup.

handleFeedback

public void handleFeedback(ReachabilityGroup group,
                  ReachabilityStatus status)

Handle active user feedback which sets a certain ReachabilityGroup to a specified ReachabilityStatus. This method will be called by the super class Reasoner at runtime whenever new active user feedback arrives.

Parameters:

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

status - The user expected ReachabilityStatus to this ReachabilityGroup.

getValuesForProperty

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

Returns reasoner defined options for a specific property. This may be useful for dynamic property options. This method will be called by the property service of the super class Reasoner if the type for the property was defined as AGENT_DEFINED

Parameters:

property - The requested property as String.

Returns:

The values of the requested property as Map of String to String.

loadCurrentProperties

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

Loads and returns the current local properties of a specified ConfigType. This method will be called by the super class Reasoner at runtime if the properties of this reasoner are requested by a user interface.

Parameters:

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

Returns:

The requested configuration as Properties object.

updateProperties

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

Update local properties. This method will be called by the super class Reasoner at runtime if a property change from the user interface or actual configuration data of other components arrive.

Parameters:

newProps - The actual defined and correct Properties set.

changed - The changed Properties set.

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

cleanUp

protected final void cleanUp()

Write current state to log and give all resources free. This method will be called by the super class Reasoner at runtime if this service will be ended.

Specified by:

cleanUp in class Reasoner

dump

public void dump()

Write current state and configuration of this reasoning engine to log...

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.