de.hawhamburg.reachability.ui.frame.config

Class ReachabilityConfigUI

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.config.ReachabilityConfigUI

All Implemented Interfaces:

StopableObject, 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 ReachabilityConfigUI
extends UI

User interface to adjust the reachability agents parameters.

This user interface is a piggyback window to display and change the current configuration of the reachability agent. It is able to load the current properties via ActiveMQ from the reachability agent and present them to the user. The user then may change the configuration to influence the calculation of the reachability and to adjust the reachability processing to be more comfortable for him. This user interface represents all possible configuration user interfaces independent from the chosen properties type. Possible types are defined by the ConfigType enumeration.

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	changeConfig The LPPublisher to send the users configuration via the ActiveMQ topic REACHABILITY_CONFIG_CHANGE_TOPIC.
private java.util.Map<java.lang.String,java.lang.String>	config The last known configuration.
private javax.swing.JPanel	contentPane The content pane of this user interface as JPanel.
private ConfigType	internalType The type of configuration pane.
private java.util.Map<java.lang.String,PropertyDescription>	propertyDesc The last known property description.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	requestConfig The LPPublisher to send the get configuration request REACHABILITY_CONFIG_REQUEST_TOPIC.
private static long	serialVersionUID Some unique serial version id.
private java.lang.String	serviceStateReference The current service state reference.
private java.util.Set<ReachabilityConfigUIResultListener>	updaters Current active updater.

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
ReachabilityConfigUI(javax.swing.JFrame parentWindow, ConfigType type) Initializes, starts and builds a new ReachabilityConfigUI which provides an overview over a certain area of configuration parameters related to the reachability agent.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
private void	addConfigRow(java.lang.String key, PropertyDescription desc) Adds a new row to the users interface, containing the properties type, its value and the possibility to change it.
protected void	addMenu() This method adds a menu to the user interface.
private void	addSubmitRow() Add a new button to submit the data as row to the user interface.
private void	addTopicRow(java.lang.String topic) Adds a new topic row to the user interface.
private java.util.Map<java.lang.String,java.lang.String>	fetchFromComboxBox(javax.swing.JComboBox<java.lang.String> list) Fetches the properties value from a given JComboBox and returns it as Map of String to String.
private java.util.Map<java.lang.String,java.lang.String>	fetchFromTextArea(javax.swing.JTextArea textarea) Fetches the properties value from a given JTextArea and returns it as Map of String to String.
private java.util.Map<java.lang.String,java.lang.String>	fetchFromTextField(javax.swing.JTextField textfield) Fetches the properties value from a given JTextField and returns it as Map of String to String.
JsonRAPropertiesChange	getChangeMsg(java.util.Map<java.lang.String,java.lang.String> properties) Builds up a JsonRAPropertiesChange message to change the values of certain properties.
private java.awt.GridLayout	getGrid(int rowsIn) Returns a user interface grid.
JsonRAPropertiesRequest	getRequestMsg() Builds up a JsonRAPropertiesRequest message to request the current settings for the actual ConfigType.
void	keyReleased(java.awt.event.KeyEvent arg0)
void	refresh(boolean refresh) Builds the user interface.
void	refresh(java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyDescription>> desc, java.lang.String ssr, ReachabilityConfigUIResultListener updater) Fills the panel with (new) informations.
private void	requestConfiguration() Requests the current configuration for the actual ConfigType by sending a JSON message on the AMQ request topic.
private void	sendConfigChange(java.util.Map<java.lang.String,java.lang.String> changed) Sends a new JsonRAPropertiesChange message to change one or more properties to the certain ConfigType by using getChangeMsg(Map) and the ConnectionUtil.
void	shutDown() Shuts the object down.

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, keyTyped, killWindow, loadConfig, loadLocalConfig, mouseClicked, mouseEntered, mouseExited, mousePressed, 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

contentPane

private javax.swing.JPanel contentPane

The content pane of this user interface as JPanel.

internalType

private ConfigType internalType

The type of configuration pane.

serviceStateReference

private java.lang.String serviceStateReference

The current service state reference.

config

private java.util.Map<java.lang.String,java.lang.String> config

The last known configuration.

propertyDesc

private java.util.Map<java.lang.String,PropertyDescription> propertyDesc

The last known property description.

updaters

private java.util.Set<ReachabilityConfigUIResultListener> updaters

Current active updater.

changeConfig

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

The LPPublisher to send the users configuration via the ActiveMQ topic REACHABILITY_CONFIG_CHANGE_TOPIC.

requestConfig

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

The LPPublisher to send the get configuration request REACHABILITY_CONFIG_REQUEST_TOPIC.

Constructor Detail

ReachabilityConfigUI

