org.ametys.plugins.odfpilotage.report.impl

Class ApogeeReport

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

All Implemented Interfaces:

PilotageReport, LogEnabled, PluginAware, Initializable, Serviceable

public class ApogeeReport
extends AbstractReport

Pilotage report for Apogée.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ApogeeReport.ProgramTitleComparator

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 int	_order

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

Method Summary

Modifier and Type	Method and Description
private void	_generateReport(TransformerHandler handler, String uaiCode, String lang, String catalog) SAX the XML of the report
private Container	_getEtapePorteuse(Course course, String hierarchy)
private String	_getHierarchy(Program program, SubProgram subprogram, Container containerYear, Container containerSemester, String courseHierarchy)
private OrgUnit	_getOrgUnit(Course course, String hierarchy)
private String	_getPorte(Container etape, Container containerYear)
private Map<Program,Object>	_getStructure(String uaiCode, String lang, String catalog) Generate the data structure that will be used to create the report
protected void	_launchByOrgUnit(String uaiCode, String catalog, String lang) Launch a report generation on an orgunit.
private void	_saxChoiceList(TransformerHandler handler, CourseList list)
private void	_saxContainer(TransformerHandler handler, Container container, Course parentCourse)
private void	_saxCourse(TransformerHandler handler, Program program, SubProgram subprogram, Container containerYear, Container containerSemester, CourseList list, Integer listPosition, Course course, Course parentCourse, int level, boolean lastLevel, String courseHierarchy)
private void	_saxCourseFromTree(TransformerHandler handler, Map<ProgramItem,Object> programTree, Program program)
private void	_saxCourseFromTree(TransformerHandler handler, Map<ProgramItem,Object> tree, Program program, SubProgram subprogram, Container containerYear, Container containerSemester, CourseList list, Integer listPosition, Course parentCourse, int level, boolean lastLevel, String courseHierarchy)
private void	_saxCourseList(TransformerHandler handler, CourseList list, Integer position)
private void	_saxOrgUnits(TransformerHandler handler, Program program)
private void	_saxSubProgram(TransformerHandler handler, SubProgram subprogram)
private void	_saxTree(TransformerHandler handler, Map<Program,Object> programTree) Sax the information related to the courses of the tree
protected void	_writeApogeeReport(String uaiCode, String catalog, String lang) Create the Apogee report for one organization unit
protected String	getReportName() The report name to add in the mail.
protected String	getType() Get the name of the report
protected void	saxAdditionalCourseData(TransformerHandler handler, Course course) Sax a additional data of a Course.

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, service, 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

_order

private int _order

Constructor Detail

ApogeeReport

public ApogeeReport()

Method Detail

_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

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

_writeApogeeReport

protected void _writeApogeeReport(String uaiCode,
                                  String catalog,
                                  String lang)
                           throws SAXException,
                                  IOException,
                                  TransformerConfigurationException

Create the Apogee report for one organization unit

Parameters:

uaiCode - The UAI code of the org unit

catalog - The catalog

lang - The language

Throws:

SAXException - if an error occurs while saxing

IOException - if an I/O exception occurs

TransformerConfigurationException - if the SAX transformer is not configured properly

_generateReport

private void _generateReport(TransformerHandler handler,
                             String uaiCode,
                             String lang,
                             String catalog)
                      throws SAXException

SAX the XML of the report

Parameters:

handler - the transformer handler

uaiCode - the uai code of the organization unit to process

lang - the lang of the programs

catalog - the catalog of the programs

Throws:

SAXException - if an error occurs while generating the SAX events

_getStructure

private Map<Program,Object> _getStructure(String uaiCode,
                                          String lang,
                                          String catalog)

Generate the data structure that will be used to create the report

Parameters:

uaiCode - the uai code of the organization unit

lang - the lang of programs

catalog - the catalog of programs

Returns:

The structure

_saxTree

private void _saxTree(TransformerHandler handler,
                      Map<Program,Object> programTree)
               throws SAXException

Sax the information related to the courses of the tree

Parameters:

handler - the transformer handler

programTree - the program tree to sax

Throws:

SAXException - if an error occurs when SAXing

_saxCourseFromTree

private void _saxCourseFromTree(TransformerHandler handler,
                                Map<ProgramItem,Object> programTree,
                                Program program)
                         throws SAXException

Throws:

SAXException

_saxCourseFromTree

private void _saxCourseFromTree(TransformerHandler handler,
                                Map<ProgramItem,Object> tree,
                                Program program,
                                SubProgram subprogram,
                                Container containerYear,
                                Container containerSemester,
                                CourseList list,
                                Integer listPosition,
                                Course parentCourse,
                                int level,
                                boolean lastLevel,
                                String courseHierarchy)
                         throws SAXException

Throws:

SAXException

_getHierarchy

private String _getHierarchy(Program program,
                             SubProgram subprogram,
                             Container containerYear,
                             Container containerSemester,
                             String courseHierarchy)

_saxCourse

private void _saxCourse(TransformerHandler handler,
                        Program program,
                        SubProgram subprogram,
                        Container containerYear,
                        Container containerSemester,
                        CourseList list,
                        Integer listPosition,
                        Course course,
                        Course parentCourse,
                        int level,
                        boolean lastLevel,
                        String courseHierarchy)
                 throws SAXException

Throws:

SAXException

saxAdditionalCourseData

protected void saxAdditionalCourseData(TransformerHandler handler,
                                       Course course)
                                throws UnknownMetadataException,
                                       AmetysRepositoryException,
                                       SAXException

Sax a additional data of a Course.

Parameters:

handler - The handler

course - The course to SAX

Throws:

UnknownMetadataException - if an error occurs

AmetysRepositoryException - if an error occurs

SAXException - if an error occurs

_saxContainer

private void _saxContainer(TransformerHandler handler,
                           Container container,
                           Course parentCourse)
                    throws UnknownMetadataException,
                           AmetysRepositoryException,
                           SAXException

Throws:

UnknownMetadataException

AmetysRepositoryException

SAXException

_saxSubProgram

private void _saxSubProgram(TransformerHandler handler,
                            SubProgram subprogram)
                     throws UnknownMetadataException,
                            AmetysRepositoryException,
                            SAXException

Throws:

UnknownMetadataException

AmetysRepositoryException

SAXException

_saxOrgUnits

private void _saxOrgUnits(TransformerHandler handler,
                          Program program)
                   throws SAXException

Throws:

SAXException

_getPorte

private String _getPorte(Container etape,
                         Container containerYear)

_getOrgUnit

private OrgUnit _getOrgUnit(Course course,
                            String hierarchy)

_getEtapePorteuse

private Container _getEtapePorteuse(Course course,
                                    String hierarchy)

_saxCourseList

private void _saxCourseList(TransformerHandler handler,
                            CourseList list,
                            Integer position)
                     throws SAXException

Throws:

SAXException

_saxChoiceList

private void _saxChoiceList(TransformerHandler handler,
                            CourseList list)
                     throws SAXException

Throws:

SAXException