Package overit.geocallapp.wfm.core.bl.datacollection.converter.template

Class DataCollectionTemplateConverter

java.lang.Object

overit.geocallapp.wfm.core.bl.datacollection.converter.DataCollectionBaseConverter<BODataCollectionTemplateConversion,DataCollectionTemplateConversionInsertEvent>

overit.geocallapp.wfm.core.bl.datacollection.converter.DataCollectionConverter<BODataCollectionTemplateConversion,DataCollectionTemplateConversionInsertEvent>

overit.geocallapp.wfm.core.bl.datacollection.converter.template.DataCollectionTemplateConverter

public class DataCollectionTemplateConverter
extends DataCollectionConverter<BODataCollectionTemplateConversion,DataCollectionTemplateConversionInsertEvent>

This class is responsible for Data Collection Template conversion.

Since:

13.0

GCApi:

bo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADTEISPDAGENERABLE
protected List<Long>	convertTemplateList
protected DataCollectionTemplateConverterDataRetriever	dataRetriever
static final String	DATASTAMP
static final String	LOGIN
protected DataCollectionTemplateStructureConverter	structureConverter
protected DataCollectionWorkCycleConverter	workCycleConverter

Fields inherited from class overit.geocallapp.wfm.core.bl.datacollection.converter.DataCollectionBaseConverter

CONNECTION_POOL_NAME, logger, teacherDuty

Constructor Summary

Constructors

Constructor	Description
DataCollectionTemplateConverter()

Method Summary

Modifier and Type	Method	Description
protected void	checkResults(PoolKit mainPoolKit, BODataCollectionTemplateConversion conversionLog, List<DataCollectionTemplateStructureConversionResult> structureConversionResultList, List<BODataCollectionWorkCycleConversion> workCycleConversionResultList)	Check if any error occurred during conversion steps and write the results on database.
void	convert(PoolKit poolKit, boolean isMassive)	Convert the templates.
void	convertBody(PoolKit poolKit)	The method that contains the conversion logic.
String	getLogDescription()	Get the description to have in WfmTaskLog.
protected void	initData(PoolKit poolKit)	Initialize the list of template to convert.
protected void	initLogger(Long id)	Initialize the logger and pass it to sub converters.
protected void	populateCreationDateAndUser(PoolKit poolKit, Long templateId, BODataCollectionTemplateHeader newTemplateHead)	Set creation user and creation date on new template to match the old one.
protected void	populateLastModifiedDateAndUser(PoolKit poolKit, Long templateId, BODataCollectionTemplateHeader newTemplateHead)	Set last modified user and date on new template to match the old one.
protected BODataCollectionTemplateHeader	searchTemplateHeader(PoolKit poolKit, overit.geocallapp.wfm.survey.template.TemplateTree oldTemplateTree)	Search for a new template header with the same code as the old template passed as parameter.
protected void	updateLastModifiedUser(PoolKit poolKit, overit.geocallapp.wfm.survey.template.TemplateTree oldTemplateTree, DataCollectionTemplate dataCollectionTemplate)	Updates create/last-modified user and date to match the old template users and dates.

Methods inherited from class overit.geocallapp.wfm.core.bl.datacollection.converter.DataCollectionConverter

closeLogger, initLogger, isMassive, setMassive

Methods inherited from class overit.geocallapp.wfm.core.bl.datacollection.converter.DataCollectionBaseConverter

commit, getLocalizedDescription, getTeacher, insertConversionResult, rollback, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ADTEISPDAGENERABLE

public static final String ADTEISPDAGENERABLE

See Also:

• Constant Field Values

DATASTAMP

public static final String DATASTAMP

See Also:

• Constant Field Values

LOGIN

public static final String LOGIN

See Also:

• Constant Field Values

dataRetriever

protected DataCollectionTemplateConverterDataRetriever dataRetriever

convertTemplateList

protected List<Long> convertTemplateList

structureConverter

protected DataCollectionTemplateStructureConverter structureConverter

workCycleConverter

protected DataCollectionWorkCycleConverter workCycleConverter

Constructor Details

