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

Class MimeMessageReportBuilder

java.lang.Object

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

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

All Implemented Interfaces:

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

public class MimeMessageReportBuilder
extends ReportBuilder

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.ed.epcc.safe.accounting.reports.ReportBuilder

ReportBuilder.ReportTypeInput, ReportBuilder.Resolver

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	MHTML

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

DEFAULT_REPORT_SCHEMA, EHTML, HTML, PARAMETER_LOC, REPORT_DEVELOPER, REPORT_PARAMS_ATTR, REPORT_SCHEMA_CONFIG, REPORT_TEMPLATE_GROUP, REPORT_TYPE_CONFIG_PREFIX, REPORT_TYPE_PARAM, SCHEMA_GROUP, STYLESHEET_GROUP

Constructor Summary

Constructors

Constructor and Description
MimeMessageReportBuilder(uk.ac.ed.epcc.webapp.AppContext conn, java.lang.String report_template, java.util.Map<java.lang.String,java.lang.Object> params)

Method Summary

Methods

Modifier and Type	Method and Description
javax.mail.internet.MimeMultipart	getAlternativeReport(ReportType... reportTypes) Make alternative versions from different ReportTypes.
javax.mail.internet.MimeMultipart	getAlternativeReport(java.lang.String... reportTypes) Make alternative versions of different types of report.
java.lang.Object	getFragment(java.lang.String name, java.lang.Object def)
javax.mail.internet.MimeMultipart	getMixedReport(java.lang.String... reportTypes) Make a mixed MimeMultipart of different report formats.
protected java.util.Set<ReportType>	getSpecialReportTypes() Get sub-classed ReportTypes that are not declared via Config.
javax.mail.internet.MimeBodyPart	makeReport(ReportType type) Create a MimeBodyPart that contains the report content of the desired type.

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

addParameterText, buildReportParametersForm, canUse, checkNode, getContext, getErrors, getInstance, getReport, getReportOverlay, getReportType, getReportType, getSchema, getSchemaDocument, getSchemaOverlay, getSchemaSource, getStyleSheet, getTemplateName, getTemplateSource, getTemplateType, getText, getTitle, getXSLTransform, hasErrors, hasReportParameterDefs, hasReportParameters, parseReportParametersForm, register, renderContent, renderXML, renderXML, runParametersTransform, setTemplate, setTemplate, setTemplate, setupExtensions, setupExtensions, setupUser, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

MHTML

public static final ReportType MHTML

Constructor Detail

MimeMessageReportBuilder

public MimeMessageReportBuilder(uk.ac.ed.epcc.webapp.AppContext conn,
                        java.lang.String report_template,
                        java.util.Map<java.lang.String,java.lang.Object> params)
                         throws java.net.URISyntaxException,
                                javax.xml.parsers.ParserConfigurationException,
                                uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                uk.ac.ed.epcc.webapp.exceptions.InvalidArgument,
                                javax.xml.transform.TransformerFactoryConfigurationError,
                                javax.xml.transform.TransformerException

Throws:

java.net.URISyntaxException

javax.xml.parsers.ParserConfigurationException

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

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

javax.xml.transform.TransformerFactoryConfigurationError

javax.xml.transform.TransformerException

Method Detail

makeReport

public javax.mail.internet.MimeBodyPart makeReport(ReportType type)
                                            throws java.lang.Exception

Create a MimeBodyPart that contains the report content of the desired type. If the report generates images via a CidChartExtension then these are combined in a related MimeMultipart. While most mail clients will be able to display this as part of larger collection of body parts MS Outlook/Exchange seems to be wedded to a one-document plus attachments model of email where making this the main body of the email works better.

Throws:

java.lang.Exception

Parameters:

type - required report type.

Returns:

MimeBodyPart

getAlternativeReport

public javax.mail.internet.MimeMultipart getAlternativeReport(ReportType... reportTypes)
                                                       throws javax.mail.MessagingException,
                                                              java.lang.Exception

Make alternative versions from different ReportTypes.

Throws:

javax.mail.MessagingException

java.lang.Exception

Parameters:

reportTypes -

Returns:

getAlternativeReport

public javax.mail.internet.MimeMultipart getAlternativeReport(java.lang.String... reportTypes)
                                                       throws javax.mail.MessagingException,
                                                              java.lang.Exception

Make alternative versions of different types of report. The client will select the "best" supported version to display. MS Outlook/Exchange can cope with this as the message content but you only get to see one version

Throws:

javax.mail.MessagingException

java.lang.Exception

Parameters:

reportTypes -

Returns:

MimeMultipart

getMixedReport

public javax.mail.internet.MimeMultipart getMixedReport(java.lang.String... reportTypes)
                                                 throws javax.mail.MessagingException,
                                                        java.lang.Exception

Make a mixed MimeMultipart of different report formats. The first format will be shows in-line with the other formats available as attachments. MS Outlook/Exchange can cope with this as the message content.

Throws:

javax.mail.MessagingException

java.lang.Exception

Parameters:

reportTypes -

Returns:

getFragment

public java.lang.Object getFragment(java.lang.String name,
                           java.lang.Object def)

getSpecialReportTypes

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

Description copied from class: ReportBuilder

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

Overrides:

getSpecialReportTypes in class ReportBuilder

Returns: