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

Class ReportExtension

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AtomExtension, ChartExtension, EmbeddedExtension, FilterExtension, FormatExtension, ParameterExtension, PeriodExtension, RestrictExtension, TableExtension

public abstract class ReportExtension
extends SelectBuilder
implements uk.ac.ed.epcc.webapp.Contexed, TemplateValidator

Abstract superclass for Reporting Extensions holds methods useful in multiple extensions. Each extension also implements TemplateValidator and should perform additional checks for the Elements that they support.

Author:

spb

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DAY
protected java.text.DateFormat	df
protected static java.lang.String	END_TIME
protected static java.lang.String	EXPRESSION_PREFIX
protected static java.lang.String	FILTER_ELEMENT
static java.lang.String	FILTER_LOC
static java.lang.String	FORMATTER_PREFIX
protected static java.lang.String	HOUR
protected static java.lang.String	MINUTE
protected static java.lang.String	MONTH
protected java.text.NumberFormat	nf
protected static java.lang.String	NUMBER_OF_SPLIT_UNITS
protected static java.lang.String	NUMBER_OF_SPLITS
protected java.util.Map<java.lang.String,java.lang.Object>	params
protected static java.lang.String	PERIOD_ELEMENT
static java.lang.String	PERIOD_NS
protected static java.lang.String	PRODUCER_ELEMENT
protected static java.lang.String	SECOND
protected static java.lang.String	SPLIT_UNIT
protected static java.lang.String	START_TIME
protected static java.text.SimpleDateFormat	timestampFormat
protected static java.lang.String	WEEK
protected static java.lang.String	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
ReportExtension(uk.ac.ed.epcc.webapp.AppContext conn, java.text.NumberFormat nf)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeveloperError(java.lang.String type, java.lang.String details) Add an error only if the current user is a report developer
void	addError(java.lang.String type, java.lang.String details)
void	addError(java.lang.String type, java.lang.String details, org.w3c.dom.Node e)
void	addError(java.lang.String type, java.lang.String details, java.lang.Throwable t)
protected RecordSet	addFilterElement(RecordSet rs, org.w3c.dom.Element filter) Add a "Filter" container to the RecordSet.
org.w3c.dom.DocumentFragment	addReference(uk.ac.ed.epcc.webapp.content.XMLGenerator gen)
boolean	checkNode(org.w3c.dom.Element e) Consider this element for validity.
<T> T	convert(uk.ac.ed.epcc.webapp.model.data.reference.IndexedProducer fac, java.lang.Class<T> target, java.lang.Object dat) Perform known conversions to a desired target type.
java.lang.String	debug(java.lang.String text)
<T> java.lang.String	display(PropExpression<T> tag, T value) Format a property for final display to the user.
<T> java.lang.String	displayByClass(java.lang.Class<? extends T> target, T value) get a human readable string for an object that will not need to be re-parsed
boolean	empty(java.lang.String value)
<T> java.lang.String	format(PropExpression<T> tag, T value) Format a property value in a way that may be re-parsed in a later processing stage ie compatible with the parse method
protected org.w3c.dom.DocumentFragment	format(uk.ac.ed.epcc.webapp.content.Table table, java.lang.String type)
<T> java.lang.String	formatByClass(java.lang.Class<? extends T> target, T value)
protected org.w3c.dom.DocumentFragment	formatObject(java.lang.Object param, java.lang.String parameterFormat)
protected boolean	getBooleanParam(java.lang.String name, boolean def, org.w3c.dom.Element elem)
protected java.lang.Class<? extends uk.ac.ed.epcc.webapp.content.TableFormatPolicy>	getDefaultTableFormatPolicy()
protected org.w3c.dom.Document	getDocument() Get a Document object needed to create result Nodes
ErrorSet	getErrors()
protected PropExpression	getExpression(PropertyTargetFactory up, java.lang.String expr)
protected DomFormatter	getFormatter(java.lang.Class clazz, java.lang.String name) Generate a DomFormatter for the specified class based on a format string.
java.lang.Object	getFormParameter(java.lang.String name) Get a form parameter by name
protected int	getIntParam(java.lang.String name, int def, org.w3c.dom.Element elem)
protected int	getIntParamNS(java.lang.String namespace, java.lang.String name, int def, org.w3c.dom.Element elem)
protected java.lang.Number	getNumberParam(java.lang.String name, java.lang.Number def, org.w3c.dom.Element elem) Get a numeric value from document.
protected java.lang.Object	getParameterRef(org.w3c.dom.Element e) Get the parameter referenced by a nested ParameterRef element
protected <T> T	getParamExpressionValue(PropExpression<T> expr, java.lang.String name, org.w3c.dom.Element elem) Parse a PropExpression in a nested element the value can also be provided as a ParameterRef element
PropertyTag	getProperty(org.w3c.dom.Node node, PropertyTargetFactory producer, java.lang.String name) Gets the PropertyTag in the sub-tag 'name'.
PropExpression	getPropertyExpression(org.w3c.dom.Node node, PropertyTargetFactory producer, java.lang.String name)
protected <T> SelectClause<T>	getSelectClause(PropExpression<T> expr, uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition cond, org.w3c.dom.Element e)
<T> PropertyTag<? extends T>	getTag(PropertyFinder finder, java.lang.Class<? extends T> target, java.lang.String name)
<T> PropertyTag<? extends T>	getTag(PropertyTargetFactory up, java.lang.Class<? extends T> target, java.lang.String name)
PropertyTag	getTag(PropertyTargetFactory up, org.w3c.dom.Element element)
PropertyTag	getTag(PropertyTargetFactory up, java.lang.String name)
<T> T	getValue(PropExpression<T> tag, org.w3c.dom.Element element)
protected boolean	hasParam(java.lang.String name, org.w3c.dom.Element elem)
protected boolean	hasParameterRef(org.w3c.dom.Element e) Test for existance of a ParameterRef
uk.ac.ed.epcc.webapp.time.Period	makePeriod(org.w3c.dom.Node region)
java.lang.String	makeString(org.w3c.dom.Node e)
static java.lang.Number	parseNumber(java.text.NumberFormat nf, java.lang.Class target, java.lang.String value)
protected static java.lang.Number	parseNumberWithDef(java.lang.Number def, java.lang.String s)
void	setParams(java.util.Map<java.lang.String,java.lang.Object> p)
protected void	setTime(java.util.Calendar time, java.lang.String timeString)
void	setUseReference(boolean val) Store the table in the parameters list and just reference it via a processing instruction.

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

