org.ametys.plugins.odfpilotage.report.impl

Class AbstractMCCReport

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

All Implemented Interfaces:

PilotageReport, LogEnabled, PluginAware, Initializable, Serviceable

Direct Known Subclasses:

MCCDiffReport, MCCReport

public abstract class AbstractMCCReport
extends AbstractReport

Class to generate a report based on MCC.

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
protected MetadataManager	_metadataManager The metadata manager
protected static Comparator<String>	_STRING2INTEGER_COMPARATOR The String cast into Integer 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
AbstractMCCReport()

Method Summary

Modifier and Type	Method and Description
private Long	_getCodeAnu(MCCAmetysObjectTree tree) Recurse through containers and courses to find a code anu.
protected void	_launchByOrgUnit(String uaiCode, String catalog, String lang) Launch a report generation on an orgunit.
protected MCCAmetysObjectTree	_processMCC(String uaiCode, String lang, String catalog) Processing of the MCC
protected void	_writeReportsMcc(MCCAmetysObjectTree tree) Create the MCC report for one organization unit
protected void	addProgram2MCCAmetysObjectTree(MCCAmetysObjectTree tree, Program program) Add and populate the program to the MCCAmetysObjectTree
protected MCCAmetysObjectTree	extractMCCAmetysObjectTree(OrgUnit ou, List<Program> programs) Extract the tree of Ametys object of interested.
protected abstract String	getReportFileName(Program program) Get the report filename for a given program
protected abstract void	populateMCCAmetysObjectTree(MCCAmetysObjectTree tree) Populate the MCC tree.
protected void	saxContainer(TransformerHandler handler, Container container, MCCAmetysObjectTree tree) Sax a Container.
protected void	saxCourse(TransformerHandler handler, Course course, MCCAmetysObjectTree tree) Sax a Course.
protected void	saxCourseList(TransformerHandler handler, CourseList courseList, MCCAmetysObjectTree tree) Sax a CourseList.
protected void	saxCourseParts(TransformerHandler handler, Course course) Sax the CourseParts containing in a Course.
protected abstract void	saxGlobalInformations(TransformerHandler handler, Program program) Sax the additional global informations of the report.
protected abstract void	saxMCCs(TransformerHandler handler, Course course, MCCAmetysObjectTree tree) Sax the MCC sessions.
protected void	saxOrgUnit(TransformerHandler handler, OrgUnit orgunit, MCCAmetysObjectTree tree) Sax an OrgUnit.
protected void	saxProgram(TransformerHandler handler, Program program, MCCAmetysObjectTree tree) Sax a Program.
protected void	saxSessionEntryDetails(TransformerHandler handler, CompositeMetadata sessionEntry) Sax the details of a MCC session entry.
protected void	saxSubProgram(TransformerHandler handler, SubProgram subProgram, MCCAmetysObjectTree tree) Sax a SubProgram.
protected void	saxTree(TransformerHandler handler, MCCAmetysObjectTree tree) SAX the MCC tree for the report
protected void	saxTreeChildren(TransformerHandler handler, MCCAmetysObjectTree tree) Iterate on tree's children.
void	service(ServiceManager manager)

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, getReportName, getType, 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

_STRING2INTEGER_COMPARATOR

protected static final Comparator<String> _STRING2INTEGER_COMPARATOR

The String cast into Integer comparator

_metadataManager

protected MetadataManager _metadataManager

The metadata manager

Constructor Detail

AbstractMCCReport

public AbstractMCCReport()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractPilotageReport

Throws:

ServiceException

_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

_processMCC

protected MCCAmetysObjectTree _processMCC(String uaiCode,
                                          String lang,
                                          String catalog)

Processing of the MCC

Parameters:

uaiCode - the UAI code of the orgunit

lang - The language code

catalog - The catalogue

Returns:

MCCAmetysObjectTree

_writeReportsMcc

protected void _writeReportsMcc(MCCAmetysObjectTree tree)
                         throws SAXException,
                                IOException,
                                TransformerConfigurationException

Create the MCC report for one organization unit

Parameters:

tree - The MCC tree

Throws:

SAXException - if an error occurs

