uk.ac.ed.epcc.webapp.charts

Class TimeChart<P extends PeriodSequencePlot>

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.charts.Chart

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

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

Type Parameters:

P - Type of Plot

All Implemented Interfaces:

Contexed

public class TimeChart<P extends PeriodSequencePlot>
extends PeriodChart<P>

A helper class used to make graphs Basic constructors define the time range, We then use call methods that add additional plots these return the PeriodSequencePlot so we can add data with the addData methods.

The number of points to plot is ultimately chosen by the implementing package but the the TimePeriod is specified as a SplitTimePeriod and a guidance parameter indicates roughly the number of points that should be within each split of the period. The period splits should also give an indication of the desired frequency of the time axis labels and of columns in the table representation

The model is that Object classes can implement a method to add additional plots to a TimeChart Note that we don't assume the major time ticks are necessarily the same length this allows us to plot on month boundaries etc.

Field Summary

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

conn

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimeChart(AppContext c)

Method Summary

Modifier and Type	Method and Description
P	addAreaGraph(int nSet) add a solid area graph to the timechart and return the dataset so values can be added
P	addAreaGraph(int nSet, java.awt.Color[] custom)
P	addAreaGraph(P p, java.awt.Color[] custom)
P	addAreaGraph(java.lang.String[] new_legends) add a solid area graph with lables to the timechart and return the dataset so values can be added
P	addLineGraph(int nSet)
P	addLineGraph(int nSet, java.awt.Color[] custom)
P	addLineGraph(P p, java.awt.Color[] custom)
P	addLineGraph(java.lang.String[] new_legends) add a line graph returning the dataset so data can be added
P	addLineGraph(java.lang.String[] new_legends, java.awt.Color[] colours) add a line graph returning the dataset so data can be added
void	addWarningLevel(double value)
TimeChartData<P>	getChartData()
static TimeChart	getInstance(AppContext c, java.util.Calendar s, java.util.Calendar e, int major, int minor)
static TimeChart	getInstance(AppContext conn, java.util.Calendar start, java.util.Calendar end, int field, int count, int minor) generate a timechart with splits at multiples of a Calendar field number of major splits is calculated so as to include the end time.
static TimeChart	getInstance(AppContext conn, java.util.Calendar c, int field, int count, int major, int minor) Create TimeChart with splits at multiples of a Calendar field
static TimeChart	getInstance(AppContext c, java.util.Date s, java.util.Date e, int major, int minor)
static TimeChart	getInstance(AppContext c, SplitTimePeriod p, int minor)
Table	getTable() Generate a table representing the Chart

Methods inherited from class uk.ac.ed.epcc.webapp.charts.PeriodChart

addData, addDataArray, addDataIterator, addMapData, getEndDate, getPeriod, getStartDate

Methods inherited from class uk.ac.ed.epcc.webapp.charts.Chart

getLegendName, makeDataset, setChartData, setLegendName, sortSets, sortSets, sortSets

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

TimeChart

protected TimeChart(AppContext c)

Method Detail

getChartData

public TimeChartData<P> getChartData()

Overrides:

getChartData in class PeriodChart<P extends PeriodSequencePlot>

addAreaGraph

public P addAreaGraph(int nSet)
               throws java.lang.Exception

add a solid area graph to the timechart and return the dataset so values can be added

Parameters:

nSet -

Returns:

Dataset

Throws:

java.lang.Exception

addAreaGraph

public P addAreaGraph(P p,
                      java.awt.Color[] custom)
               throws java.lang.Exception

Throws:

java.lang.Exception

addAreaGraph

public P addAreaGraph(int nSet,
                      java.awt.Color[] custom)
               throws java.lang.Exception

Throws:

java.lang.Exception

addAreaGraph

public P addAreaGraph(java.lang.String[] new_legends)
               throws java.lang.Exception

add a solid area graph with lables to the timechart and return the dataset so values can be added

Parameters:

new_legends -

Returns:

DataSet

Throws:

java.lang.Exception

addLineGraph

public P addLineGraph(int nSet)
               throws java.lang.Exception

Throws:

java.lang.Exception

addLineGraph

public P addLineGraph(P p,
                      java.awt.Color[] custom)
               throws java.lang.Exception

Throws:

java.lang.Exception

addLineGraph

public P addLineGraph(int nSet,
                      java.awt.Color[] custom)
               throws java.lang.Exception

Throws:

java.lang.Exception

addLineGraph

public P addLineGraph(java.lang.String[] new_legends)
               throws java.lang.Exception

add a line graph returning the dataset so data can be added

Parameters:

new_legends -

Returns:

Dataset

Throws:

java.lang.Exception

addLineGraph

public P addLineGraph(java.lang.String[] new_legends,
                      java.awt.Color[] colours)
               throws java.lang.Exception

add a line graph returning the dataset so data can be added

Parameters:

new_legends -

colours -

Returns:

Dataset

Throws:

java.lang.Exception

getTable

public Table getTable()

Description copied from class: PeriodChart

Generate a table representing the Chart

Specified by:

getTable in class PeriodChart<P extends PeriodSequencePlot>

Returns:

a Table

addWarningLevel

public void addWarningLevel(double value)

getInstance

public static TimeChart getInstance(AppContext c,
                                    java.util.Calendar s,
                                    java.util.Calendar e,
                                    int major,
                                    int minor)
                             throws InvalidArgument

Throws:

InvalidArgument

getInstance

public static TimeChart getInstance(AppContext conn,
                                    java.util.Calendar start,
                                    java.util.Calendar end,
                                    int field,
                                    int count,
                                    int minor)
                             throws InvalidArgument

generate a timechart with splits at multiples of a Calendar field number of major splits is calculated so as to include the end time.

Parameters:

conn -

start - start time

end - minimum end time

field - field to use

count - multiples of field in major step

minor - number of minor steps.

Returns:

TimeChart

Throws:

InvalidArgument

getInstance

public static TimeChart getInstance(AppContext conn,
                                    java.util.Calendar c,
                                    int field,
                                    int count,
                                    int major,
                                    int minor)
                             throws InvalidArgument

Create TimeChart with splits at multiples of a Calendar field

Parameters:

conn -

c - start time

field - which Calendar field to use

count - multiples of field per major division

major - number of major divisions

minor - number of minor divisions.

Returns:

TimeChart

Throws:

InvalidArgument

getInstance

public static TimeChart getInstance(AppContext c,
                                    java.util.Date s,
                                    java.util.Date e,
                                    int major,
                                    int minor)
                             throws InvalidArgument

Throws:

InvalidArgument

getInstance

public static TimeChart getInstance(AppContext c,
                                    SplitTimePeriod p,
                                    int minor)
                             throws InvalidArgument

Parameters:

c - AppContext

p - SplitPeriod

minor -

Returns:

TimeChart

Throws:

InvalidArgument