uk.ac.ed.epcc.safe.accounting.reports

Class ChartExtension

java.lang.Object

uk.ac.ed.epcc.safe.accounting.reports.SelectBuilder

uk.ac.ed.epcc.safe.accounting.reports.ReportExtension

uk.ac.ed.epcc.safe.accounting.reports.ChartExtension

All Implemented Interfaces:

TemplateValidator, uk.ac.ed.epcc.webapp.Contexed

Direct Known Subclasses:

CidChartExtension, CommandLineImageExtension, ServeDataChartExtension, SVGChartExtension, TableChartExtension

public abstract class ChartExtension
extends ReportExtension

This is a class used to add Plots via a XSLT extension. An instance is passed in as a parameter and methods are invoked to generate a plot The chart creation, add data and format operations are implemented as separate operations to allow the extension to also format charts generated independently by custom extensions. The XML parsing is slightly more forgiving than the schema as it does not enforce element ordering but this is difficult to encode in the schema.

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChartExtension.Chart<P extends uk.ac.ed.epcc.webapp.charts.PeriodChart> composite object holding the PeriodChart and a record if any data has been added

Field Summary

Fields inherited from class uk.ac.ed.epcc.safe.accounting.reports.ReportExtension

DAY, df, END_TIME, EXPRESSION_PREFIX, FILTER_ELEMENT, FILTER_LOC, FORMATTER_PREFIX, HOUR, MINUTE, MONTH, nf, NUMBER_OF_SPLIT_UNITS, NUMBER_OF_SPLITS, params, PERIOD_ELEMENT, PERIOD_NS, PRODUCER_ELEMENT, SECOND, SPLIT_UNIT, START_TIME, timestampFormat, WEEK, YEAR

Fields inherited from class uk.ac.ed.epcc.safe.accounting.reports.SelectBuilder

conn, DESCENDING_ATTR, FILTER_AND_ELEMENT, FILTER_CONTAINER_ELEMENT, FILTER_EQ_ELEMENT, FILTER_NOT_NULL_ELEMENT, FILTER_NULL_ELEMENT, FILTER_OR_ELEMENT, FILTER_ORDER_BY_ELEMENT, FILTER_PRODUCER_ELEMENT, FORMAT_ATTR, parse_vis, PROPERTY_ELEMENT, TIME_BOUNDS_ELEMENT, VALUE_ELEMENT

Constructor Summary

Constructors

Constructor and Description
ChartExtension(uk.ac.ed.epcc.webapp.AppContext c, java.text.NumberFormat nf)

Method Summary

Methods

Modifier and Type	Method and Description
abstract org.w3c.dom.DocumentFragment	addChart(ChartExtension.Chart chart, java.lang.String caption)
org.w3c.dom.DocumentFragment	addChartTable(ChartExtension.Chart chart, java.lang.String caption)
org.w3c.dom.DocumentFragment	addPlot(RecordSet set, ChartExtension.Chart<?> chart, org.w3c.dom.Node node) Add a plot to the chart.
MapperEntry	getMapperEntry(PlotEntry p, PropertyFinder finder, org.w3c.dom.Element e)
PlotEntry	getPlotEntry(PropertyFinder finder, org.w3c.dom.Element e)
abstract boolean	graphOutput()
boolean	hasData(ChartExtension.Chart c)
ChartExtension.Chart<uk.ac.ed.epcc.webapp.charts.BarTimeChart>	makeBarTimeChart(uk.ac.ed.epcc.webapp.time.Period period, org.w3c.dom.Node node)
ChartExtension.Chart<uk.ac.ed.epcc.webapp.charts.PieTimeChart>	makePieTimeChart(uk.ac.ed.epcc.webapp.time.Period period, org.w3c.dom.Node node)
ChartExtension.Chart<uk.ac.ed.epcc.webapp.charts.TimeChart>	makeTimeChart(uk.ac.ed.epcc.webapp.time.Period period, org.w3c.dom.Node node)

Methods inherited from class uk.ac.ed.epcc.safe.accounting.reports.ReportExtension

addDeveloperError, addError, addError, addError, addFilterElement, addReference, checkNode, convert, debug, display, displayByClass, empty, format, format, formatByClass, formatObject, getBooleanParam, getDefaultTableFormatPolicy, getDocument, getErrors, getExpression, getFormatter, getFormParameter, getIntParam, getIntParamNS, getNumberParam, getParameterRef, getParamExpressionValue, getProperty, getPropertyExpression, getSelectClause, getTag, getTag, getTag, getTag, getValue, hasParam, hasParameterRef, makePeriod, makeString, parseNumber, parseNumberWithDef, setParams, setTime, setUseReference

Methods inherited from class uk.ac.ed.epcc.safe.accounting.reports.SelectBuilder

getAttribute, getContext, getDateProperties, getExpression, getParam, getParamElement, getParamElementNS, getParamNS, getParamNSWithDefault, getParamWithDefault, getRecordSelectElement, getText, getValueParser, getValueParser, hasChild, parse, setPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Constructor Detail

ChartExtension

public ChartExtension(uk.ac.ed.epcc.webapp.AppContext c,
              java.text.NumberFormat nf)
               throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

Method Detail

hasData

public boolean hasData(ChartExtension.Chart c)

getPlotEntry

public PlotEntry getPlotEntry(PropertyFinder finder,
                     org.w3c.dom.Element e)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getMapperEntry

public MapperEntry getMapperEntry(PlotEntry p,
                         PropertyFinder finder,
                         org.w3c.dom.Element e)
                           throws java.lang.Exception

Throws:

java.lang.Exception

makeTimeChart

public ChartExtension.Chart<uk.ac.ed.epcc.webapp.charts.TimeChart> makeTimeChart(uk.ac.ed.epcc.webapp.time.Period period,
                                                                        org.w3c.dom.Node node)

addPlot

public org.w3c.dom.DocumentFragment addPlot(RecordSet set,
                                   ChartExtension.Chart<?> chart,
                                   org.w3c.dom.Node node)

Add a plot to the chart. This method returns a DocumentFragment that is added to the output document. This is to ensure the stylesheet processor will not optimise away the operation. Normally no output is returned but this might be used to add debugging output to the result.

Parameters:

set -

chart -

node -

Returns:

DocumentFragment

makePieTimeChart

public ChartExtension.Chart<uk.ac.ed.epcc.webapp.charts.PieTimeChart> makePieTimeChart(uk.ac.ed.epcc.webapp.time.Period period,
                                                                              org.w3c.dom.Node node)

makeBarTimeChart

public ChartExtension.Chart<uk.ac.ed.epcc.webapp.charts.BarTimeChart> makeBarTimeChart(uk.ac.ed.epcc.webapp.time.Period period,
                                                                              org.w3c.dom.Node node)

addChartTable

public org.w3c.dom.DocumentFragment addChartTable(ChartExtension.Chart chart,
                                         java.lang.String caption)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

addChart

public abstract org.w3c.dom.DocumentFragment addChart(ChartExtension.Chart chart,
                                    java.lang.String caption)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

graphOutput

public abstract boolean graphOutput()