uk.ac.ed.epcc.safe.accounting.charts

Class MapperEntry

java.lang.Object

uk.ac.ed.epcc.safe.accounting.charts.MapperEntry

All Implemented Interfaces:

java.lang.Cloneable, uk.ac.ed.epcc.webapp.Contexed

Direct Known Subclasses:

KeyMapperEntry, SetMapperEntry

public abstract class MapperEntry
extends java.lang.Object
implements uk.ac.ed.epcc.webapp.Contexed, java.lang.Cloneable

MapperEntry represents the mapping of UsageRecords to plot set in a chart This class also holds the logic to build charts based on PlotEntry UsageProducer and RecordSelector. Each combination of a MapperEntry and a PlotEntry adds an additional dataset to the chart. If multiple properties are to be added then this should be performed as multiple datasets. Note that the chart quantity is set from the PlotEntry (if not already set). Therefore by default if multiple PlotEntries are added the first one will set the chart Quantity.

Author:

spb

Field Summary

Fields

Modifier and Type	Field and Description
protected uk.ac.ed.epcc.webapp.AppContext	conn

Constructor Summary

Constructors

Constructor and Description
MapperEntry(uk.ac.ed.epcc.webapp.AppContext c, java.lang.String name, java.lang.String description)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compatible(UsageProducer<?> ap)
boolean	equals(java.lang.Object obj)
static MapperEntry	getConfigMapperEntry(uk.ac.ed.epcc.webapp.AppContext conn, uk.ac.ed.epcc.webapp.config.FilteredProperties prop, PropertyFinder finder, java.lang.String name)
static MapperEntry	getConfigMapperEntry(uk.ac.ed.epcc.webapp.AppContext conn, PropertyFinder finder, java.lang.String name)
uk.ac.ed.epcc.webapp.AppContext	getContext()
java.lang.String	getDescription()
protected abstract UsageRecordQueryMapper	getInnerQueryMapper(RecordSelector sel, Reduction red, PropExpression<? extends java.lang.Number> prop_tag, PropertyTag<java.util.Date> start_prop, PropertyTag<java.util.Date> end_prop) Get a QueryMapper that combined records completely within a specified period This is intended to be used as part of an overlap calculation.
protected java.util.Vector<java.lang.String>	getLabels()
abstract uk.ac.ed.epcc.webapp.charts.strategy.SetRangeMapper	getMapper(PlotEntry e)
static java.util.Set<MapperEntry>	getMappers(uk.ac.ed.epcc.webapp.AppContext c, UsageProducer up)
static java.util.Set<MapperEntry>	getMappers(uk.ac.ed.epcc.webapp.AppContext c, UsageProducer up, java.lang.String mode)
static java.util.Set<MapperEntry>	getMapperSet(PropertyFinder finder, uk.ac.ed.epcc.webapp.AppContext c, java.lang.String mode) Get the set of MappeEntrys defined by the config properties
static java.lang.String	getMapType(java.lang.String plot_type, java.util.Set<MapperEntry> list)
java.lang.String	getName()
protected abstract UsageRecordQueryMapper	getOverlapQueryMapper(RecordSelector s, Reduction red, PropExpression<? extends java.lang.Number> prop_tag, PropertyTag<java.util.Date> start_prop, PropertyTag<java.util.Date> end_prop) Get a Query mapper that combined records based on the overlap of records defined by a pair of properties as defined in OverlapHandler
protected abstract UsageRecordQueryMapper	getPointQueryMapper(RecordSelector sel, Reduction red, PropExpression<? extends java.lang.Number> prop_tag, PropertyTag<java.util.Date> end_prop) Get a Query mapper that combined records selected on a single Date Property No ovrelapp is considered.
int	hashCode()
boolean	isCumulative() Should the data be converted to a cummulative plot
boolean	isStacked() Should the data be converted to a stacked plot
uk.ac.ed.epcc.webapp.charts.PeriodSetPlot	makeBarTimeChartPlot(PlotEntry e, uk.ac.ed.epcc.webapp.charts.BarTimeChart tc, UsageProducer ap, RecordSelector sel, int nplots, boolean allow_overlap)
uk.ac.ed.epcc.webapp.charts.PeriodSetPlot	makePieTimeChartPlot(PlotEntry e, uk.ac.ed.epcc.webapp.charts.PieTimeChart tc, UsageProducer ap, RecordSelector sel, int nplots, boolean overlap) Generate a dataset for a PieTimeChart using this mapper.
<P extends uk.ac.ed.epcc.webapp.charts.PeriodSequencePlot> P	makeTimeChartPlot(PlotEntry e, uk.ac.ed.epcc.webapp.charts.TimeChart<P> tc, UsageProducer<?> ap, RecordSelector request_sel, int nplots, boolean allow_overlap, boolean use_line, boolean graph_transforms) Make a dataset for a TimeChart and plot data to it usign this transform.
static java.lang.String	MapSelector(java.lang.String plot_type, java.util.Set<MapperEntry> list) Generate a HTML selector for the possible Mappers
static MapperEntry	parseMapSelector(java.lang.String plot_type, java.util.Set<MapperEntry> list) parse the HTML request for the possible mappers.
boolean	plot(boolean graph_transform, PlotEntry e, uk.ac.ed.epcc.webapp.charts.PeriodChart tc, UsageProducer ap, RecordSelector sel, int nplots, boolean allow_overlap)
boolean	plot(boolean graph_transforms, PlotEntry e, uk.ac.ed.epcc.webapp.charts.TimeChart<?> tc, UsageProducer<?> ap, RecordSelector sel, int nplots, boolean allow_overlap) plot data on a TimeChart using this SimpleMapper
boolean	plot(PlotEntry e, uk.ac.ed.epcc.webapp.charts.BarTimeChart tc, UsageProducer ap, RecordSelector sel, int nplots, boolean allow_overlap) plot data on a PieTimeChart using this mapper
boolean	plot(PlotEntry e, uk.ac.ed.epcc.webapp.charts.PieTimeChart tc, UsageProducer ap, RecordSelector sel, int nplots, boolean overlap) plot data on a PieTimeChart using this mapper
boolean	plot(PlotEntry e, uk.ac.ed.epcc.webapp.charts.TimeChart<?> tc, UsageProducer<?> ap, RecordSelector sel, int nplots, boolean allow_overlap)
<P extends uk.ac.ed.epcc.webapp.charts.PeriodSequencePlot> boolean	plot(PlotEntry e, uk.ac.ed.epcc.webapp.charts.TimeChart<P> tc, UsageProducer<?> ap, RecordSelector request_sel, int nplots, boolean allow_overlap, boolean use_line, boolean graph_transforms) make and plot a single dataset.
void	plotBarTimeChart(PlotEntry e, uk.ac.ed.epcc.webapp.charts.BarTimeChart tc, int nplots, uk.ac.ed.epcc.webapp.charts.SingleValueSetPlot ds)
void	plotPieTimeChart(PlotEntry e, uk.ac.ed.epcc.webapp.charts.PieTimeChart tc, int nplots, uk.ac.ed.epcc.webapp.charts.SingleValueSetPlot ds)
<P extends uk.ac.ed.epcc.webapp.charts.PeriodSequencePlot> void	plotTimeChart(PlotEntry e, uk.ac.ed.epcc.webapp.charts.TimeChart<P> tc, P ds, int nplots, boolean use_line, boolean graph_transforms) Add a dataset to a TimeChart using the category data from this mapper.
void	setColours(java.awt.Color[] custom)
void	setCumulative(boolean cumulative)
protected void	setLegendName(uk.ac.ed.epcc.webapp.charts.Chart tc)
protected void	setQuant(java.lang.String quant, uk.ac.ed.epcc.webapp.charts.PeriodChart tc)
void	setStacked(boolean stacked)
void	setUseLine(boolean use)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