Field Detail

FORMATTER_PREFIX

public static final java.lang.String FORMATTER_PREFIX

See Also:

Constant Field Values

EXPRESSION_PREFIX

protected static final java.lang.String EXPRESSION_PREFIX

See Also:

Constant Field Values

PRODUCER_ELEMENT

protected static final java.lang.String PRODUCER_ELEMENT

See Also:

Constant Field Values

FILTER_ELEMENT

protected static final java.lang.String FILTER_ELEMENT

See Also:

Constant Field Values

FILTER_LOC

public static final java.lang.String FILTER_LOC

See Also:

Constant Field Values

PERIOD_ELEMENT

protected static final java.lang.String PERIOD_ELEMENT

See Also:

Constant Field Values

NUMBER_OF_SPLIT_UNITS

protected static final java.lang.String NUMBER_OF_SPLIT_UNITS

See Also:

Constant Field Values

SPLIT_UNIT

protected static final java.lang.String SPLIT_UNIT

See Also:

Constant Field Values

YEAR

protected static final java.lang.String YEAR

See Also:

Constant Field Values

MONTH

protected static final java.lang.String MONTH

See Also:

Constant Field Values

WEEK

protected static final java.lang.String WEEK

See Also:

Constant Field Values

HOUR

protected static final java.lang.String HOUR

See Also:

Constant Field Values

MINUTE

protected static final java.lang.String MINUTE

See Also:

Constant Field Values

SECOND

protected static final java.lang.String SECOND

See Also:

Constant Field Values

DAY

protected static final java.lang.String DAY

See Also:

Constant Field Values

NUMBER_OF_SPLITS

protected static final java.lang.String NUMBER_OF_SPLITS

See Also:

Constant Field Values

START_TIME

protected static final java.lang.String START_TIME

See Also:

Constant Field Values

END_TIME

protected static final java.lang.String END_TIME

See Also:

Constant Field Values

PERIOD_NS

public static final java.lang.String PERIOD_NS

See Also:

Constant Field Values

timestampFormat

protected static java.text.SimpleDateFormat timestampFormat

nf

protected final java.text.NumberFormat nf

