Package org.ametys.plugins.odfpilotage.report

Class AbstractPilotageReport

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

All Implemented Interfaces:

PilotageReport, LogEnabled, PluginAware, Initializable, Configurable, Serviceable

Direct Known Subclasses:

AbstractExtract, AbstractReport

public abstract class AbstractPilotageReport
extends AbstractLogEnabled
implements PilotageReport, Serviceable, Initializable, PluginAware, Configurable

The abstract class for pilotage reports.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractPilotageReport.PilotageFile	Object representing a pilotage file Containing the zip file and the report status
static class	AbstractPilotageReport.PilotageReportStatus	The enumerator for different pilotage report status

Nested classes/interfaces inherited from interface org.ametys.plugins.odfpilotage.report.PilotageReport

PilotageReport.PilotageReportTarget

Field Summary

Fields

Modifier and Type	Field	Description
private static com.google.gson.Gson	__GSON
protected String	_currentFormattedDate	The current date formatted to yyyy-MM-dd
protected I18nUtils	_i18nUtils	The I18N utils
private String	_id
private I18nizableText	_label
private String	_mailFrom
protected ODFHelper	_odfHelper	The ODF helper
private String	_outputFormat
protected PilotageHelper	_pilotageHelper	The pilotage helper
private String	_pluginName
protected OdfReferenceTableHelper	_refTableHelper	The ODF enumeration helper
protected ReportHelper	_reportHelper	The report helper
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SourceResolver	_sourceResolver	The source resolver
protected File	_tmpFolder	The tmp folder
protected UserManager	_userManager	The user manager
static String	MANIFEST_FILENAME	Filename of the manifest to describe the ZIP content

Fields inherited from interface org.ametys.plugins.odfpilotage.report.PilotageReport

OUTPUT_FORMAT_DOC, OUTPUT_FORMAT_XLS, PARAMETER_CATALOG, PARAMETER_LANG, PARAMETER_ORGUNIT, PARAMETER_OUTPUT_FORMAT, PARAMETER_PROGRAM

Constructor Summary

Constructors

Constructor	Description
AbstractPilotageReport()

Method Summary

Modifier and Type	Method	Description
protected String	_buildZipName(String contextName)	Build the ZIP name.
protected void	addManifest(ZipOutputStream zos, PilotageReport.PilotageReportTarget target, Map<String,String> reportParameters)	Add the manifest to JSON format to the ZIP.
void	configure(Configuration configuration)
protected void	convertReport(File outputFolder, String fileName, File xmlFile)	Convert the report from XML to the required format
protected AbstractPilotageReport.PilotageFile	createZipFile(File folderToZip, PilotageReport.PilotageReportTarget target, Map<String,String> reportParameters, String contextName)	Compress a folder to zip format.
String	getId()	Retrieves the id of the report.
I18nizableText	getLabel()	Retrieves the label of the report.
protected String	getMailBody(AbstractPilotageReport.PilotageReportStatus status)	The mail body.
protected String	getMailSubject()	The mail subject.
protected String	getOutputFormat()	Get the output format of the report.
protected String	getPipeline(String outputFolderName)	Build the pipeline to launch the transformation.
protected String	getPluginName()	Get the plugin name to build the pipeline.
protected String	getReportName()	The report name to add in the mail.
protected Set<String>	getSupportedOutputFormats()	Get the list of supported output formats
protected abstract String	getType()	Get the name of the report
void	initialize()
protected boolean	isCompatibleSchedulable(AbstractReportSchedulable schedulable)	Check if the given schedulable is compatible with the current
boolean	isGeneric()	Most of reports are generic.
protected boolean	isSupportedFormat()	Get the output format of the report.
protected abstract boolean	isSupportedTarget(PilotageReport.PilotageReportTarget target)	Returns true if the target is supported by the report.
void	launch(PilotageReport.PilotageReportTarget target, Map<String,String> reportParameters, UserIdentity user)	Launch a report on the given target with the given parameters.
protected abstract String	launchByOrgUnit(Map<String,String> reportParameters)	Launch a report generation on an orgunit.
protected abstract String	launchByProgram(Map<String,String> reportParameters)	Launch a report generation on a program.
protected void	sendMail(AbstractPilotageReport.PilotageFile file, UserIdentity user)	Send a mail with the ZIP file as attachment at the end of the report generation.
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
boolean	supports(AbstractReportSchedulable schedulable)	Check if the report supports the given schedulable.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_FILENAME

public static final String MANIFEST_FILENAME

Filename of the manifest to describe the ZIP content

See Also:

Constant Field Values

__GSON

private static final com.google.gson.Gson __GSON

_sourceResolver

protected SourceResolver _sourceResolver

The source resolver

_pilotageHelper

protected PilotageHelper _pilotageHelper

The pilotage helper

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_reportHelper

protected ReportHelper _reportHelper

The report helper

_refTableHelper

protected OdfReferenceTableHelper _refTableHelper

The ODF enumeration helper

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_userManager

protected UserManager _userManager

The user manager

_i18nUtils

protected I18nUtils _i18nUtils

The I18N utils

_tmpFolder

protected File _tmpFolder

The tmp folder