conn

protected final uk.ac.ed.epcc.webapp.AppContext conn

Constructor Detail

MapperEntry

public MapperEntry(uk.ac.ed.epcc.webapp.AppContext c,
           java.lang.String name,
           java.lang.String description)

Method Detail

getContext

public uk.ac.ed.epcc.webapp.AppContext getContext()

Specified by:

getContext in interface uk.ac.ed.epcc.webapp.Contexed

setColours

public void setColours(java.awt.Color[] custom)

setUseLine

public void setUseLine(boolean use)

isCumulative

public boolean isCumulative()

Should the data be converted to a cummulative plot

Returns:

boolean

setCumulative

public void setCumulative(boolean cumulative)

getName

public java.lang.String getName()

isStacked

public boolean isStacked()

Should the data be converted to a stacked plot

Returns:

boolean

setStacked

public void setStacked(boolean stacked)

getDescription

public java.lang.String getDescription()

getMapper

public abstract uk.ac.ed.epcc.webapp.charts.strategy.SetRangeMapper getMapper(PlotEntry e)

getPointQueryMapper

protected abstract UsageRecordQueryMapper getPointQueryMapper(RecordSelector sel,
                                         Reduction red,
                                         PropExpression<? extends java.lang.Number> prop_tag,
                                         PropertyTag<java.util.Date> end_prop)
                                                       throws uk.ac.ed.epcc.webapp.jdbc.filter.CannotUseSQLException