DataCollectionTemplateConverter

public DataCollectionTemplateConverter()

Method Details

initData

protected void initData(PoolKit poolKit)
                 throws DAException,
DAValidateException

Initialize the list of template to convert.

Parameters:

poolKit - the PoolKit

Throws:

DAException

DAValidateException

convert

public void convert(PoolKit poolKit,
 boolean isMassive)
             throws DAException,
DAValidateException

Convert the templates.

Overrides:

convert in class DataCollectionConverter<BODataCollectionTemplateConversion,DataCollectionTemplateConversionInsertEvent>

Parameters:

poolKit - the pool kit

isMassive - true to convert all templates, false to convert only a subset.

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

convertBody

public void convertBody(PoolKit poolKit)
                 throws DAException,
DAValidateException

The method that contains the conversion logic.

Specified by:

convertBody in class DataCollectionConverter<BODataCollectionTemplateConversion,DataCollectionTemplateConversionInsertEvent>

Parameters:

poolKit - the pool kit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

searchTemplateHeader

protected BODataCollectionTemplateHeader searchTemplateHeader(PoolKit poolKit,
 overit.geocallapp.wfm.survey.template.TemplateTree oldTemplateTree)
                                                       throws DAException,
DAValidateException

Search for a new template header with the same code as the old template passed as parameter.

Parameters:

poolKit - the PoolKit

oldTemplateTree - the old template

Returns:

the new template header if found, null otherwise.

Throws:

DAException

DAValidateException

checkResults

protected void checkResults(PoolKit mainPoolKit,
 BODataCollectionTemplateConversion conversionLog,
 List<DataCollectionTemplateStructureConversionResult> structureConversionResultList,
 List<BODataCollectionWorkCycleConversion> workCycleConversionResultList)
                     throws DAException,
DAValidateException

Check if any error occurred during conversion steps and write the results on database.

Parameters:

mainPoolKit - the main PoolKit

conversionLog - the template conversion log

structureConversionResultList - the structure conversion results

workCycleConversionResultList - the work cycle conversion results

Throws:

DAException

DAValidateException

updateLastModifiedUser

protected void updateLastModifiedUser(PoolKit poolKit,
 overit.geocallapp.wfm.survey.template.TemplateTree oldTemplateTree,
 DataCollectionTemplate dataCollectionTemplate)
                               throws DAException,
DAValidateException,
SQLException

Updates create/last-modified user and date to match the old template users and dates.

Parameters:

poolKit - the PoolKit

oldTemplateTree - the old template

dataCollectionTemplate - the new template

Throws:

DAException

DAValidateException

SQLException

populateCreationDateAndUser

protected void populateCreationDateAndUser(PoolKit poolKit,
 Long templateId,
 BODataCollectionTemplateHeader newTemplateHead)
                                    throws DAException,
SQLException,
DAValidateException

Set creation user and creation date on new template to match the old one.

Parameters:

poolKit - the PoolKit

templateId - old template id

newTemplateHead - new template header

Throws:

DAException

SQLException

DAValidateException

populateLastModifiedDateAndUser

protected void populateLastModifiedDateAndUser(PoolKit poolKit,
 Long templateId,
 BODataCollectionTemplateHeader newTemplateHead)
                                        throws DAException,
SQLException,
DAValidateException

Set last modified user and date on new template to match the old one.

Parameters:

poolKit - the PoolKit

templateId - old template id

newTemplateHead - new template header

Throws:

DAException

SQLException

DAValidateException

getLogDescription

public String getLogDescription()

Get the description to have in WfmTaskLog.

Specified by:

getLogDescription in class DataCollectionConverter<BODataCollectionTemplateConversion,DataCollectionTemplateConversionInsertEvent>

Returns:

the description

initLogger

protected void initLogger(Long id)
                   throws DAException,
DAValidateException

Initialize the logger and pass it to sub converters.

Overrides:

initLogger in class DataCollectionConverter<BODataCollectionTemplateConversion,DataCollectionTemplateConversionInsertEvent>

Parameters:

id - the unique identifier of the object to be converted

Throws:

DAException

DAValidateException