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

Class ParameterExtension

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.ParameterExtension

All Implemented Interfaces:

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

public class ParameterExtension
extends ReportExtension

The ParameterExtension expands objects in the parameter map into the output. The object may be expanded as text or as XML elements. This can be controlled by the format attribute.

• If the format attribute exists it is used to generate a DomFormatter using ReportExtension.getFormatter(Class, String)
• If the format attribute does not exist, an attempt is made to look up the format using the simple name for the objects class.
• If that fails the object is formatted as text using the ValueParser appropriate to its type.

This class also contains the logic to build parameter forms to populate the parameter map based on the ParameterDef elements.

Author:

spb

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_ELEM
static java.lang.String	PARAMETER_LOC
static java.lang.String	PROPERTY_PARAM_PREFIX

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, parse_vis, PROPERTY_ELEMENT, TIME_BOUNDS_ELEMENT, VALUE_ELEMENT

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	buildReportParametersForm(uk.ac.ed.epcc.webapp.forms.Form form, org.w3c.dom.Document reportTemplateDocument) Build a form based on the ParameterDef elements in the report.
boolean	checkNode(org.w3c.dom.Element e) Consider this element for validity.
protected uk.ac.ed.epcc.webapp.forms.inputs.Input<?>	configureInput(org.w3c.dom.Element param, uk.ac.ed.epcc.webapp.forms.inputs.Input<?> input)
org.w3c.dom.DocumentFragment	For(org.w3c.dom.Node node) Do repeated expansion of a document fragment setting a parameter to a set of objects generated by a filter.
org.w3c.dom.DocumentFragment	formatParameter(java.lang.String name, org.w3c.dom.NodeList template) Expand a template using properties from a Parameter
static uk.ac.ed.epcc.webapp.content.ContentBuilder	getDocumentation(uk.ac.ed.epcc.webapp.AppContext c, uk.ac.ed.epcc.webapp.content.ContentBuilder cb)
protected java.lang.String	getText(org.w3c.dom.Element e) Get the text body of the Element The Element is assumed to be a leaf node with only text content.
boolean	isSet(java.lang.String name)
boolean	isTrivial(java.lang.Object o)
org.w3c.dom.DocumentFragment	parameter(org.w3c.dom.Node node)
org.w3c.dom.DocumentFragment	repeat(org.w3c.dom.Node node) Do repeated expansion of a document fragment based on a parameter that provides a series of values
org.w3c.dom.DocumentFragment	value(org.w3c.dom.Node node)

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

addDeveloperError, addError, addError, addError, addFilterElement, addReference, 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, 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

Field Detail

PROPERTY_PARAM_PREFIX

public static final java.lang.String PROPERTY_PARAM_PREFIX

See Also:

Constant Field Values

PARAMETER_ELEM

public static final java.lang.String PARAMETER_ELEM

See Also:

Constant Field Values

PARAMETER_LOC

public static final java.lang.String PARAMETER_LOC

See Also:

Constant Field Values

Constructor Detail

ParameterExtension

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

Throws:

javax.xml.parsers.ParserConfigurationException

Method Detail

buildReportParametersForm

public void buildReportParametersForm(uk.ac.ed.epcc.webapp.forms.Form form,
                             org.w3c.dom.Document reportTemplateDocument)
                               throws java.lang.Exception

Build a form based on the ParameterDef elements in the report.

Throws:

java.lang.Exception

Parameters:

form -

reportTemplateDocument -

configureInput

protected uk.ac.ed.epcc.webapp.forms.inputs.Input<?> configureInput(org.w3c.dom.Element param,
                                                        uk.ac.ed.epcc.webapp.forms.inputs.Input<?> input)

value

public org.w3c.dom.DocumentFragment value(org.w3c.dom.Node node)
                                   throws org.w3c.dom.DOMException,
                                          java.lang.Exception

Throws:

org.w3c.dom.DOMException

java.lang.Exception

isSet

public boolean isSet(java.lang.String name)

formatParameter

public org.w3c.dom.DocumentFragment formatParameter(java.lang.String name,
                                           org.w3c.dom.NodeList template)

Expand a template using properties from a Parameter

Parameters:

name -

template -

Returns:

DocumentFragment

isTrivial

public boolean isTrivial(java.lang.Object o)

parameter

public org.w3c.dom.DocumentFragment parameter(org.w3c.dom.Node node)
                                       throws ReportException

Throws:

ReportException

repeat

public org.w3c.dom.DocumentFragment repeat(org.w3c.dom.Node node)

Do repeated expansion of a document fragment based on a parameter that provides a series of values

Parameters:

node -

Returns:

DocumentFragment

For

public org.w3c.dom.DocumentFragment For(org.w3c.dom.Node node)

Do repeated expansion of a document fragment setting a parameter to a set of objects generated by a filter.

Parameters:

node -

Returns:

DocumentFragment

getText

protected java.lang.String getText(org.w3c.dom.Element e)
                            throws ReportException

Description copied from class: SelectBuilder

Get the text body of the Element The Element is assumed to be a leaf node with only text content. The ParameterExtension overrides this to do on-the-fly parameter expansion for example standard pre-existing parameters like the current user.

Overrides:

getText in class SelectBuilder

Throws:

ReportException

Parameters:

e - Element

Returns:

String

checkNode

public boolean checkNode(org.w3c.dom.Element e)
                  throws TemplateValidateException

Description copied from interface: TemplateValidator

Consider this element for validity. If the method returns true the node has been checked and need not be recursed into. If it returns false then either the Validator does not recognise the node or validates at a lower level of the document tree. In this case the surrounding framework should recurse into the child elements.

Specified by:

checkNode in interface TemplateValidator

Overrides:

checkNode in class ReportExtension

Throws:

TemplateValidateException

Parameters:

e - Element to be considered

Returns:

boolean status.

getDocumentation

public static uk.ac.ed.epcc.webapp.content.ContentBuilder getDocumentation(uk.ac.ed.epcc.webapp.AppContext c,
                                                           uk.ac.ed.epcc.webapp.content.ContentBuilder cb)