Get a Query mapper that combined records selected on a single Date Property No ovrelapp is considered.

Throws:

uk.ac.ed.epcc.webapp.jdbc.filter.CannotUseSQLException

Parameters:

sel -

red -

prop_tag -

end_prop -

Returns:

getOverlapQueryMapper

protected abstract UsageRecordQueryMapper getOverlapQueryMapper(RecordSelector s,
                                           Reduction red,
                                           PropExpression<? extends java.lang.Number> prop_tag,
                                           PropertyTag<java.util.Date> start_prop,
                                           PropertyTag<java.util.Date> end_prop)
                                                         throws uk.ac.ed.epcc.webapp.jdbc.filter.CannotUseSQLException

Get a Query mapper that combined records based on the overlap of records defined by a pair of properties as defined in OverlapHandler

Throws:

uk.ac.ed.epcc.webapp.jdbc.filter.CannotUseSQLException

Parameters:

s -

red -

prop_tag -

start_prop -

end_prop -

Returns:

getInnerQueryMapper

protected abstract UsageRecordQueryMapper getInnerQueryMapper(RecordSelector sel,
                                         Reduction red,
                                         PropExpression<? extends java.lang.Number> prop_tag,
                                         PropertyTag<java.util.Date> start_prop,
                                         PropertyTag<java.util.Date> end_prop)
                                                       throws uk.ac.ed.epcc.webapp.jdbc.filter.CannotUseSQLException

Get a QueryMapper that combined records completely within a specified period This is intended to be used as part of an overlap calculation.

Throws:

uk.ac.ed.epcc.webapp.jdbc.filter.CannotUseSQLException

Parameters:

sel -

red -

prop_tag -

start_prop -

end_prop -

Returns:

compatible

public boolean compatible(UsageProducer<?> ap)

getLabels

protected java.util.Vector<java.lang.String> getLabels()

makePieTimeChartPlot

public uk.ac.ed.epcc.webapp.charts.PeriodSetPlot makePieTimeChartPlot(PlotEntry e,
                                                             uk.ac.ed.epcc.webapp.charts.PieTimeChart tc,
                                                             UsageProducer ap,
                                                             RecordSelector sel,
                                                             int nplots,
                                                             boolean overlap)
                                                               throws uk.ac.ed.epcc.webapp.charts.InvalidTransformException

Generate a dataset for a PieTimeChart using this mapper.

Throws:

uk.ac.ed.epcc.webapp.charts.InvalidTransformException

