jas.graphics.plot
Class CollectionBarPlotter

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      ptolemy.plot.PlotFrame
                          jas.graphics.plot.CollectionBarPlotter

All Implemented Interfaces:

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

public class CollectionBarPlotter
extends ptolemy.plot.PlotFrame
implements ISimEventListener

A bar chart plotter dynamically showing elements in a CrossSection object. It is based on Ptolemy Plot plotter. It is compatible with the jas.stat.* classes.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

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

See Also:

Serialized Form

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

CollectionBarPlotter()
Create a new bar plotter with no title.

CollectionBarPlotter(java.lang.String title)
Create a new bar plotter with given title.

Method Summary

void	addDoubleSeries(java.lang.String name, java.util.Collection source, int valueID) Add a new series buffer, retrieving value from IDoubleSource objects in a collection.
void	addFloatSeries(java.lang.String name, java.util.Collection source, int valueID) Add a new series buffer, retrieving value from IFloatSource objects in a collection.
void	addIntSeries(java.lang.String name, java.util.Collection source, int valueID) Add a new series buffer, retrieving value from IIntSource objects in a collection.
void	addLongSeries(java.lang.String name, java.util.Collection source, int valueID) Add a new series buffer, retrieving value from ILongSource objects in a collection.
void	addSeries(java.lang.String name, java.util.Collection source, java.lang.Class objectClass, java.lang.String valueName, boolean getFromMethod) Add a new series buffer, retrieving value from generic objects in a collection.
void	addSeries(java.lang.String name, CrossSection sequence) Add a new series buffer, retrieving values from the given cross section.
java.lang.String	exportSVG()
void	exportSVGToFile(java.lang.String fileName)
int	getMaxBars() Return the current maximum number of plottable bar.
ptolemy.plot.Plot	getPlot() Return the inner Plot object.
void	performAction(int actionType) Update the plot.
void	setBarLabels(java.util.Collection list) Set the collection from which to take the label for the bars.
void	setMaxBars(int maxBars) Set the maximum number of plottable bar.
void	update() Refresh the plot.

Methods inherited from class ptolemy.plot.PlotFrame

samplePlot

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, update

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, 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, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, 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

CollectionBarPlotter

public CollectionBarPlotter()

Create a new bar plotter with no title.

CollectionBarPlotter

public CollectionBarPlotter(java.lang.String title)

Create a new bar plotter with given title.

Parameters:

title - The title of the frame.

Method Detail

addDoubleSeries

public void addDoubleSeries(java.lang.String name,
                            java.util.Collection source,
                            int valueID)

Add a new series buffer, retrieving value from IDoubleSource objects in a collection.

Parameters:

name - The name of the series, which is shown in the legend.

source - A collection containing the sources.

valueID - The variable id used by the IDoubleSource interface.

addFloatSeries

public void addFloatSeries(java.lang.String name,
                           java.util.Collection source,
                           int valueID)

Add a new series buffer, retrieving value from IFloatSource objects in a collection.

Parameters:

name - The name of the series, which is shown in the legend.

source - A collection containing the sources.

valueID - The variable id used by the IFloatSource interface.

addIntSeries

public void addIntSeries(java.lang.String name,
                         java.util.Collection source,
                         int valueID)

Add a new series buffer, retrieving value from IIntSource objects in a collection.

Parameters:

name - The name of the series, which is shown in the legend.

source - A collection containing the sources.

valueID - The variable id used by the IIntSource interface.

addLongSeries

public void addLongSeries(java.lang.String name,
                          java.util.Collection source,
                          int valueID)

Add a new series buffer, retrieving value from ILongSource objects in a collection.

Parameters:

name - The name of the series, which is shown in the legend.

source - A collection containing the sources.

valueID - The variable id used by the ILongSource interface.

addSeries

public void addSeries(java.lang.String name,
                      java.util.Collection source,
                      java.lang.Class objectClass,
                      java.lang.String valueName,
                      boolean getFromMethod)

Add a new series buffer, retrieving value from generic objects in a collection.

Parameters:

name - The name of the series, which is shown in the legend.

source - A collection containing the sources.

objectClass - The class type of the elements contained in the collection.

valueName - The name of the variable or the method providing the value.

getFromMethod - True if the valueName is a method, false if a variable.

addSeries

public void addSeries(java.lang.String name,
                      CrossSection sequence)

Add a new series buffer, retrieving values from the given cross section.

Parameters:

name - The name of the series, which is shown in the legend.

sequence - A CrossSection object to be used a value source.

exportSVG

public java.lang.String exportSVG()

exportSVGToFile

public void exportSVGToFile(java.lang.String fileName)

getMaxBars

public int getMaxBars()

Return the current maximum number of plottable bar.

Returns:

The current maximum number of bars per series.

getPlot

public ptolemy.plot.Plot getPlot()

Return the inner Plot object.

Returns:

The Ptolemy Plot engine.

performAction

public void performAction(int actionType)

Update the plot.

Specified by:

performAction in interface ISimEventListener

Parameters:

actionType - It is ignored. The only implemented action is update.

setBarLabels

public void setBarLabels(java.util.Collection list)

Set the collection from which to take the label for the bars.

Parameters:

list - a collection containing an ordered list of object describing the bars.

setMaxBars

public void setMaxBars(int maxBars)

Set the maximum number of plottable bar.

update

public void update()

Refresh the plot.