org.ametys.plugins.odfpilotage.report.impl

Class MCCReport

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.AbstractMCCReport

org.ametys.plugins.odfpilotage.report.impl.MCCReport

All Implemented Interfaces:

PilotageReport, LogEnabled, PluginAware, Initializable, Serviceable

public class MCCReport
extends AbstractMCCReport

Class to generate the MCC report.

Nested Class Summary

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 and Description
private static Map<String,String>	__CONVERT_DEGREE

Fields inherited from class org.ametys.plugins.odfpilotage.report.impl.AbstractMCCReport

_metadataManager, _STRING2INTEGER_COMPARATOR

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

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

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

PARAMETER_CATALOG, PARAMETER_LANG, PARAMETER_ORGUNIT, PARAMETER_PROGRAM

Constructor Summary

Constructors

Constructor and Description
MCCReport()

Method Summary

Modifier and Type	Method and Description
private void	_saxSessionEntry(TransformerHandler handler, CompositeMetadata sessionMetadata, String entryName) Sax a MCC session entry.
protected String	getReportFileName(Program program) Get the report filename for a given program
protected String	getReportName() The report name to add in the mail.
protected String	getType() Get the name of the report
protected void	populateMCCAmetysObjectTree(MCCAmetysObjectTree tree) Populate the MCC tree.
protected void	saxGlobalInformations(TransformerHandler handler, Program program) Sax the additional global informations of the report.
protected void	saxMCCs(TransformerHandler handler, Course course, MCCAmetysObjectTree tree) Sax the MCC sessions.

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

_launchByOrgUnit, _processMCC, _writeReportsMcc, addProgram2MCCAmetysObjectTree, extractMCCAmetysObjectTree, saxContainer, saxCourse, saxCourseList, saxCourseParts, saxOrgUnit, saxProgram, saxSessionEntryDetails, saxSubProgram, saxTree, saxTreeChildren, service

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

launchByOrgUnit, launchByProgram

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

convertReport, createZipFile, getMailBody, getMailSubject, getPipeline, getPluginName, initialize, launch, sendMail, setPluginInfo

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

__CONVERT_DEGREE

private static final Map<String,String> __CONVERT_DEGREE

Constructor Detail

MCCReport

public MCCReport()

Method Detail

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

getReportName

protected String getReportName()

Description copied from class: AbstractPilotageReport

The report name to add in the mail.

Specified by:

getReportName in class AbstractPilotageReport

Returns:

The report name

saxMCCs

protected void saxMCCs(TransformerHandler handler,
                       Course course,
                       MCCAmetysObjectTree tree)
                throws SAXException

Description copied from class: AbstractMCCReport

Sax the MCC sessions.

Specified by:

saxMCCs in class AbstractMCCReport

Parameters:

handler - The transformer handler

course - The concerned Course to sax the MCCs on

tree - The MCC tree

Throws:

SAXException - If an error occurs

_saxSessionEntry

private void _saxSessionEntry(TransformerHandler handler,
                              CompositeMetadata sessionMetadata,
                              String entryName)
                       throws SAXException

Sax a MCC session entry.

Parameters:

handler - The transformer handler

sessionMetadata - The composite metadata holding the session

entryName - The session entry name

Throws:

SAXException - If an error occurs

populateMCCAmetysObjectTree

protected void populateMCCAmetysObjectTree(MCCAmetysObjectTree tree)

Description copied from class: AbstractMCCReport

Populate the MCC tree.

Specified by:

populateMCCAmetysObjectTree in class AbstractMCCReport

Parameters:

tree - The MCC tree

getReportFileName

protected String getReportFileName(Program program)

Description copied from class: AbstractMCCReport

Get the report filename for a given program

Specified by:

getReportFileName in class AbstractMCCReport

Parameters:

program - The program

Returns:

the file name

saxGlobalInformations

protected void saxGlobalInformations(TransformerHandler handler,
                                     Program program)
                              throws SAXException

Description copied from class: AbstractMCCReport

Sax the additional global informations of the report.

Specified by:

saxGlobalInformations in class AbstractMCCReport

Parameters:

handler - The transformer handler

program - The program on which the report is launched

Throws:

SAXException - If an error occurs