df

protected java.text.DateFormat df

params

protected java.util.Map<java.lang.String,java.lang.Object> params

Constructor Detail

ReportExtension

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

Throws:

javax.xml.parsers.ParserConfigurationException

Method Detail

setParams

public void setParams(java.util.Map<java.lang.String,java.lang.Object> p)

addError

public final void addError(java.lang.String type,
            java.lang.String details)

addDeveloperError

public final void addDeveloperError(java.lang.String type,
                     java.lang.String details)

Add an error only if the current user is a report developer

Parameters:

type -

details -

addError

public final void addError(java.lang.String type,
            java.lang.String details,
            org.w3c.dom.Node e)

Specified by:

addError in class SelectBuilder

makeString

public java.lang.String makeString(org.w3c.dom.Node e)

addError

public final void addError(java.lang.String type,
            java.lang.String details,
            java.lang.Throwable t)

Specified by:

addError in class SelectBuilder

getErrors

public ErrorSet getErrors()

debug

public java.lang.String debug(java.lang.String text)

Specified by:

debug in class SelectBuilder

getFormParameter

public java.lang.Object getFormParameter(java.lang.String name)

Get a form parameter by name

Parameters:

name -

Returns:

parameter

getDocument

protected final org.w3c.dom.Document getDocument()

Get a Document object needed to create result Nodes

Returns:

Document

getParamExpressionValue

protected <T> T getParamExpressionValue(PropExpression<T> expr,
                            java.lang.String name,
                            org.w3c.dom.Element elem)
                             throws java.lang.Exception

Parse a PropExpression in a nested element the value can also be provided as a ParameterRef element

Overrides:

getParamExpressionValue in class SelectBuilder

Throws:

java.lang.Exception

Parameters:

expr -

name -

elem -

Returns:

getSelectClause

protected <T> SelectClause<T> getSelectClause(PropExpression<T> expr,
                                  uk.ac.ed.epcc.webapp.jdbc.filter.MatchCondition cond,
                                  org.w3c.dom.Element e)
                                   throws java.lang.Exception

Overrides:

getSelectClause in class SelectBuilder

Throws:

java.lang.Exception

hasParam

protected final boolean hasParam(java.lang.String name,
               org.w3c.dom.Element elem)
                          throws ReportException

Throws:

ReportException

getParameterRef

protected java.lang.Object getParameterRef(org.w3c.dom.Element e)

Get the parameter referenced by a nested ParameterRef element

Parameters:

e -

Returns:

hasParameterRef

protected boolean hasParameterRef(org.w3c.dom.Element e)

Test for existance of a ParameterRef

Parameters:

e -

Returns:

getIntParam

protected final int getIntParam(java.lang.String name,
              int def,
              org.w3c.dom.Element elem)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getBooleanParam

protected final boolean getBooleanParam(java.lang.String name,
                      boolean def,
                      org.w3c.dom.Element elem)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getNumberParam

protected final java.lang.Number getNumberParam(java.lang.String name,
                              java.lang.Number def,
                              org.w3c.dom.Element elem)
                                         throws java.lang.Exception

Get a numeric value from document. This will resolve ParameterRef elements.

Throws:

java.lang.Exception

Parameters:

name - Name of sub-element to query (null to query elem)

def - default value to return

elem -

Returns:

Number

parseNumberWithDef

protected static java.lang.Number parseNumberWithDef(java.lang.Number def,
                                  java.lang.String s)
                                              throws java.text.ParseException

Throws:

java.text.ParseException

getIntParamNS

protected final int getIntParamNS(java.lang.String namespace,
                java.lang.String name,
                int def,
                org.w3c.dom.Element elem)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getTag

public PropertyTag getTag(PropertyTargetFactory up,
                 org.w3c.dom.Element element)
                   throws java.lang.Exception

Throws:

java.lang.Exception

getTag

public PropertyTag getTag(PropertyTargetFactory up,
                 java.lang.String name)

getExpression

protected PropExpression getExpression(PropertyTargetFactory up,
                           java.lang.String expr)

getValue

public <T> T getValue(PropExpression<T> tag,
             org.w3c.dom.Element element)
           throws java.lang.Exception

Throws:

java.lang.Exception

getTag

public <T> PropertyTag<? extends T> getTag(PropertyTargetFactory up,
                                  java.lang.Class<? extends T> target,
                                  java.lang.String name)

