de.hawhamburg.reachability.ui.frame

Class ReachabilityUI

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

de.hawhamburg.reachability.ui.UI

de.hawhamburg.reachability.ui.frame.ReachabilityUI

All Implemented Interfaces:

StopableObject, SensorDataFeederNotifiable, java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ReachabilityUI
extends UI
implements SensorDataFeederNotifiable

User interface to display the actual estimated reachability states to the inhabitant.

This user interface provides full control over the reachability agent. It is able to let the agent start, stop or sleep. Furthermore the user has the ability to inform the reasoning engine, if an estimation of the engine wasn't correct in a certain case. The engine will take this in account. In addition this user interface provides the user with configuration and simulation abilities.

Version:

"2013.42"

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	controlTopic The LPPublisher to send control messages like start, stop, sleep to the reachability agent via AMQ using the topic LP_CONTROL_TOPIC.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	sendUserFeedback The LPPublisher to send the user feedback via the AMQ topic REACHABILITY_AGENT_TOPIC.
private static long	serialVersionUID Some unique serial version id.
private javax.swing.JMenuItem	showSimulationMenuItem The menu item which opens the simulation control dialog.
private SensorDataFeeder	simulationFeeder The actual active simulation feeder as SensorDataFeeder.
private javax.swing.JMenuItem	startSimulationMenuItem The menu item which opens the start simulation dialog.
private java.util.Map<ReachabilityGroup,javax.swing.JList<ReachabilityStatus>>	stateSelectors The different selectors (JLists) for each ReachabilityGroup as Map for refreshing.
private java.util.Map<ReachabilityGroup,ReachabilityStatus>	status The current known reachability state.
private ReachabilityUIUpdater	updater The ReachabilityUIUpdater which keeps the user interface up to date.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ReachabilityUI() Creates and builds a new reachability user interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
protected void	addMenu() This method adds a menu to the user interface.
private void	addTitleRow() Adds a title row to the user interface containing the names of the reachability groups (ReachabilityGroup).
private void	configDialog(ConfigType type) Show the configuration dialog.
private java.awt.GridLayout	getGrid() Returns a user interface grid.
JsonReachabilityInstruction	getInstructionMsg(ReachabilityGroup group, ReachabilityStatus resStatus) Calls getInstructionMsg(ReachabilityGroup, ReachabilityStatus, String) with a blank String as remark and returns its result.
JsonReachabilityInstruction	getInstructionMsg(ReachabilityGroup group, ReachabilityStatus resStatus, java.lang.String remark) Generates a JsonReachabilityInstruction messages and returns it.
private javax.swing.JList<ReachabilityStatus>	getStatusList() Returns a JList of all ReachabilityStatus entries.
static void	main(java.lang.String[] args) Starts a new ReachabilityUI in the systems look and feel.
void	mousePressed(java.awt.event.MouseEvent e)
void	refresh(boolean refresh) Initial build of this user interface.
void	refresh(java.util.Map<ReachabilityGroup,ReachabilityStatus> newStatus) Builds/refreshes the cached ReachabilityStatus and the user interface.
void	registerSimulationFeeder(SensorDataFeeder feeder) Registers a new simulation feeder.
void	sendControl(ConfigOrder x) Sends a ConfigOrder in a JsonConfigOrder messages via AMQ to the reachability agent.
private void	showSimulationDetailsDialog() Opens a new dialog to show the current simulation state.
void	shutDown() Shuts the object down.
private void	startSimulationDialog() Open a new dialog to start a simulation.
void	unregisterSimulationFeeder(SensorDataFeeder feeder) Unregisters a simulation feeder.
private void	updateStatusRow() Updates the status rows defined by stateSelectors with new values.

Methods inherited from class de.hawhamburg.reachability.ui.UI

addBody, autoPosition, build, fixBounds, getBody, getCommonConfigValue, getConfigValue, getConfigValueAsInteger, getFrameConfigValue, getFrameConfigValueAsInteger, getGrid, getId, getParentWindow, getTimer, getWindowHeight, getWindowWidth, infoDialog, isStandalone, keyPressed, keyReleased, keyTyped, killWindow, loadConfig, loadLocalConfig, mouseClicked, mouseEntered, mouseExited, mouseReleased, refresh, setWindowHeight, setWindowWidth, stopTimer, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hawhamburg.reachability.StopableObject

isActive

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

serialVersionUID

private static final long serialVersionUID

Some unique serial version id.

See Also:

Constant Field Values

sendUserFeedback

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher sendUserFeedback

The LPPublisher to send the user feedback via the AMQ topic REACHABILITY_AGENT_TOPIC.

controlTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher controlTopic

The LPPublisher to send control messages like start, stop, sleep to the reachability agent via AMQ using the topic LP_CONTROL_TOPIC.

updater

private ReachabilityUIUpdater updater

