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
,Initializable
,Configurable
,Serviceable
- Direct Known Subclasses:
ConsistencyExtract
,MaquetteExtract
,ReglementEtudesExtract
public abstract class AbstractExtract extends AbstractPilotageReport
The abstract class for extractions
-
-
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 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 AbstractExtract()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private void
_saxOrgUnit(OrgUnit orgUnit, String lang, String catalog)
protected abstract void
_saxProgram(Program program)
Sax a program for the extraction.protected Set<String>
getSupportedOutputFormats()
Get the list of supported output formatsprotected boolean
isSupportedTarget(PilotageReport.PilotageReportTarget target)
Returnstrue
if the target is supported by the report.protected String
launchByOrgUnit(Map<String,String> reportParameters)
Launch a report generation on an orgunit.protected String
launchByProgram(Map<String,String> reportParameters)
Launch a report generation on a program.-
Methods inherited from class org.ametys.plugins.odfpilotage.report.AbstractPilotageReport
_buildZipName, addManifest, configure, convertReport, createZipFile, getId, getLabel, getMailBody, getMailSubject, getOutputFormat, getPipeline, getPluginName, getReportName, getType, initialize, isCompatibleSchedulable, isGeneric, isSupportedFormat, launch, sendMail, service, setPluginInfo, supports
-
Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger
-
-
-
-
Constructor Detail
-
AbstractExtract
public AbstractExtract()
-
-
Method Detail
-
isSupportedTarget
protected boolean isSupportedTarget(PilotageReport.PilotageReportTarget target)
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
protected Set<String> getSupportedOutputFormats()
Description copied from class:AbstractPilotageReport
Get the list of supported output formats- Overrides:
getSupportedOutputFormats
in classAbstractPilotageReport
- Returns:
- A
Set
of supported output formats
-
launchByProgram
protected String launchByProgram(Map<String,String> reportParameters) throws Exception
Description copied from class:AbstractPilotageReport
Launch a report generation on a program.- Specified by:
launchByProgram
in classAbstractPilotageReport
- Parameters:
reportParameters
- The report parameters- Returns:
- the name of the generated file
- Throws:
Exception
- if an exception occurs
-
launchByOrgUnit
protected String launchByOrgUnit(Map<String,String> reportParameters) throws Exception
Description copied from class:AbstractPilotageReport
Launch a report generation on an orgunit.- Specified by:
launchByOrgUnit
in classAbstractPilotageReport
- Parameters:
reportParameters
- The report parameters- Returns:
- the name of the generated file
- Throws:
Exception
- if an exception occurs
-
_saxOrgUnit
private void _saxOrgUnit(OrgUnit orgUnit, String lang, String catalog)
-
_saxProgram
protected abstract void _saxProgram(Program program)
Sax a program for the extraction.- Parameters:
program
- Program to sax
-
-