org.primordion.xholon.io
Interface IHistogramViewer

All Known Implementing Classes:

AbstractHistogramViewer, HistogramViewerGnuplot, HistogramViewerJFreeChart

public interface IHistogramViewer

This interface should be implemented by concrete classes that capture data, and display the data in a histogram.

Since:

0.6 (Created on May 2, 2007)

Author:

Ken Webb

Method Summary

void	chart() Produce a histogram chart.
void	chart(double[] values) Produce a histogram chart.
void	initialize(IXholon histRootModel, IXholon histRootView, IXholonClass xhClass, int numBins, int nameConcatLevels) Initialize the histogram viewer.
void	remove() Remove the chart from the screen.
void	setXRange(double min, double max) Set the X range of the histogram.
void	setYRange(double min, double max) Set the Y range of the histogram.

Method Detail

chart

public void chart(double[] values)

Produce a histogram chart.

Parameters:

values - Values that will be grouped into bins and displayed as a histogram.

chart

public void chart()

Produce a histogram chart.

initialize

public void initialize(IXholon histRootModel,
                       IXholon histRootView,
                       IXholonClass xhClass,
                       int numBins,
                       int nameConcatLevels)

Initialize the histogram viewer.

Parameters:

histRootModel - The root node of a Xholon subtree in the model, that will be traversed looking for instances of the xholon class.

histRootView - Root node in the view. This is the "HistogramViewer" node.

xhClass - A Xholon class whose instances will be queried for values, using getVal().

numBins - Number of bins.

nameConcatLevels - Number of composite levels to concatenate in deriving name.

setXRange

public void setXRange(double min,
                      double max)

Set the X range of the histogram.

Parameters:

min - Minimum cutoff value to show in the chart.

max - Maximum cutoff value to show in the chart.

setYRange

public void setYRange(double min,
                      double max)

Set the Y range of the histogram.

Parameters:

min - Minimum cutoff value to show in the chart.

max - Maximum cutoff value to show in the chart.

remove

public void remove()

Remove the chart from the screen.