Class AbstractExtract
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.odfpilotage.report.AbstractPilotageReport
org.ametys.plugins.odfpilotage.report.impl.AbstractExtract
- All Implemented Interfaces:
PilotageReport
,LogEnabled
,PluginAware
,Configurable
,Serviceable
- Direct Known Subclasses:
ConsistencyExtract
,MaquetteExtract
,ReglementEtudesExtract
The abstract class for extractions
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.ametys.plugins.odfpilotage.report.PilotageReport
PilotageReport.PilotageReportContent, PilotageReport.PilotageReportTarget
-
Field Summary
Fields inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport
_odfHelper, _pilotageHelper, _refTableHelper, _reportHelper, _resolver, MANIFEST_FILENAME
Fields inherited from interface org.ametys.plugins.odfpilotage.report.PilotageReport
OUTPUT_FORMAT_CSV, OUTPUT_FORMAT_DOC, OUTPUT_FORMAT_PDF, OUTPUT_FORMAT_XLS, PARAMETER_CATALOG, PARAMETER_LANG, PARAMETER_ORGUNIT, PARAMETER_OUTPUT_FORMAT, PARAMETER_PROGRAM
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
_saxOrgUnit
(ContentHandler handler, String catalog, String lang, String orgUnitId, Map<String, String> reportParameters) Sax an org unit on the given content handler from the orgunit identifier and report parametersprotected PilotageReport.PilotageReportContent
getReportContentForOrgUnit
(String outputFormat, Map<String, String> reportParameters) Launch a report generation on an orgunit.protected PilotageReport.PilotageReportContent
getReportContentForProgram
(String outputFormat, Map<String, String> reportParameters) Launch a report generation on a program.Get the list of supported output formatsprotected boolean
Returnstrue
if the target is supported by the report.Methods inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport
_getReportContentForOrgUnit, _getReportContentForProgram, _getReportContentForProgramsInOrgUnit, configure, getDefaultOutputFormat, getId, getLabel, getPluginName, getReportContent, getReportFileName, getReportFileName, getType, getType, isCompatibleSchedulable, isGeneric, isSupportedFormat, saxOrgUnit, service, 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
Methods inherited from interface org.ametys.plugins.odfpilotage.report.PilotageReport
saxProgramItem
-
Constructor Details
-
AbstractExtract
public AbstractExtract()
-
-
Method Details
-
isSupportedTarget
Description copied from class:AbstractPilotageReport
Returnstrue
if the target is supported by the report.- Specified by:
isSupportedTarget
in classAbstractPilotageReport
- Parameters:
target
- The target to test- Returns:
true
if the target is supported,false
otherwise
-
getSupportedOutputFormats
Description copied from interface:PilotageReport
Get the list of supported output formats- Specified by:
getSupportedOutputFormats
in interfacePilotageReport
- Overrides:
getSupportedOutputFormats
in classAbstractPilotageReport
- Returns:
- A
Set
of supported output formats
-
getReportContentForProgram
protected PilotageReport.PilotageReportContent getReportContentForProgram(String outputFormat, Map<String, String> reportParameters) Description copied from class:AbstractPilotageReport
Launch a report generation on a program.- Specified by:
getReportContentForProgram
in classAbstractPilotageReport
- Parameters:
outputFormat
- The output formatreportParameters
- The report parameters- Returns:
- the name of the generated file
-
getReportContentForOrgUnit
protected PilotageReport.PilotageReportContent getReportContentForOrgUnit(String outputFormat, Map<String, String> reportParameters) Description copied from class:AbstractPilotageReport
Launch a report generation on an orgunit.- Specified by:
getReportContentForOrgUnit
in classAbstractPilotageReport
- Parameters:
outputFormat
- The output formatreportParameters
- The report parameters- Returns:
- the name of the generated file
-
_saxOrgUnit
public void _saxOrgUnit(ContentHandler handler, String catalog, String lang, String orgUnitId, Map<String, String> reportParameters) Description copied from class:AbstractPilotageReport
Sax an org unit on the given content handler from the orgunit identifier and report parameters- Specified by:
_saxOrgUnit
in classAbstractPilotageReport
- Parameters:
handler
- The handlercatalog
- The cataloglang
- The languageorgUnitId
- The orgunit identifierreportParameters
- The report parameters
-