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

Class ReportBuilder

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MimeMessageReportBuilder

public class ReportBuilder
extends java.lang.Object
implements uk.ac.ed.epcc.webapp.Contexed, TemplateValidator

Class to Build Reports from an XML template

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ReportBuilder.ReportTypeInput
class	ReportBuilder.Resolver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_REPORT_SCHEMA
static ReportType	EHTML
static ReportType	HTML
static java.lang.String	PARAMETER_LOC
static java.lang.String	REPORT_DEVELOPER
static java.lang.String	REPORT_PARAMS_ATTR
static java.lang.String	REPORT_SCHEMA_CONFIG
static java.lang.String	REPORT_TEMPLATE_GROUP
static java.lang.String	REPORT_TYPE_CONFIG_PREFIX
static java.lang.String	REPORT_TYPE_PARAM
static java.lang.String	SCHEMA_GROUP
static java.lang.String	STYLESHEET_GROUP

Constructor Summary

Constructors

Constructor and Description
ReportBuilder(uk.ac.ed.epcc.webapp.AppContext conn)
ReportBuilder(uk.ac.ed.epcc.webapp.AppContext ctx, java.lang.String string, java.lang.String string2) Constructor for tests

Method Summary

Methods

Modifier and Type	Method and Description
uk.ac.ed.epcc.webapp.content.ContentBuilder	addParameterText(uk.ac.ed.epcc.webapp.content.HtmlBuilder hb)
void	buildReportParametersForm(uk.ac.ed.epcc.webapp.forms.Form form, java.util.Map<java.lang.String,java.lang.Object> params)
boolean	canUse(uk.ac.ed.epcc.webapp.session.SessionService<?> person, java.util.Map<java.lang.String,java.lang.Object> params) Evaluate the access control status
boolean	checkNode(org.w3c.dom.Element e) Consider this element for validity.
uk.ac.ed.epcc.webapp.AppContext	getContext()
java.util.Set<ErrorSet>	getErrors()
static ReportBuilder	getInstance(uk.ac.ed.epcc.webapp.AppContext conn)
protected javax.xml.transform.Source	getReport(java.lang.String name)
uk.ac.ed.epcc.webapp.model.TextFileOverlay	getReportOverlay()
protected ReportType	getReportType(java.util.Map<java.lang.String,java.lang.Object> params)
ReportType	getReportType(java.lang.String text) Look up a report type.
javax.xml.validation.Schema	getSchema(java.lang.String name)
org.w3c.dom.Document	getSchemaDocument(java.lang.String name)
uk.ac.ed.epcc.webapp.model.TextFileOverlay	getSchemaOverlay()
javax.xml.transform.Source	getSchemaSource(java.lang.String name)
protected java.util.Set<ReportType>	getSpecialReportTypes() Get sub-classed ReportTypes that are not declared via Config.
protected javax.xml.transform.Source	getStyleSheet(java.lang.String name)
static java.lang.String	getTemplateName(java.lang.String templateFileName)
javax.xml.transform.Source	getTemplateSource()
ReportType	getTemplateType(java.lang.String templateFileName)
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.
java.lang.String	getTitle() Get the title used for the parameter page
javax.xml.transform.Transformer	getXSLTransform(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> params)
boolean	hasErrors()
boolean	hasReportParameterDefs()
boolean	hasReportParameters()
boolean	parseReportParametersForm(uk.ac.ed.epcc.webapp.forms.Form form, java.util.Map<java.lang.String,java.lang.Object> params)
void	register(ReportExtension re)
void	renderContent(java.util.Map<java.lang.String,java.lang.Object> params, uk.ac.ed.epcc.webapp.content.SimpleXMLBuilder builder) Forward HTML output to a SimpleXMLBuilder.
void	renderXML(java.util.Map<java.lang.String,java.lang.Object> params, java.io.OutputStream out)
void	renderXML(ReportType type, java.util.Map<java.lang.String,java.lang.Object> params, javax.xml.transform.Result out)
protected javax.xml.transform.Source	runParametersTransform(javax.xml.transform.Source xmlSource, java.util.Map<java.lang.String,java.lang.Object> params)
static void	setTemplate(uk.ac.ed.epcc.webapp.AppContext conn, ReportBuilder builder, java.lang.String templateName)
void	setTemplate(java.lang.String template_name)
void	setTemplate(java.lang.String template_name, java.lang.String schema_name)
void	setupExtensions(java.util.Map<java.lang.String,java.lang.Object> params)
void	setupExtensions(ReportType reportType, java.util.Map<java.lang.String,java.lang.Object> params)
void	setupUser(java.util.Map<java.lang.String,java.lang.Object> params)
void	validate(java.lang.String schema_name, javax.xml.transform.Source src)
void	validate(java.lang.String schema_name, java.lang.String template_text)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REPORT_SCHEMA