The ReachabilityUIUpdater which keeps the user interface up to date.

simulationFeeder

private SensorDataFeeder simulationFeeder

The actual active simulation feeder as SensorDataFeeder.

startSimulationMenuItem

private javax.swing.JMenuItem startSimulationMenuItem

The menu item which opens the start simulation dialog.

showSimulationMenuItem

private javax.swing.JMenuItem showSimulationMenuItem

The menu item which opens the simulation control dialog.

status

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

The current known reachability state.

stateSelectors

private java.util.Map<ReachabilityGroup,javax.swing.JList<ReachabilityStatus>> stateSelectors

The different selectors (JLists) for each ReachabilityGroup as Map for refreshing.

Constructor Detail

ReachabilityUI

public ReachabilityUI()

Creates and builds a new reachability user interface.

Method Detail

addMenu

protected final void addMenu()

This method adds a menu to the user interface.

Specified by:

addMenu in class UI

getGrid

private java.awt.GridLayout getGrid()

Returns a user interface grid.

Returns:

Returns a user interface grid.

addTitleRow

private void addTitleRow()

Adds a title row to the user interface containing the names of the reachability groups (ReachabilityGroup).

updateStatusRow

private void updateStatusRow()

Updates the status rows defined by stateSelectors with new values.

getStatusList

private javax.swing.JList<ReachabilityStatus> getStatusList()

Returns a JList of all ReachabilityStatus entries.

Returns:

A JList containing all ReachabilityStatus entries as items.

actionPerformed

public final void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class UI

Parameters:

e - An ActionEvent.

See Also:

ActionListener.actionPerformed(java.awt.event.ActionEvent)

mousePressed

public final void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class UI

Parameters:

e - A MouseEvent.

See Also:

MouseListener.mousePressed(java.awt.event.MouseEvent)

shutDown

public final void shutDown()

Description copied from interface: StopableObject

Shuts the object down. The method shall ensure, that all opened or started resources (e.g. ActiveMQ connections, started threads) will be controlled shut down before the objects ends itself.

Specified by:

shutDown in interface StopableObject

Specified by:

shutDown in class UI

See Also:

StopableObject.shutDown()

startSimulationDialog

private void startSimulationDialog()

Open a new dialog to start a simulation.

showSimulationDetailsDialog

private void showSimulationDetailsDialog()

Opens a new dialog to show the current simulation state.

configDialog

private void configDialog(ConfigType type)

Show the configuration dialog.

Parameters:

type - The type of configuration.

refresh

public final void refresh(boolean refresh)

Initial build of this user interface. The rendering won't be influenced by the refresh parameter.

Specified by:

refresh in class UI

Parameters:

refresh - Indicates if this method was called with the intention to re-render the interface.

refresh

public final void refresh(java.util.Map<ReachabilityGroup,ReachabilityStatus> newStatus)

Builds/refreshes the cached ReachabilityStatus and the user interface.

Parameters:

newStatus - A hash Map containing the current ReachabilityStatus.

getInstructionMsg

public final JsonReachabilityInstruction getInstructionMsg(ReachabilityGroup group,
                                            ReachabilityStatus resStatus)

Calls getInstructionMsg(ReachabilityGroup, ReachabilityStatus, String) with a blank String as remark and returns its result.

Parameters:

group - A ReachabilityGroup.

resStatus - A ReachabilityStatus

Returns:

A JsonReachabilityInstruction message.

getInstructionMsg

public final JsonReachabilityInstruction getInstructionMsg(ReachabilityGroup group,
                                            ReachabilityStatus resStatus,
                                            java.lang.String remark)

Generates a JsonReachabilityInstruction messages and returns it.

Parameters:

group - A ReachabilityGroup

resStatus - A ReachabilityStatus

remark - A remark as String.

Returns:

A JsonReachabilityInstruction message.

sendControl

public final void sendControl(ConfigOrder x)

Sends a ConfigOrder in a JsonConfigOrder messages via AMQ to the reachability agent.

Parameters:

x - The ConfigOrder which shall be send.

registerSimulationFeeder

public final void registerSimulationFeeder(SensorDataFeeder feeder)

Registers a new simulation feeder. Disables the start simulation and enables the simulation controlling menu option.

Specified by:

registerSimulationFeeder in interface SensorDataFeederNotifiable

Parameters:

feeder - The new simulation feeder as SensorDataFeeder which shall be registered.

unregisterSimulationFeeder

public final void unregisterSimulationFeeder(SensorDataFeeder feeder)

Unregisters a simulation feeder. Disables the simulation controlling and enables the start start simulation menu option.

Specified by:

unregisterSimulationFeeder in interface SensorDataFeederNotifiable

Parameters:

feeder - The simulation feeder as SensorDataFeeder which shall be unregistered.

main

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

Starts a new ReachabilityUI in the systems look and feel.

Parameters:

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