Package org.ametys.plugins.odfpilotage.report.impl

Class SyntheseReport

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

org.ametys.plugins.odfpilotage.report.impl.AbstractReport

org.ametys.plugins.odfpilotage.report.impl.SyntheseReport

All Implemented Interfaces:

PilotageReport, LogEnabled, PluginAware, Initializable, Configurable, Serviceable

public class SyntheseReport
extends AbstractReport

Pilotage report for cost modeling synthesis

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SyntheseReport.CompareProgramItemTitle	Compare two programItem by their title

Nested classes/interfaces inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

AbstractPilotageReport.PilotageFile, AbstractPilotageReport.PilotageReportStatus

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

PilotageReport.PilotageReportTarget

Field Summary

Fields

Modifier and Type	Field	Description
protected CostComputationComponent	_costComputationComponent	CalculerEffectifComponent

Fields inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

_currentFormattedDate, _i18nUtils, _odfHelper, _pilotageHelper, _refTableHelper, _reportHelper, _resolver, _sourceResolver, _tmpFolder, _userManager, MANIFEST_FILENAME

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
SyntheseReport()

Method Summary

Modifier and Type	Method	Description
private Set<String>	_getNatures(CostComputationData costData)
private String	_getPath(ProgramItem programItem, Container step, CostComputationData costData)
protected void	_launchByOrgUnit(String uaiCode, String catalog, String lang)	Launch a report generation on an orgunit.
protected void	_writeColumn(TransformerHandler handler, String natureId)	Write columns content of the report
private void	_writeColumns(TransformerHandler handler, CostComputationData costData)	Write columns content of the report
private void	_writeLines(TransformerHandler handler, CostComputationData costData, OrgUnit orgUnit)	Write lines content of the report
private void	_writeOrgUnitLine(TransformerHandler handler, CostComputationData costData, OrgUnit orgUnit)
private void	_writeProgramLine(TransformerHandler handler, CostComputationData costData, OrgUnit orgUnit, ProgramItem program)
private void	_writeStepLine(TransformerHandler handler, CostComputationData costData, ProgramItem program, Container step)
private void	_writeSyntheseReport(String uaiCode, String catalog, String lang, OrgUnit orgUnit, CostComputationData costData)	Create the synthese report for one organization unit
private void	_writeValues(TransformerHandler handler, CostComputationData costData, Content program, String path)
protected Set<String>	getSupportedOutputFormats()	Get the list of supported output formats
protected String	getType()	Get the name of the report
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.odfpilotage.report.impl.AbstractReport

_getReportFileName, isSupportedTarget, launchByOrgUnit, launchByProgram

Methods inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport

_buildZipName, addManifest, configure, convertReport, createZipFile, getId, getLabel, getMailBody, getMailSubject, getOutputFormat, getPipeline, getPluginName, getReportName, initialize, isCompatibleSchedulable, isGeneric, isSupportedFormat, launch, sendMail, setPluginInfo, supports

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

_costComputationComponent

protected CostComputationComponent _costComputationComponent

CalculerEffectifComponent

Constructor Detail

SyntheseReport

public SyntheseReport()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractPilotageReport

Throws:

ServiceException

getType

protected String getType()

Description copied from class: AbstractPilotageReport

Get the name of the report

Specified by:

getType in class AbstractPilotageReport

Returns:

The report name

getSupportedOutputFormats

protected Set<String> getSupportedOutputFormats()

Description copied from class: AbstractPilotageReport

Get the list of supported output formats

Overrides:

getSupportedOutputFormats in class AbstractPilotageReport

Returns:

A Set of supported output formats

_launchByOrgUnit

protected void _launchByOrgUnit(String uaiCode,
                                String catalog,
                                String lang)
                         throws Exception

Description copied from class: AbstractReport

Launch a report generation on an orgunit.

Specified by:

_launchByOrgUnit in class AbstractReport

Parameters:

uaiCode - The UAI code of the OrgUnit

catalog - The catalog

lang - The language

Throws:

Exception - if an exception occurs

_writeSyntheseReport

private void _writeSyntheseReport(String uaiCode,
                                  String catalog,
                                  String lang,
                                  OrgUnit orgUnit,
                                  CostComputationData costData)

Create the synthese report for one organization unit

Parameters:

uaiCode - the reference to the organization unit whose formations are going to be saxed

catalog - the catalog

lang - The language code

orgUnit - the orgUnit

costData - object containing informations about the formation

_writeColumns

private void _writeColumns(TransformerHandler handler,
                           CostComputationData costData)
                    throws SAXException

Write columns content of the report

Parameters:

handler - the sax transformer handler

costData - informations about the capacity

Throws:

SAXException - to handle XMLUtils exceptions

_getNatures

private Set<String> _getNatures(CostComputationData costData)

_writeColumn

protected void _writeColumn(TransformerHandler handler,
                            String natureId)
                     throws SAXException

Write columns content of the report

Parameters:

handler - the sax transformer handler

natureId - the nature of the volume of hours

Throws:

SAXException - to handle XMLUtils exceptions

_writeLines

private void _writeLines(TransformerHandler handler,
                         CostComputationData costData,
                         OrgUnit orgUnit)
                  throws SAXException

Write lines content of the report

Parameters:

handler - the transformer handler

costData - informations about the capacity

orgUnit - the orgUnit

Throws:

SAXException - to handle XMLUtils exceptions

_writeStepLine

private void _writeStepLine(TransformerHandler handler,
                            CostComputationData costData,
                            ProgramItem program,
                            Container step)
                     throws AmetysRepositoryException,
                            SAXException

Throws:

AmetysRepositoryException

SAXException

_writeProgramLine

private void _writeProgramLine(TransformerHandler handler,
                               CostComputationData costData,
                               OrgUnit orgUnit,
                               ProgramItem program)
                        throws AmetysRepositoryException,
                               SAXException

Throws:

AmetysRepositoryException

SAXException

_writeOrgUnitLine

private void _writeOrgUnitLine(TransformerHandler handler,
                               CostComputationData costData,
                               OrgUnit orgUnit)
                        throws SAXException

Throws:

SAXException

_writeValues

private void _writeValues(TransformerHandler handler,
                          CostComputationData costData,
                          Content program,
                          String path)
                   throws SAXException

Throws:

SAXException

_getPath

private String _getPath(ProgramItem programItem,
                        Container step,
                        CostComputationData costData)