public static final java.lang.String DEFAULT_REPORT_SCHEMA

See Also:

Constant Field Values

REPORT_SCHEMA_CONFIG

public static final java.lang.String REPORT_SCHEMA_CONFIG

See Also:

Constant Field Values

REPORT_TYPE_PARAM

public static final java.lang.String REPORT_TYPE_PARAM

See Also:

Constant Field Values

SCHEMA_GROUP

public static final java.lang.String SCHEMA_GROUP

See Also:

Constant Field Values

REPORT_TEMPLATE_GROUP

public static final java.lang.String REPORT_TEMPLATE_GROUP

See Also:

Constant Field Values

STYLESHEET_GROUP

public static final java.lang.String STYLESHEET_GROUP

See Also:

Constant Field Values

REPORT_TYPE_CONFIG_PREFIX

public static final java.lang.String REPORT_TYPE_CONFIG_PREFIX

See Also:

Constant Field Values

HTML

public static final ReportType HTML

EHTML

public static final ReportType EHTML

PARAMETER_LOC

public static final java.lang.String PARAMETER_LOC

See Also:

Constant Field Values

REPORT_DEVELOPER

public static final java.lang.String REPORT_DEVELOPER

See Also:

Constant Field Values

REPORT_PARAMS_ATTR

public static final java.lang.String REPORT_PARAMS_ATTR

See Also:

Constant Field Values

Constructor Detail

ReportBuilder

public ReportBuilder(uk.ac.ed.epcc.webapp.AppContext conn)
              throws java.net.URISyntaxException,
                     javax.xml.parsers.ParserConfigurationException

Throws:

java.net.URISyntaxException

javax.xml.parsers.ParserConfigurationException

ReportBuilder

public ReportBuilder(uk.ac.ed.epcc.webapp.AppContext ctx,
             java.lang.String string,
             java.lang.String string2)
              throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                     javax.xml.parsers.ParserConfigurationException,
                     uk.ac.ed.epcc.webapp.exceptions.InvalidArgument,
                     javax.xml.transform.TransformerFactoryConfigurationError,
                     javax.xml.transform.TransformerException,
                     org.xml.sax.SAXException,
                     java.io.IOException,
                     java.net.URISyntaxException

Constructor for tests

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.transform.TransformerException

javax.xml.transform.TransformerFactoryConfigurationError

uk.ac.ed.epcc.webapp.exceptions.InvalidArgument

javax.xml.parsers.ParserConfigurationException

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

java.net.URISyntaxException

Parameters:

ctx -

string -

string2 -

Method Detail

getSpecialReportTypes

protected java.util.Set<ReportType> getSpecialReportTypes()

Get sub-classed ReportTypes that are not declared via Config.

Returns:

getReportType

public ReportType getReportType(java.lang.String text)

Look up a report type. If we can't find by name try looking up by extension.

Parameters:

text -

Returns:

ReportType

getTemplateName

public static java.lang.String getTemplateName(java.lang.String templateFileName)

getTemplateType

public ReportType getTemplateType(java.lang.String templateFileName)

setTemplate

public void setTemplate(java.lang.String template_name)
                 throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                        javax.xml.parsers.ParserConfigurationException,
                        uk.ac.ed.epcc.webapp.exceptions.InvalidArgument,
                        javax.xml.transform.TransformerFactoryConfigurationError,
                        javax.xml.transform.TransformerException

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

javax.xml.parsers.ParserConfigurationException

uk.ac.ed.epcc.webapp.exceptions.InvalidArgument

javax.xml.transform.TransformerFactoryConfigurationError

javax.xml.transform.TransformerException

setTemplate

public void setTemplate(java.lang.String template_name,
               java.lang.String schema_name)
                 throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                        javax.xml.parsers.ParserConfigurationException,
                        uk.ac.ed.epcc.webapp.exceptions.InvalidArgument,
                        javax.xml.transform.TransformerFactoryConfigurationError,
                        javax.xml.transform.TransformerException,
                        org.xml.sax.SAXException,
                        java.io.IOException

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

javax.xml.parsers.ParserConfigurationException

uk.ac.ed.epcc.webapp.exceptions.InvalidArgument

javax.xml.transform.TransformerFactoryConfigurationError

javax.xml.transform.TransformerException

org.xml.sax.SAXException

java.io.IOException

validate

public void validate(java.lang.String schema_name,
            java.lang.String template_text)
              throws org.xml.sax.SAXException,
                     java.io.IOException,
                     uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Throws:

org.xml.sax.SAXException

java.io.IOException

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

validate

public void validate(java.lang.String schema_name,
            javax.xml.transform.Source src)
              throws org.xml.sax.SAXException,
                     java.io.IOException,
                     uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Throws:

