Package com.illumon.iris.db.plot.chartmodifiers

Class OneClickChartModifier<T>

java.lang.Object

com.illumon.iris.db.plot.chartmodifiers.OneClickChartModifier<T>

All Implemented Interfaces:

SwappableTable.LocalTableUpdateListener, Serializable

Direct Known Subclasses:

OneClickChartModifierSwing

public abstract class OneClickChartModifier<T>
extends Object
implements SwappableTable.LocalTableUpdateListener, Serializable

Framework for a class which modifies a chart on a OneClick event

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OneClickChartModifier.VisibilityLevel	At what level in the Figure hierarchy the series of a plot will be restricted, e.g.
static interface	OneClickChartModifier.VisibilityRestricter	Hides series from being drawn until a OneClick event is fired.

Constructor Summary

Constructors

Constructor	Description
OneClickChartModifier(SwappableTable t, String valueColumn, OneClickChartModifier.VisibilityLevel visibilityLevel, PlotInfo plotInfo)	Creates a OneClickChartModifier instance.

Method Summary

Modifier and Type	Method	Description
protected abstract T	convertTableValue(Object o)	The value in the table is read as an object and must be converted to the parameterized type T
PlotInfo	getPlotInfo()
String	getValueColumn()
OneClickChartModifier.VisibilityLevel	getVisibilityLevel()
protected abstract void	modifyChart(T columnValue)	Modifies the chart with the columnValue
void	onClose()	Cleans up table references and listeners.
void	onLocalTableUpdate(Table localTable)	Updates this listener with the new table.
protected abstract void	onNullLocalTable()	Called in onLocalTableUpdate(com.illumon.iris.db.tables.Table) when the table parameter is null.
protected void	redraw()	Redraw the chart.
void	setGovernor(LambdaGovernor governor)
void	setVisibilityRestricter(OneClickChartModifier.VisibilityRestricter visibilityRestricter)	Sets the OneClickChartModifier.VisibilityRestricter

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.plot.util.tables.SwappableTable.LocalTableUpdateListener

onInitialSnapshot

Constructor Details

OneClickChartModifier

public OneClickChartModifier(SwappableTable t, String valueColumn, OneClickChartModifier.VisibilityLevel visibilityLevel, PlotInfo plotInfo)

Creates a OneClickChartModifier instance. Adds itself as a SwappableTable.LocalTableUpdateListener to the given swappable table t.

Parameters:

t - swappable table

valueColumn - column of swappable table

visibilityLevel - which series to hide before a OneClick event, e.g. AXIS will hide all series for the given axis

plotInfo - info for exceptions

Method Details

getVisibilityLevel

public OneClickChartModifier.VisibilityLevel getVisibilityLevel()

Returns:

the visibility level

setVisibilityRestricter

public void setVisibilityRestricter(OneClickChartModifier.VisibilityRestricter visibilityRestricter)

Sets the OneClickChartModifier.VisibilityRestricter

Parameters:

visibilityRestricter - limits which series are displayed prior to chart drawing

setGovernor

public void setGovernor(LambdaGovernor governor)

onLocalTableUpdate

public void onLocalTableUpdate(Table localTable)

Description copied from interface: SwappableTable.LocalTableUpdateListener

Updates this listener with the new table.

Specified by:

onLocalTableUpdate in interface SwappableTable.LocalTableUpdateListener

Parameters:

localTable - table

getValueColumn

public String getValueColumn()

Returns:

the value column

getPlotInfo

public PlotInfo getPlotInfo()

Returns:

the plot info

onClose

public void onClose()

Cleans up table references and listeners.

convertTableValue

protected abstract T convertTableValue(Object o)

The value in the table is read as an object and must be converted to the parameterized type T

Parameters:

o - table value

Returns:

o converted to type T

onNullLocalTable

protected abstract void onNullLocalTable()

Called in onLocalTableUpdate(com.illumon.iris.db.tables.Table) when the table parameter is null.

redraw

protected void redraw()

Redraw the chart. Delegated to the OneClickChartModifier.VisibilityRestricter by default.

modifyChart

protected abstract void modifyChart(T columnValue)

Modifies the chart with the columnValue

Parameters:

columnValue - the value in row 0 of the table from the OneClick event