Package sim.util.media.chart

Class HistogramGenerator

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

sim.util.media.chart.ChartGenerator

sim.util.media.chart.XYChartGenerator

sim.util.media.chart.HistogramGenerator

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class HistogramGenerator
extends XYChartGenerator

HistogramGenerator is a ChartGenerator which displays a histogram using the JFreeChart library. The generator uses the HistoramDataset as its dataset, which holds histogram elements consisting of a name, an array of doubles (the samples), and an integer (the number of bins). representing a time series displayed on the chart. You add series to the generator with the addSeries method.

HistogramGenerator creates attributes components in the form of HistogramSeriesAttributes, which work with the generator to properly update the chart to reflect changes the user has made to its display.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class sim.util.media.chart.ChartGenerator

ChartGenerator.UniqueString

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

Field Summary

Fields inherited from class sim.util.media.chart.ChartGenerator

chart, chartPanel, DEFAULT_CHART_HEIGHT, DEFAULT_CHART_PROPORTION, FORCE_KEY, globalAttributes, invalidChartTitle, seriesAttributes, validChartTitle

Fields inherited from class javax.swing.JComponent

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

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
HistogramGenerator()

Method Summary

Modifier and Type	Method	Description
SeriesAttributes	addSeries(double[] vals, int bins, String name, org.jfree.data.general.SeriesChangeListener stopper)	Adds a series, plus a (possibly null) SeriesChangeListener which will receive a single event if/when the series is deleted from the chart by the user.
protected void	buildChart()	Override this to construct the appropriate kind of chart.
org.jfree.data.statistics.HistogramType	getHistogramType()
void	moveSeries(int index, boolean up)	Override this to move a series relative to other series.
void	removeSeries(int index)	Override this to remove a series from the chart.
void	setHistogramType(org.jfree.data.statistics.HistogramType type)
protected void	update()
void	updateSeries(int index, double[] vals)

Methods inherited from class sim.util.media.chart.XYChartGenerator

buildGlobalAttributes, getChart, getDomainAxisLabel, getRangeAxisLabel, getSeriesCount, getSeriesDataset, getXAxisLabel, getYAxisLabel, isXAxisLogScaled, isYAxisLogScaled, setDomainAxisLabel, setDomainAxisRange, setRangeAxisLabel, setRangeAxisRange, setSeriesDataset, setXAxisLabel, setXAxisLogScaled, setXAxisRange, setYAxisLabel, setYAxisLogScaled, setYAxisRange

Methods inherited from class sim.util.media.chart.ChartGenerator

addGlobalAttribute, addLegend, buildChartPanel, createFrame, createFrame, createFrame, getChartPanel, getFrame, getGlobalAttribute, getGlobalAttributeCount, getNumGlobalAttributes, getNumSeriesAttributes, getProportion, getScale, getSeriesAttribute, getSeriesAttributes, getTitle, isFixed, quit, removeAllSeries, removeGlobalAttribute, setChartPanel, setFixed, setInvalidChartTitle, setProportion, setScale, setSeriesAttributes, setTitle, startMovie, stopMovie, update, updateChartLater, updateChartWithin

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.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, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, reshape, 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 java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

HistogramGenerator

public HistogramGenerator()

Method Details

removeSeries

public void removeSeries(int index)

Description copied from class: ChartGenerator

Override this to remove a series from the chart. Be sure to call super(...) first.

Overrides:

removeSeries in class ChartGenerator

moveSeries

public void moveSeries(int index,
 boolean up)

Description copied from class: ChartGenerator

Override this to move a series relative to other series. Be sure to call super(...) first.

Overrides:

moveSeries in class ChartGenerator

buildChart

protected void buildChart()

Description copied from class: ChartGenerator

Override this to construct the appropriate kind of chart. This is the first thing called from the constructor; so certain of your instance variables may not have been set yet and you may need to set them yourself. You'll need to set the dataset.

Specified by:

buildChart in class ChartGenerator

update

protected void update()

Overrides:

update in class ChartGenerator

addSeries

public SeriesAttributes addSeries(double[] vals,
 int bins,
 String name,
 org.jfree.data.general.SeriesChangeListener stopper)

Adds a series, plus a (possibly null) SeriesChangeListener which will receive a single event if/when the series is deleted from the chart by the user. Returns the series attributes.

updateSeries

public void updateSeries(int index,
 double[] vals)

setHistogramType

public void setHistogramType(org.jfree.data.statistics.HistogramType type)

getHistogramType

public org.jfree.data.statistics.HistogramType getHistogramType()