IOException - if an error occurs

TransformerConfigurationException - if an error occurs

saxTree

protected void saxTree(TransformerHandler handler,
                       MCCAmetysObjectTree tree)
                throws SAXException

SAX the MCC tree for the report

Parameters:

handler - The handler

tree - The MCC tree

Throws:

SAXException - if an error occurs

saxOrgUnit

protected void saxOrgUnit(TransformerHandler handler,
                          OrgUnit orgunit,
                          MCCAmetysObjectTree tree)
                   throws SAXException

Sax an OrgUnit.

Parameters:

handler - The transformer handler

orgunit - The orgunit to sax

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxProgram

protected void saxProgram(TransformerHandler handler,
                          Program program,
                          MCCAmetysObjectTree tree)
                   throws SAXException

Sax a Program.

Parameters:

handler - The transformer handler

program - The program to sax

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxSubProgram

protected void saxSubProgram(TransformerHandler handler,
                             SubProgram subProgram,
                             MCCAmetysObjectTree tree)
                      throws SAXException

Sax a SubProgram.

Parameters:

handler - The transformer handler

subProgram - The subprogram to sax

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxContainer

protected void saxContainer(TransformerHandler handler,
                            Container container,
                            MCCAmetysObjectTree tree)
                     throws SAXException

Sax a Container.

Parameters:

handler - The transformer handler

container - The container to sax

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxCourseList

protected void saxCourseList(TransformerHandler handler,
                             CourseList courseList,
                             MCCAmetysObjectTree tree)
                      throws SAXException

Sax a CourseList.

Parameters:

handler - The transformer handler

courseList - The course list to sax

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxCourse

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

Sax a Course.

Parameters:

handler - The transformer handler

course - The course to sax

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxTreeChildren

protected void saxTreeChildren(TransformerHandler handler,
                               MCCAmetysObjectTree tree)
                        throws SAXException

Iterate on tree's children.

Parameters:

handler - The transformer handler

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxCourseParts

protected void saxCourseParts(TransformerHandler handler,
                              Course course)
                       throws SAXException

Sax the CourseParts containing in a Course.

Parameters:

handler - The transformer handler

course - The course with course parts to sax

Throws:

SAXException - If an error occurs

saxMCCs

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

Sax the MCC sessions.

Parameters:

handler - The transformer handler

course - The concerned Course to sax the MCCs on

tree - The MCC tree

Throws:

SAXException - If an error occurs

saxSessionEntryDetails

protected void saxSessionEntryDetails(TransformerHandler handler,
                                      CompositeMetadata sessionEntry)
                               throws SAXException

Sax the details of a MCC session entry.

Parameters:

handler - The transformer handler

sessionEntry - The session entry composite metadata to sax

Throws:

SAXException - If an error occurs

extractMCCAmetysObjectTree

protected MCCAmetysObjectTree extractMCCAmetysObjectTree(OrgUnit ou,
                                                         List<Program> programs)

Extract the tree of Ametys object of interested.

Parameters:

ou - the orgunit to extract the MCC from

programs - the list of associated programs

Returns:

MCCAmetysObjectTree

addProgram2MCCAmetysObjectTree

protected void addProgram2MCCAmetysObjectTree(MCCAmetysObjectTree tree,
                                              Program program)

Add and populate the program to the MCCAmetysObjectTree

Parameters:

tree - The object tree

program - The program to add

populateMCCAmetysObjectTree

protected abstract void populateMCCAmetysObjectTree(MCCAmetysObjectTree tree)

Populate the MCC tree.

Parameters:

tree - The MCC tree

_getCodeAnu

private Long _getCodeAnu(MCCAmetysObjectTree tree)

Recurse through containers and courses to find a code anu.

Parameters:

tree - The MCC tree

Returns:

Return the Code ANU

getReportFileName

protected abstract String getReportFileName(Program program)

Get the report filename for a given program

Parameters:

program - The program

Returns:

the file name

saxGlobalInformations

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

Sax the additional global informations of the report.

Parameters:

handler - The transformer handler

program - The program on which the report is launched

Throws:

SAXException - If an error occurs