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

Class PlotEntry

java.lang.Object

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

public class PlotEntry
extends java.lang.Object

Class defining the quantity to plot and how it should be mapped to time periods. If both time properties are set then the value should be overlapped

Author:

spb

Constructor Summary

Constructors

Constructor and Description
PlotEntry(PropExpression<? extends java.lang.Number> prop, PlotEntry norm, PropertyTag<java.util.Date> start, PropertyTag<java.util.Date> end, java.lang.String name, java.lang.String desc)
PlotEntry(PropExpression<? extends java.lang.Number> prop, PropertyTag<java.util.Date> start, PropertyTag<java.util.Date> end, java.lang.String name, java.lang.String desc)
PlotEntry(PropExpression<? extends java.lang.Number> prop, PropertyTag<java.util.Date> target, java.lang.String name, java.lang.String desc)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compatible(UsageProducer<?> ap)
static PlotEntry	getConfigPlotEntry(uk.ac.ed.epcc.webapp.AppContext conn, uk.ac.ed.epcc.webapp.config.FilteredProperties prop, PropertyFinder finder, java.lang.String name, java.lang.String start, java.lang.String end) Get a PlotEntry from properties
static PlotEntry	getConfigPlotEntry(uk.ac.ed.epcc.webapp.AppContext c, PropertyFinder finder, java.lang.String name, java.lang.String start, java.lang.String end)
long	getCutoff() Get a cutoff length in milliseconds.
java.lang.String	getDescription()
PropertyTag<java.util.Date>	getEndProperty() Get PropertyTag defining the end of the active period for this record.
java.lang.String	getLabel() Get the Quantity axis label to use for this plot (if any).
static java.util.Set<PlotEntry>	getMappers(uk.ac.ed.epcc.webapp.AppContext c, UsageProducer up)
static java.lang.String	getMapType(java.lang.String plot_type, java.util.Set<PlotEntry> list)
java.lang.String	getName()
PropExpression<? extends java.lang.Number>	getPlotProperty() Property to plot
static java.util.Set<PlotEntry>	getPlotSet(PropertyFinder finder, uk.ac.ed.epcc.webapp.AppContext c) Get the set of PlotEntrys defined by the config properties
static java.util.Set<PlotEntry>	getPlotSet(PropertyFinder finder, uk.ac.ed.epcc.webapp.AppContext c, java.lang.String tag)
Reduction	getReduction()
double	getScale() Get the multiplicative scale factor to convert this plot into the desired units.
PlotEntry	getScaleEntry() get a PlotEntry corresponding to the normalisation expression.
PropertyTag<java.util.Date>	getStartProperty() Get PropertyTag defining start of active period.
double	getTimeScale() Get the size of the desired time units (in milliseconds).
java.lang.String	getTimeUnit() Get name of time unit to use in RateScale plots.
boolean	isRateScale() Should TimeChart data be scaled according to size of plot periods.
static java.lang.String	MapSelector(java.lang.String plot_type, java.util.Set<PlotEntry> list) Deprecated.
static PlotEntry	parseMapSelector(java.lang.String plot_type, java.util.Set<PlotEntry> list) Deprecated.
void	setCutoff(long cutoff)
void	setLabel(java.lang.String label)
void	setRateScale(boolean rate_scale)
void	setReduction(Reduction op)
void	setScale(double scale)
void	setTimeScale(double time_scale)
void	setTimeUnit(java.lang.String time_unit)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlotEntry

public PlotEntry(PropExpression<? extends java.lang.Number> prop,
         PlotEntry norm,
         PropertyTag<java.util.Date> start,
         PropertyTag<java.util.Date> end,
         java.lang.String name,
         java.lang.String desc)

PlotEntry

public PlotEntry(PropExpression<? extends java.lang.Number> prop,
         PropertyTag<java.util.Date> start,
         PropertyTag<java.util.Date> end,
         java.lang.String name,
         java.lang.String desc)

PlotEntry

public PlotEntry(PropExpression<? extends java.lang.Number> prop,
         PropertyTag<java.util.Date> target,
         java.lang.String name,
         java.lang.String desc)

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getPlotProperty

public PropExpression<? extends java.lang.Number> getPlotProperty()

Property to plot

Returns:

PropertyTag

getScaleEntry

public PlotEntry getScaleEntry()

get a PlotEntry corresponding to the normalisation expression.

Returns:

PlotEntry

getStartProperty

public PropertyTag<java.util.Date> getStartProperty()

Get PropertyTag defining start of active period. This can be null indicating that overlap scaling should not be used.

Returns:

PropertyTag

getEndProperty

public PropertyTag<java.util.Date> getEndProperty()

Get PropertyTag defining the end of the active period for this record.

Returns:

PropertyTag

getCutoff

public long getCutoff()

Get a cutoff length in milliseconds. When using overlap scaling the code can optimise based on the assumption that no record has an active period longer than this.

Returns:

long milliseconds.

setCutoff

public void setCutoff(long cutoff)

getLabel

public java.lang.String getLabel()

Get the Quantity axis label to use for this plot (if any).

Returns:

String

setLabel

public void setLabel(java.lang.String label)

getScale

public double getScale()

Get the multiplicative scale factor to convert this plot into the desired units. In practice it is often easier to use a PropExpression for this

Returns:

double

setScale

public void setScale(double scale)

getReduction

public Reduction getReduction()

setReduction

public void setReduction(Reduction op)

getTimeScale

public double getTimeScale()

Get the size of the desired time units (in milliseconds). only applies is RateScale is enabled.

Returns:

double number of milliseconds in time unit

setTimeScale

public void setTimeScale(double time_scale)

isRateScale

public boolean isRateScale()

Should TimeChart data be scaled according to size of plot periods. This converts the quantity to a rate.

Returns:

boolean

setRateScale

public void setRateScale(boolean rate_scale)

getTimeUnit

public java.lang.String getTimeUnit()

Get name of time unit to use in RateScale plots.

Returns:

String or null

setTimeUnit

public void setTimeUnit(java.lang.String time_unit)

compatible

public boolean compatible(UsageProducer<?> ap)

MapSelector

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

Deprecated.

Generate a HTML selector for the possible PlotEntries

Parameters:

plot_type -

list - Vector of MapperEntry

Returns:

String HTML fragment selecting PlotEntries

getMapType

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

parseMapSelector

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

Deprecated.

parse the HTML request for the possible mappers.

Parameters:

plot_type -

list - Vector of MapperEntry

Returns:

MapperEntry

getPlotSet

public static java.util.Set<PlotEntry> getPlotSet(PropertyFinder finder,
                                  uk.ac.ed.epcc.webapp.AppContext c)

Get the set of PlotEntrys defined by the config properties

Parameters:

finder -

c - AppContext

Returns:

Set of PlotEntry

getPlotSet

public static java.util.Set<PlotEntry> getPlotSet(PropertyFinder finder,
                                  uk.ac.ed.epcc.webapp.AppContext c,
                                  java.lang.String tag)

getConfigPlotEntry

public static PlotEntry getConfigPlotEntry(uk.ac.ed.epcc.webapp.AppContext c,
                           PropertyFinder finder,
                           java.lang.String name,
                           java.lang.String start,
                           java.lang.String end)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getConfigPlotEntry

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

Get a PlotEntry from properties

Throws:

java.lang.Exception

Parameters:

conn - AppContext

prop - FilteredProperties

finder - PropertyFinder

name -

start - default start prop name if not in prop

end - default end prop name if not in prop

Returns:

PlotEntry

getMappers

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object