org.xml.sax.SAXException

java.io.IOException

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

getTitle

public java.lang.String getTitle()

Get the title used for the parameter page

Returns:

String title

addParameterText

public uk.ac.ed.epcc.webapp.content.ContentBuilder addParameterText(uk.ac.ed.epcc.webapp.content.HtmlBuilder hb)

canUse

public boolean canUse(uk.ac.ed.epcc.webapp.session.SessionService<?> person,
             java.util.Map<java.lang.String,java.lang.Object> params)

Evaluate the access control status

Parameters:

person -

params -

Returns:

boolean

setupUser

public void setupUser(java.util.Map<java.lang.String,java.lang.Object> params)

register

public void register(ReportExtension re)

setupExtensions

public void setupExtensions(java.util.Map<java.lang.String,java.lang.Object> params)
                     throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

setupExtensions

public void setupExtensions(ReportType reportType,
                   java.util.Map<java.lang.String,java.lang.Object> params)
                     throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

hasReportParameterDefs

public boolean hasReportParameterDefs()

hasReportParameters

public boolean hasReportParameters()

buildReportParametersForm

public void buildReportParametersForm(uk.ac.ed.epcc.webapp.forms.Form form,
                             java.util.Map<java.lang.String,java.lang.Object> params)
                               throws java.lang.Exception

Throws:

java.lang.Exception

parseReportParametersForm

public boolean parseReportParametersForm(uk.ac.ed.epcc.webapp.forms.Form form,
                                java.util.Map<java.lang.String,java.lang.Object> params)

renderXML

public void renderXML(java.util.Map<java.lang.String,java.lang.Object> params,
             java.io.OutputStream out)
               throws java.lang.Exception

Throws:

java.lang.Exception

renderContent

public void renderContent(java.util.Map<java.lang.String,java.lang.Object> params,
                 uk.ac.ed.epcc.webapp.content.SimpleXMLBuilder builder)
                   throws java.lang.Exception

Forward HTML output to a SimpleXMLBuilder. This is intended to embed micro-reports in application pages. In particular in transition pages.

Throws:

java.lang.Exception

Parameters:

params - report parameters

builder - SimpleXMLBuilder

renderXML

public void renderXML(ReportType type,
             java.util.Map<java.lang.String,java.lang.Object> params,
             javax.xml.transform.Result out)
               throws java.lang.Exception

Throws:

java.lang.Exception

getStyleSheet

protected javax.xml.transform.Source getStyleSheet(java.lang.String name)
                                            throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

getReport

protected javax.xml.transform.Source getReport(java.lang.String name)
                                        throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

getSchemaSource

public javax.xml.transform.Source getSchemaSource(java.lang.String name)
                                           throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                                  org.xml.sax.SAXException

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

org.xml.sax.SAXException

getSchemaDocument

public org.w3c.dom.Document getSchemaDocument(java.lang.String name)
                                       throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                              org.xml.sax.SAXException,
                                              javax.xml.transform.TransformerException

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

org.xml.sax.SAXException

javax.xml.transform.TransformerException

getSchema

public javax.xml.validation.Schema getSchema(java.lang.String name)
                                      throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                             org.xml.sax.SAXException

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

org.xml.sax.SAXException

getTemplateSource

public javax.xml.transform.Source getTemplateSource()

getReportType

protected ReportType getReportType(java.util.Map<java.lang.String,java.lang.Object> params)

getXSLTransform

public javax.xml.transform.Transformer getXSLTransform(java.lang.String name,
                                              java.util.Map<java.lang.String,java.lang.Object> params)
                                                throws javax.xml.transform.TransformerFactoryConfigurationError,
                                                       javax.xml.transform.TransformerConfigurationException,
                                                       uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Throws:

javax.xml.transform.TransformerFactoryConfigurationError

javax.xml.transform.TransformerConfigurationException

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

hasErrors

public boolean hasErrors()

getErrors

public java.util.Set<ErrorSet> getErrors()

runParametersTransform

protected javax.xml.transform.Source runParametersTransform(javax.xml.transform.Source xmlSource,
                                                java.util.Map<java.lang.String,java.lang.Object> params)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getText

protected final 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.

Parameters:

e - Element

Returns:

String

getContext

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

Specified by:

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

getInstance

public static ReportBuilder getInstance(uk.ac.ed.epcc.webapp.AppContext conn)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

setTemplate

public static void setTemplate(uk.ac.ed.epcc.webapp.AppContext conn,
               ReportBuilder builder,
               java.lang.String templateName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

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.

getSchemaOverlay

public uk.ac.ed.epcc.webapp.model.TextFileOverlay getSchemaOverlay()

getReportOverlay

public uk.ac.ed.epcc.webapp.model.TextFileOverlay getReportOverlay()