Class TimeSeriesSimulationPlotter

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JInternalFrame

microsim.gui.plot.TimeSeriesSimulationPlotter

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, EventListener

public class TimeSeriesSimulationPlotter
extends JInternalFrame
implements EventListener

A time series plotter is able to trace one or more data sources over time. It is based on JFreeChart library and uses data sources based on the microsim.statistics.* interfaces.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002-17 Michele Sonnessa and Ross Richardson

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa and Ross Richardson

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JInternalFrame

JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Fields inherited from interface WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
TimeSeriesSimulationPlotter(String title, String yaxis)
TimeSeriesSimulationPlotter(String title, String yaxis, boolean includeLegend, int maxSamples)

Method Summary

Modifier and Type	Method	Description
void	addSeries(String legend, Object target, String variableName, boolean getFromMethod)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, IDoubleSource plottableObject)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, IDoubleSource plottableObject, Color lineColor, boolean shapesFilled, boolean isDashed, Shape shape)	Deprecated, for removal: This API element is subject to removal in a future version.
void	addSeries(String legend, IDoubleSource plottableObject, Enum<?> variableID)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, IDoubleSource plottableObject, Enum<?> variableID, Color lineColor, boolean validation)	Deprecated, for removal: This API element is subject to removal in a future version.
void	addSeries(String legend, IDoubleSource plottableObject, Enum<?> variableID, Color lineColor, boolean shapesFilled, boolean isDashed, Shape shape)	Deprecated, for removal: This API element is subject to removal in a future version.
void	addSeries(String legend, IFloatSource plottableObject)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, IFloatSource plottableObject, Enum<?> variableID)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, IIntSource plottableObject)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, IIntSource plottableObject, Enum<?> variableID)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, ILongSource plottableObject)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSeries(String legend, ILongSource plottableObject, Enum<?> variableID)	Deprecated, for removal: This API element is subject to removal in a future version. Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.
void	addSource(String legend, Supplier<? extends Number> source)	Add a value source.
void	addSource(String legend, Supplier<? extends Number> source, Color lineColor, boolean validation)	Add a value source and set plotting properties for validation plot.
void	addSource(String legend, Supplier<? extends Number> source, Color lineColor, boolean shapesFilled, boolean isDashed, Shape shape)	Add a value source and set some plotting properties.
int	getMaxSamples()	Max samples parameters allow to define a maximum number of points.
org.jfree.chart.renderer.xy.XYLineAndShapeRenderer	getRenderer()
void	onEvent(Enum<?> type)
void	setMaxSamples(int maxSamples)	Set the max sample parameter.
void	setRenderer(org.jfree.chart.renderer.xy.XYLineAndShapeRenderer renderer)

Methods inherited from class JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, updateUI

Methods inherited from class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

Methods inherited from class Component

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

Methods inherited from class Object

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

Constructor Details

TimeSeriesSimulationPlotter

public TimeSeriesSimulationPlotter(String title,
 String yaxis)

TimeSeriesSimulationPlotter

public TimeSeriesSimulationPlotter(String title,
 String yaxis,
 boolean includeLegend,
 int maxSamples)

Method Details

addSource

public void addSource(String legend,
 Supplier<? extends Number> source)

Add a value source.

Parameters:

legend - Name of the series.

source - The source of values.

addSource

public void addSource(String legend,
 Supplier<? extends Number> source,
 Color lineColor,
 boolean shapesFilled,
 boolean isDashed,
 Shape shape)

Add a value source and set some plotting properties.

Parameters:

legend - Name of the series.

source - The source of values.

lineColor - The color of the line.

shapesFilled - whether to fill the markers.

isDashed - whether the line is dashed.

shape - what shape to use for markers.

addSource

public void addSource(String legend,
 Supplier<? extends Number> source,
 Color lineColor,
 boolean validation)

Add a value source and set plotting properties for validation plot.

Parameters:

legend - Name of the series.

source - The source of values.

lineColor - The color of the line.

validation - Switch between two plotting styles for validation.

onEvent

public void onEvent(Enum<?> type)

Specified by:

onEvent in interface EventListener

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IDoubleSource plottableObject)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series retrieving data from a IDoubleSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IDoubleSource interface.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IDoubleSource plottableObject,
 Color lineColor,
 boolean shapesFilled,
 boolean isDashed,
 Shape shape)

Deprecated, for removal: This API element is subject to removal in a future version.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IDoubleSource plottableObject,
 Enum<?> variableID)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series retrieving data from a IDoubleSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IDoubleSource interface.

variableID - The variable id of the source object.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IDoubleSource plottableObject,
 Enum<?> variableID,
 Color lineColor,
 boolean shapesFilled,
 boolean isDashed,
 Shape shape)

Deprecated, for removal: This API element is subject to removal in a future version.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IDoubleSource plottableObject,
 Enum<?> variableID,
 Color lineColor,
 boolean validation)

Deprecated, for removal: This API element is subject to removal in a future version.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IFloatSource plottableObject)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series from a IFloatSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IFloatSource interface.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IFloatSource plottableObject,
 Enum<?> variableID)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series from a IFloatSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IFloatSource interface.

variableID - The variable id of the source object.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 ILongSource plottableObject)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series from a ILongSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the ILongSource interface.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 ILongSource plottableObject,
 Enum<?> variableID)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series from a ILongSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IDblSource interface.

variableID - The variable id of the source object.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IIntSource plottableObject)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series from a IIntSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IIntSource interface.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 IIntSource plottableObject,
 Enum<?> variableID)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series from a IIntSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IIntSource interface.

variableID - The variable id of the source object.

addSeries

@Deprecated(forRemoval=true)
public void addSeries(String legend,
 Object target,
 String variableName,
 boolean getFromMethod)

Deprecated, for removal: This API element is subject to removal in a future version.

Use addSource(java.lang.String,java.util.function.Supplier<? extends java.lang.Number>) instead.

Build a series from a generic object.

Parameters:

legend - The legend name of the series.

target - The data source object.

variableName - The variable or method name of the source object.

getFromMethod - Specifies if the variableName is a field or a method.

getMaxSamples

public int getMaxSamples()

Max samples parameters allow to define a maximum number of points. When set the plotting window shifts automatically along with time.

setMaxSamples

public void setMaxSamples(int maxSamples)

Set the max sample parameter.

Parameters:

maxSamples - Maximum number of time-steps rendered on x axis.

getRenderer

public org.jfree.chart.renderer.xy.XYLineAndShapeRenderer getRenderer()

setRenderer

public void setRenderer(org.jfree.chart.renderer.xy.XYLineAndShapeRenderer renderer)