public ReachabilityConfigUI(javax.swing.JFrame parentWindow,
                    ConfigType type)

Initializes, starts and builds a new ReachabilityConfigUI which provides an overview over a certain area of configuration parameters related to the reachability agent. The user is given also the ability to change these parameters and therefore adapt the system to his or her personal preferences. Furthermore it opens the ActiveMQ connections for communicating with the reachability agent by using JSON messages.

Parameters:

parentWindow - The window from which this interface was created as JFrame.

type - The type of configuration parameters. One out of ConfigType.

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(int rowsIn)

Returns a user interface grid.

Parameters:

rowsIn - Amount of rows to be displayed

Returns:

Returns a user interface grid.

addConfigRow

private void addConfigRow(java.lang.String key,
                PropertyDescription desc)

Adds a new row to the users interface, containing the properties type, its value and the possibility to change it.

Parameters:

key - The properties name as String.

desc - The display parameters of the property as PropertyDescription.

addTopicRow

private void addTopicRow(java.lang.String topic)

Adds a new topic row to the user interface.

Parameters:

topic - The topics name as String.

addSubmitRow

private void addSubmitRow()

Add a new button to submit the data as row to the user interface.

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)

keyReleased

public final void keyReleased(java.awt.event.KeyEvent arg0)

Specified by:

keyReleased in interface java.awt.event.KeyListener

Overrides:

keyReleased in class UI

Parameters:

arg0 - A KeyEvent.

See Also:

KeyListener.keyReleased(java.awt.event.KeyEvent)

fetchFromComboxBox

private java.util.Map<java.lang.String,java.lang.String> fetchFromComboxBox(javax.swing.JComboBox<java.lang.String> list)

Fetches the properties value from a given JComboBox and returns it as Map of String to String.

Parameters:

list - The JComboBox object including options as list of String.

Returns:

The properties value fetched from the given JComboBox as Map of String to String.

fetchFromTextArea

private java.util.Map<java.lang.String,java.lang.String> fetchFromTextArea(javax.swing.JTextArea textarea)

Fetches the properties value from a given JTextArea and returns it as Map of String to String.

Parameters:

textarea - The JTextArea object including the properties new value as String.

Returns:

The properties value fetched from the given JTextArea as Map of String to String.

fetchFromTextField

private java.util.Map<java.lang.String,java.lang.String> fetchFromTextField(javax.swing.JTextField textfield)

Fetches the properties value from a given JTextField and returns it as Map of String to String.

Parameters:

textfield - The JTextField object including the properties new value as String.

Returns:

The properties value fetched from the given JTextField as Map of String to String.

sendConfigChange

private void sendConfigChange(java.util.Map<java.lang.String,java.lang.String> changed)

Sends a new JsonRAPropertiesChange message to change one or more properties to the certain ConfigType by using getChangeMsg(Map) and the ConnectionUtil.

Parameters:

changed - The changed properties as Map of String to String which contains the property names and their new values.

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()

refresh

public final void refresh(boolean refresh)

Builds the user interface. The rendering won't be influenced by the refresh parameter.

Specified by:

refresh in class UI

Parameters:

refresh - Indicates if this method has been called with the intention to re-build the user interface.

refresh

public final void refresh(java.util.Map<java.lang.String,java.lang.String> props,
           java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyDescription>> desc,
           java.lang.String ssr,
           ReachabilityConfigUIResultListener updater)

Fills the panel with (new) informations. Supervises the rendering of the panels content. The method might be only called by the refresh(boolean) method or an ReachabilityConfigUIResultListener for actual configuration informations on refresh.

Parameters:

props - A Map of String to String which shall be rendered changeable as content.

desc - A Map of String to Map of String to PropertyDescription which describes the grouping, output texts and order of the properties.

ssr - The service state reference for change requests as String.

updater - The updater object to be removed from the list of known updater threads (updaters).

requestConfiguration

private void requestConfiguration()

Requests the current configuration for the actual ConfigType by sending a JSON message on the AMQ request topic. Additionally starts a new ReachabilityConfigUIResultListener thread to listen for the response.

getChangeMsg

public final JsonRAPropertiesChange getChangeMsg(java.util.Map<java.lang.String,java.lang.String> properties)

Builds up a JsonRAPropertiesChange message to change the values of certain properties.

Parameters:

properties - The properties which shall be changed as Map of property to value.

Returns:

The JsonRAPropertiesChange message.

getRequestMsg

public final JsonRAPropertiesRequest getRequestMsg()

Builds up a JsonRAPropertiesRequest message to request the current settings for the actual ConfigType.

Returns:

The JsonRAPropertiesRequest message for all properties of the current ConfigType.