_currentFormattedDate

protected String _currentFormattedDate

The current date formatted to yyyy-MM-dd

_id

private String _id

_label

private I18nizableText _label

_pluginName

private String _pluginName

_mailFrom

private String _mailFrom

_outputFormat

private String _outputFormat

Constructor Detail

AbstractPilotageReport

public AbstractPilotageReport()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getId

public String getId()

Description copied from interface: PilotageReport

Retrieves the id of the report.

Specified by:

getId in interface PilotageReport

Returns:

the id.

getLabel

public I18nizableText getLabel()

Description copied from interface: PilotageReport

Retrieves the label of the report.

Specified by:

getLabel in interface PilotageReport

Returns:

the label.

supports

public boolean supports(AbstractReportSchedulable schedulable)

Description copied from interface: PilotageReport

Check if the report supports the given schedulable.

Specified by:

supports in interface PilotageReport

Parameters:

schedulable - The schedulable to check

Returns:

true if the schedulable is supported, false otherwise

isGeneric

public boolean isGeneric()

Most of reports are generic. This method can be overridden.

Returns:

true if the current report is generic, false otherwise

isSupportedTarget

protected abstract boolean isSupportedTarget(PilotageReport.PilotageReportTarget target)

Returns true if the target is supported by the report.

Parameters:

target - The target to test

Returns:

true if the target is supported, false otherwise

isCompatibleSchedulable

protected boolean isCompatibleSchedulable(AbstractReportSchedulable schedulable)

Check if the given schedulable is compatible with the current

Parameters:

schedulable - The schedulable to test

Returns:

true if the schedulable is compatible with the report

launchByOrgUnit

protected abstract String launchByOrgUnit(Map<String,String> reportParameters)
                                   throws Exception

Launch a report generation on an orgunit.

Parameters:

reportParameters - The report parameters

Returns:

the name of the generated file

Throws:

Exception - if an exception occurs

launchByProgram

protected abstract String launchByProgram(Map<String,String> reportParameters)
                                   throws Exception

Launch a report generation on a program.

Parameters:

reportParameters - The report parameters

Returns:

the name of the generated file

Throws:

Exception - if an exception occurs

getType

protected abstract String getType()

Get the name of the report

Returns:

The report name

getPluginName

protected String getPluginName()

Get the plugin name to build the pipeline.

Returns:

The plugin name

getOutputFormat

protected String getOutputFormat()

Get the output format of the report.

Returns:

The output format

getSupportedOutputFormats

protected Set<String> getSupportedOutputFormats()

Get the list of supported output formats

Returns:

A Set of supported output formats

isSupportedFormat

protected boolean isSupportedFormat()

Get the output format of the report.

Returns:

The output format

getPipeline

protected String getPipeline(String outputFolderName)

Build the pipeline to launch the transformation.

Parameters:

outputFolderName - The name of the output folder name

Returns:

The pipeline for transformation

launch

public void launch(PilotageReport.PilotageReportTarget target,
                   Map<String,String> reportParameters,
                   UserIdentity user)

Description copied from interface: PilotageReport

Launch a report on the given target with the given parameters.

Specified by:

launch in interface PilotageReport

Parameters:

target - The target of the report

reportParameters - The report parameters

user - The current user

convertReport

protected void convertReport(File outputFolder,
                             String fileName,
                             File xmlFile)
                      throws IOException

Convert the report from XML to the required format

Parameters:

outputFolder - folder where the file will stay temporarily

fileName - the filename without the extension

xmlFile - the file to be converted

Throws:

IOException - if an error occurs

createZipFile

protected AbstractPilotageReport.PilotageFile createZipFile(File folderToZip,
                                                            PilotageReport.PilotageReportTarget target,
                                                            Map<String,String> reportParameters,
                                                            String contextName)
                                                     throws IOException

Compress a folder to zip format.

Parameters:

folderToZip - the folder to be compressed

target - The target of the report

reportParameters - The report parameters

contextName - the name of the report context

Returns:

The pilotage file

Throws:

IOException - if an exception occurs

addManifest

protected void addManifest(ZipOutputStream zos,
                           PilotageReport.PilotageReportTarget target,
                           Map<String,String> reportParameters)
                    throws IOException

Add the manifest to JSON format to the ZIP.

Parameters:

zos - The ZIP output stream

target - The target of the report

reportParameters - The report parameters

Throws:

IOException - if an exception occurs

sendMail

protected void sendMail(AbstractPilotageReport.PilotageFile file,
                        UserIdentity user)

Send a mail with the ZIP file as attachment at the end of the report generation.

Parameters:

file - the pilotage file

user - the recipient if he has an email

getMailSubject

protected String getMailSubject()

The mail subject.

Returns:

The subject of the mail

getMailBody

protected String getMailBody(AbstractPilotageReport.PilotageReportStatus status)

The mail body.

Parameters:

status - the status of the pilotage report

Returns:

The body of the mail

getReportName

protected String getReportName()

The report name to add in the mail.

Returns:

The report name

_buildZipName

protected String _buildZipName(String contextName)

Build the ZIP name.

Parameters:

contextName - The report context name

Returns:

The full ZIP name