getTag

public <T> PropertyTag<? extends T> getTag(PropertyFinder finder,
                                  java.lang.Class<? extends T> target,
                                  java.lang.String name)

convert

public <T> T convert(uk.ac.ed.epcc.webapp.model.data.reference.IndexedProducer fac,
            java.lang.Class<T> target,
            java.lang.Object dat)

Perform known conversions to a desired target type.

Parameters:

fac - IndexedProducer (only needed if converting to an IndexedReference)

target -

dat -

Returns:

converted value

parseNumber

public static java.lang.Number parseNumber(java.text.NumberFormat nf,
                           java.lang.Class target,
                           java.lang.String value)
                                    throws java.text.ParseException

Throws:

java.text.ParseException

format

public <T> java.lang.String format(PropExpression<T> tag,
                          T value)
                        throws java.lang.Exception

Format a property value in a way that may be re-parsed in a later processing stage ie compatible with the parse method

Throws:

java.lang.Exception

Type Parameters:

T -

Parameters:

tag -

value -

Returns:

String

formatByClass

public <T> java.lang.String formatByClass(java.lang.Class<? extends T> target,
                                 T value)
                               throws java.lang.Exception

Throws:

java.lang.Exception

displayByClass

public <T> java.lang.String displayByClass(java.lang.Class<? extends T> target,
                                  T value)
                                throws java.lang.Exception

get a human readable string for an object that will not need to be re-parsed

Throws:

java.lang.Exception

Parameters:

target -

value -

Returns:

String

display

public <T> java.lang.String display(PropExpression<T> tag,
                           T value)
                         throws java.lang.Exception

Format a property for final display to the user.

Throws:

java.lang.Exception

Type Parameters:

T -

Parameters:

tag - PropExpression being formatted (can be null).

value -

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

Throws:

TemplateValidateException

Parameters:

e - Element to be considered

Returns:

boolean status.

empty

public boolean empty(java.lang.String value)

getPropertyExpression

public PropExpression getPropertyExpression(org.w3c.dom.Node node,
                                   PropertyTargetFactory producer,
                                   java.lang.String name)

getProperty

public PropertyTag getProperty(org.w3c.dom.Node node,
                      PropertyTargetFactory producer,
                      java.lang.String name)

Gets the PropertyTag in the sub-tag 'name'.

Parameters:

node - the XML node

producer - the producer, required to create the PropertyTags.

name - the name of the sub-tag.

Returns:

the property tag

addReference

public org.w3c.dom.DocumentFragment addReference(uk.ac.ed.epcc.webapp.content.XMLGenerator gen)

getFormatter

protected DomFormatter getFormatter(java.lang.Class clazz,
                        java.lang.String name)

Generate a DomFormatter for the specified class based on a format string. Default behaviour is to look for a DomFormatter class definition using the qualifier Formatter (see AppContext.makeObjectWithDefault(Class,Class,String,String) Failing that a ValueParser is retrieved and converted into a DomFormatter.

If the format starts with expression: This is taken to be a PropExpression to be evaluated on the target object.

Parameters:

clazz - target class of formatter

name - format string

Returns:

formatObject

protected org.w3c.dom.DocumentFragment formatObject(java.lang.Object param,
                                        java.lang.String parameterFormat)
                                             throws ReportException

Throws:

ReportException

addFilterElement

protected RecordSet addFilterElement(RecordSet rs,
                         org.w3c.dom.Element filter)

Add a "Filter" container to the RecordSet.

Parameters:

rs -

filter -

Returns:

makePeriod

public uk.ac.ed.epcc.webapp.time.Period makePeriod(org.w3c.dom.Node region)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

setTime

protected void setTime(java.util.Calendar time,
           java.lang.String timeString)
                throws java.lang.Exception

Throws:

java.lang.Exception

setUseReference

public void setUseReference(boolean val)

Store the table in the parameters list and just reference it via a processing instruction. This is to expose the table to a ContentBuilder in an embedded report.

Parameters:

val -

format

protected org.w3c.dom.DocumentFragment format(uk.ac.ed.epcc.webapp.content.Table table,
                                  java.lang.String type)

getDefaultTableFormatPolicy

protected java.lang.Class<? extends uk.ac.ed.epcc.webapp.content.TableFormatPolicy> getDefaultTableFormatPolicy()