Parameters:

e -

tc -

ap -

sel -

nplots -

overlap -

Returns:

dataset or null if no data

plot

public boolean plot(PlotEntry e,
           uk.ac.ed.epcc.webapp.charts.PieTimeChart tc,
           UsageProducer ap,
           RecordSelector sel,
           int nplots,
           boolean overlap)
             throws uk.ac.ed.epcc.webapp.charts.InvalidTransformException

plot data on a PieTimeChart using this mapper

Throws:

uk.ac.ed.epcc.webapp.charts.InvalidTransformException

Parameters:

e -

tc - PieTimeChart

ap -

sel -

nplots - int max number of plots

overlap -

Returns:

boolean true of ok

plotPieTimeChart

public void plotPieTimeChart(PlotEntry e,
                    uk.ac.ed.epcc.webapp.charts.PieTimeChart tc,
                    int nplots,
                    uk.ac.ed.epcc.webapp.charts.SingleValueSetPlot ds)

setQuant

protected void setQuant(java.lang.String quant,
            uk.ac.ed.epcc.webapp.charts.PeriodChart tc)

makeBarTimeChartPlot

public uk.ac.ed.epcc.webapp.charts.PeriodSetPlot makeBarTimeChartPlot(PlotEntry e,
                                                             uk.ac.ed.epcc.webapp.charts.BarTimeChart tc,
                                                             UsageProducer ap,
                                                             RecordSelector sel,
                                                             int nplots,
                                                             boolean allow_overlap)
                                                               throws uk.ac.ed.epcc.webapp.charts.InvalidTransformException

Throws:

uk.ac.ed.epcc.webapp.charts.InvalidTransformException

plot

public boolean plot(PlotEntry e,
           uk.ac.ed.epcc.webapp.charts.BarTimeChart tc,
           UsageProducer ap,
           RecordSelector sel,
           int nplots,
           boolean allow_overlap)
             throws uk.ac.ed.epcc.webapp.charts.InvalidTransformException

plot data on a PieTimeChart using this mapper

Throws:

uk.ac.ed.epcc.webapp.charts.InvalidTransformException

Parameters:

e -

tc - PieTimeChart

ap -

sel -

nplots - int max number of plots

allow_overlap -

Returns:

boolean true of ok

plotBarTimeChart

public void plotBarTimeChart(PlotEntry e,
                    uk.ac.ed.epcc.webapp.charts.BarTimeChart tc,
                    int nplots,
                    uk.ac.ed.epcc.webapp.charts.SingleValueSetPlot ds)

plot

public boolean plot(boolean graph_transform,
           PlotEntry e,
           uk.ac.ed.epcc.webapp.charts.PeriodChart tc,
           UsageProducer ap,
           RecordSelector sel,
           int nplots,
           boolean allow_overlap)
             throws java.lang.Exception

Throws:

java.lang.Exception

plot

public boolean plot(boolean graph_transforms,
           PlotEntry e,
           uk.ac.ed.epcc.webapp.charts.TimeChart<?> tc,
           UsageProducer<?> ap,
           RecordSelector sel,
           int nplots,
           boolean allow_overlap)
             throws java.lang.Exception

plot data on a TimeChart using this SimpleMapper

Throws:

java.lang.Exception

Parameters:

graph_transforms - should transforms that only make sense graphically be applied

e - PlotEntry

tc - timeChart

ap - UsageProducer

sel - RecordSelector

nplots - int max number of plots

allow_overlap -

Returns:

boolean true of ok

plot

public boolean plot(PlotEntry e,
           uk.ac.ed.epcc.webapp.charts.TimeChart<?> tc,
           UsageProducer<?> ap,
           RecordSelector sel,
           int nplots,
           boolean allow_overlap)
             throws java.lang.Exception

Throws:

java.lang.Exception

makeTimeChartPlot

