desmoj.extensions.experimentation.ui

Class ExperimentStarterApplication

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

desmoj.extensions.experimentation.ui.ExperimentStarterApplication

All Implemented Interfaces:

ExperimentStarterGUI, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ExperimentStarterApplication
extends javax.swing.JFrame
implements ExperimentStarterGUI

GUI for the Experiment Starter when used as application.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Nicolas Knaak, Gunnar Kiesel Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also:

Serialized Form

Nested Class Summary

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

java.awt.Window.Type

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

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
ExperimentStarterApplication() Creates a new experiment starter application without loading a model
ExperimentStarterApplication(java.lang.Class modelClass, java.lang.Class expRunnerClass) Creates a new experiment starter application.
ExperimentStarterApplication(java.lang.Class modelClass, java.lang.Class expRunnerClass, java.lang.String[] args) Creates a new experiment starter application with command line parameters passed to the model.
ExperimentStarterApplication(java.lang.String confFileName) Creates a new experiment starter application.

Method Summary

Modifier and Type	Method and Description
void	clockAdvanced(java.lang.String currentTime, double timePercent, long startTime) Called by ExperimentStarter when the currently active experiment's SimClock is advanced
void	jbInit() init the GUI
java.lang.String	loadDialog() opens a Swing dialog to select a configuration file to load from *
java.lang.String	loadDialog(java.lang.String currentFilename) opens a Swing dialog to select a configuration file to load from
void	loadModel() Called by the ExperimentStarter when a new model is loades
static void	main(java.lang.String[] argv) Runs the GUI.
void	resetGUI(java.lang.String filename, boolean runsBatch, AccessPointTableModel modelAccessPoints, AccessPointTableModel expAccessPoints, java.lang.String modelName) Resets the user interface on creating, loading or resetting an experiment.
java.lang.String	saveDialog() opens a Swing dialog to select a configuration file to save in *
java.lang.String	saveDialog(java.lang.String currentFilename) opens a Swing dialog to select a configuration file to save in
void	setPaused() Called when experiment is paused.
void	setRunning() Called when experiment is started or resumed.
void	setStopped(java.lang.String currentTime, long startTime, java.lang.String experimentValues, java.lang.String outputPath, java.lang.String[] appendixes) Called when experiment is stopped.

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, 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, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, 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

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

ExperimentStarterApplication

public ExperimentStarterApplication()

Creates a new experiment starter application without loading a model

ExperimentStarterApplication

public ExperimentStarterApplication(java.lang.Class modelClass,
                                    java.lang.Class expRunnerClass)

Creates a new experiment starter application. The experiment starter dynamically instantiates a model and an experiment runner from the specified classes.

Parameters:

modelClass - the model class to be loaded

expRunnerClass - the experiment runner class to be loaded.

ExperimentStarterApplication

public ExperimentStarterApplication(java.lang.Class modelClass,
                                    java.lang.Class expRunnerClass,
                                    java.lang.String[] args)

Creates a new experiment starter application with command line parameters passed to the model. The experiment starter dynamically instantiates a model and an experiment runner from the specified classes.

Parameters:

modelClass - the model class to be loaded

expRunnerClass - the experiment runner class to be loaded.

args - command line parameters to pass to the model

ExperimentStarterApplication

public ExperimentStarterApplication(java.lang.String confFileName)

Creates a new experiment starter application. On initialization the experiment starter loads the specified experiment configuartion file.

Parameters:

confFileName - Names of the (XML-)configuration file to be loaded.

Method Detail

jbInit

public void jbInit()
            throws java.lang.Exception

init the GUI

Throws:

java.lang.Exception

clockAdvanced

public void clockAdvanced(java.lang.String currentTime,
                          double timePercent,
                          long startTime)

Called by ExperimentStarter when the currently active experiment's SimClock is advanced

Specified by:

clockAdvanced in interface ExperimentStarterGUI

Parameters:

currentTime - String: the current simulation time

timePercent - double: percentage of the simulation done

startTime - long: the start time of the simulation

loadModel

public void loadModel()

Called by the ExperimentStarter when a new model is loades

Specified by:

loadModel in interface ExperimentStarterGUI

loadDialog

public java.lang.String loadDialog()

opens a Swing dialog to select a configuration file to load from *

loadDialog

public java.lang.String loadDialog(java.lang.String currentFilename)

opens a Swing dialog to select a configuration file to load from

Specified by:

loadDialog in interface ExperimentStarterGUI

Parameters:

currentFilename - String: the filename of the configuration in use

saveDialog

public java.lang.String saveDialog()

opens a Swing dialog to select a configuration file to save in *

saveDialog

public java.lang.String saveDialog(java.lang.String currentFilename)

opens a Swing dialog to select a configuration file to save in

Specified by:

saveDialog in interface ExperimentStarterGUI

Parameters:

currentFilename - String: the filename of the configuration in use

resetGUI

public void resetGUI(java.lang.String filename,
                     boolean runsBatch,
                     AccessPointTableModel modelAccessPoints,
                     AccessPointTableModel expAccessPoints,
                     java.lang.String modelName)

Resets the user interface on creating, loading or resetting an experiment.

Specified by:

resetGUI in interface ExperimentStarterGUI

Parameters:

filename - String: the name of the configuration file in use

runsBatch - boolean: true if a batch run is to be made, false for single experiment runs

modelAccessPoints - AccessPointTableModel: the access points for the model settings

expAccessPoints - AccessPointTableModel: the access points for the experiment settings

modelName - Sting: the name of the model in use

setRunning

public void setRunning()

Called when experiment is started or resumed. Implemented for ExperimentListener

Specified by:

setRunning in interface ExperimentStarterGUI

setPaused

public void setPaused()

Called when experiment is paused. Implemented for ExperimentListener

Specified by:

setPaused in interface ExperimentStarterGUI

setStopped

public void setStopped(java.lang.String currentTime,
                       long startTime,
                       java.lang.String experimentValues,
                       java.lang.String outputPath,
                       java.lang.String[] appendixes)

Called when experiment is stopped. Implemented for ExperimentListener

Specified by:

setStopped in interface ExperimentStarterGUI

Parameters:

currentTime - String: the current simulation time

startTime - long: the starting time of the experiment run

experimentValues - String: the current values of the experiment access points

outputPath - String: the path the experiment output is written to

appendixes - String[]: the file endings of the four output files (.html, .txt, .xml)

main

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

Runs the GUI.