uk.ac.ed.epcc.webapp.charts

Class Chart<P extends Plot>

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.charts.Chart<P>

All Implemented Interfaces:

Contexed

Direct Known Subclasses:

PeriodChart, PieChart, ScatterPeriodChart

public abstract class Chart<P extends Plot>
extends AbstractContexed

Chart is a base class for chart generation. Its essentially a facade class around underlying implementation classes (that implement the ChartData interface) to allow the underlying chart package to be swapped in and out. Useful helper methods that only use the public ChartData interface can live in the Chart object. The data within a chart is represented by an object implementing the SetPlot interface that is generated by the ChartData.

Sub-classes of Chart have correspondng sub-lcasses of ChartData and SetPlot.

The data model is that data is classified into categories/sets. Each set is plotted separately for example as different lines, sectors of a pie-chart or bars on a bar-chart. Charts also support a set of text legends that label the sets.

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Chart(AppContext conn)

Method Summary

Modifier and Type	Method and Description
ChartData<P>	getChartData()
java.lang.String	getLegendName()
P	makeDataset(int nset) create a scratch Plot not connected with any graph
protected void	setChartData(ChartData<P> chart)
void	setLegendName(java.lang.String legendName)
void	sortSets(SetPlot p, double other_frac) Sort the sets of Dataset largest first with small sets mapped to an others category
void	sortSets(SetPlot p, double other_frac, int max_plot) Sort the sets of Dataset largest first with small sets mapped to an others category the legends for the plots are also permuted.
void	sortSets(SetPlot p, int max_plot) Sort the sets of Dataset largest first with small sets mapped to an others category

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

Chart

protected Chart(AppContext conn)

Method Detail

getChartData

public ChartData<P> getChartData()

makeDataset

public final P makeDataset(int nset)
                    throws java.lang.Exception

create a scratch Plot not connected with any graph

Parameters:

nset - int number of sets

Returns:

Plot

Throws:

java.lang.Exception

setChartData

protected void setChartData(ChartData<P> chart)

sortSets

public final void sortSets(SetPlot p,
                           double other_frac)

Sort the sets of Dataset largest first with small sets mapped to an others category

Parameters:

other_frac - fraction of total plot below which a set is mapped to the Others catagory

sortSets

public final void sortSets(SetPlot p,
                           double other_frac,
                           int max_plot)

Sort the sets of Dataset largest first with small sets mapped to an others category the legends for the plots are also permuted. A plot with multiple datasets added may have additional legends so we assume the legends for this dataset are at the end.

Parameters:

other_frac - fraction of total plot below which a set is mapped to the Others catagory

max_plot - maximum number of sets to show including Others. zero implies no limit.

sortSets

public final void sortSets(SetPlot p,
                           int max_plot)

Sort the sets of Dataset largest first with small sets mapped to an others category

Parameters:

max_plot - maximum number of sets to show including Others. zero implies no limit.

getLegendName

public final java.lang.String getLegendName()

setLegendName

public final void setLegendName(java.lang.String legendName)