public <P extends uk.ac.ed.epcc.webapp.charts.PeriodSequencePlot> P makeTimeChartPlot(PlotEntry e,
                                                                             uk.ac.ed.epcc.webapp.charts.TimeChart<P> tc,
                                                                             UsageProducer<?> ap,
                                                                             RecordSelector request_sel,
                                                                             int nplots,
                                                                             boolean allow_overlap,
                                                                             boolean use_line,
                                                                             boolean graph_transforms)
                                                                           throws java.lang.Exception

Make a dataset for a TimeChart and plot data to it usign this transform.

Throws:

java.lang.Exception

Parameters:

e -

tc -

ap -

request_sel -

nplots -

allow_overlap -

use_line -

graph_transforms -

Returns:

DataSet or null if no data added

plotTimeChart

public <P extends uk.ac.ed.epcc.webapp.charts.PeriodSequencePlot> void plotTimeChart(PlotEntry e,
                                                                            uk.ac.ed.epcc.webapp.charts.TimeChart<P> tc,
                                                                            P ds,
                                                                            int nplots,
                                                                            boolean use_line,
                                                                            boolean graph_transforms)
                   throws java.lang.Exception

Add a dataset to a TimeChart using the category data from this mapper.

Throws:

java.lang.Exception

Parameters:

e -

tc -

ds -

nplots -

use_line -

graph_transforms -

plot

public <P extends uk.ac.ed.epcc.webapp.charts.PeriodSequencePlot> boolean plot(PlotEntry e,
                                                                      uk.ac.ed.epcc.webapp.charts.TimeChart<P> tc,
                                                                      UsageProducer<?> ap,
                                                                      RecordSelector request_sel,
                                                                      int nplots,
                                                                      boolean allow_overlap,
                                                                      boolean use_line,
                                                                      boolean graph_transforms)
             throws java.lang.Exception

make and plot a single dataset.

Throws:

java.lang.Exception

Parameters:

e -

tc -

ap -

request_sel -

nplots -

allow_overlap -

use_line -

graph_transforms -

Returns:

Plot

setLegendName

protected void setLegendName(uk.ac.ed.epcc.webapp.charts.Chart tc)

MapSelector

public static java.lang.String MapSelector(java.lang.String plot_type,
                           java.util.Set<MapperEntry> list)

Generate a HTML selector for the possible Mappers

Parameters:

plot_type -

list - Vector of MapperEntry

Returns:

String HTML fragment selecting Mappers

getMapType

public static java.lang.String getMapType(java.lang.String plot_type,
                          java.util.Set<MapperEntry> list)

parseMapSelector

public static MapperEntry parseMapSelector(java.lang.String plot_type,
                           java.util.Set<MapperEntry> list)

parse the HTML request for the possible mappers.

Parameters:

plot_type -

list - Vector of MapperEntry

Returns:

MapperEntry

getMapperSet

public static java.util.Set<MapperEntry> getMapperSet(PropertyFinder finder,
                                      uk.ac.ed.epcc.webapp.AppContext c,
                                      java.lang.String mode)

Get the set of MappeEntrys defined by the config properties

Parameters:

finder -

c - AppContext

mode -

Returns:

Set of MapperEntry

getConfigMapperEntry

public static MapperEntry getConfigMapperEntry(uk.ac.ed.epcc.webapp.AppContext conn,
                               PropertyFinder finder,
                               java.lang.String name)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getConfigMapperEntry

public static MapperEntry getConfigMapperEntry(uk.ac.ed.epcc.webapp.AppContext conn,
                               uk.ac.ed.epcc.webapp.config.FilteredProperties prop,
                               PropertyFinder finder,
                               java.lang.String name)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getMappers

public static java.util.Set<MapperEntry> getMappers(uk.ac.ed.epcc.webapp.AppContext c,
                                    UsageProducer up)

getMappers

public static java.util.Set<MapperEntry> getMappers(uk.ac.ed.epcc.webapp.AppContext c,
                                    UsageProducer up,
                                    java.lang.String mode)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object