Package org.ametys.odf.ose.export.impl.odf

Class AbstractProgramElementExporter<T extends Content & ProgramItem>

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.ose.export.impl.odf.AbstractProgramElementExporter<T>

Type Parameters:

T - The type of the element to export, should extend Content and ProgramItem

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

CourseExporter, ProgramPartExporter

public abstract class AbstractProgramElementExporter<T extends Content & ProgramItem>
extends AbstractLogEnabled
implements Component, Serviceable

Exporter for program elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractProgramElementExporter.ProgramElementData	An object to represent common computed data on the program element like orgunit, step holder, etc.

Field Summary

Fields

Modifier and Type	Field	Description
protected ElementRetriever	_elementRetriever	The retriever of elements from ODF

Constructor Summary

Constructors

Constructor	Description
AbstractProgramElementExporter()

Method Summary

Modifier and Type	Method	Description
private String	_getFirstOrgUnitCode(Set<OrgUnit> orgUnits)
private String	_getFirstRefTableCode(Set<OdfReferenceTableEntry> entries)
private Container	_getFirstStepHolder(Set<Container> stepsHolder)
protected abstract List<ParameterizableQuery>	_getQueries(T programElement, AbstractProgramElementExporter.ProgramElementData data, Long oseCatalog, CostComputationData costData)	Get the queries to create the program element in the OSE database.
List<ParameterizableQuery>	getQueries(T programElement, Long oseCatalog, CostComputationData costData)	Get queries to export the given program element.
void	service(ServiceManager manager)

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

_elementRetriever

protected ElementRetriever _elementRetriever

The retriever of elements from ODF

Constructor Detail

AbstractProgramElementExporter

public AbstractProgramElementExporter()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getQueries

public List<ParameterizableQuery> getQueries(T programElement,
                                             Long oseCatalog,
                                             CostComputationData costData)

Get queries to export the given program element.

Parameters:

programElement - The program element to export

oseCatalog - The OSE catalog

costData - the result of cost computation of the catalog

Returns:

A List of ParameterizableQuery to export the program element, it can be empty if there is a problem (see logs)

_getQueries

protected abstract List<ParameterizableQuery> _getQueries(T programElement,
                                                          AbstractProgramElementExporter.ProgramElementData data,
                                                          Long oseCatalog,
                                                          CostComputationData costData)

Get the queries to create the program element in the OSE database.

Parameters:

programElement - The program element

data - The calculated data attached to the program element

oseCatalog - The OSE catalog

costData - the result of cost computation of the catalog

Returns:

The list of queries

_getFirstStepHolder

private Container _getFirstStepHolder(Set<Container> stepsHolder)

_getFirstOrgUnitCode

private String _getFirstOrgUnitCode(Set<OrgUnit> orgUnits)

_getFirstRefTableCode

private String _getFirstRefTableCode(Set<OdfReferenceTableEntry> entries)