Package overit.geocallapp.wfm.core.bl.datacollection.instance.task

Class BTDataCollectionSheetInstanceExportXlsx

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionSheetInstanceExportXlsxEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask<DataCollectionSheetInstanceExportXlsxEvent>

overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollection<DataCollectionSheetInstanceExportXlsxEvent>

overit.geocallapp.wfm.core.bl.datacollection.instance.task.BTDataCollectionSheetInstanceExportXlsx

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionSheetInstanceExportXlsxEvent.class)
public class BTDataCollectionSheetInstanceExportXlsx
extends BTDataCollection<DataCollectionSheetInstanceExportXlsxEvent>

Business task in order to export the xlsx of a DataCollectionSheetInstance.
When the DataCollectionSheetInstanceExportXlsxEvent is launched the BT notices the call and exports the xlsx of the DataCollectionSheetInstance basing on the event's input.

Errors:

• Codes.C270_0909: Data to export not defined

Since:

12.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GENERIC_COLUMN_TAG
protected overit.geocallapp.wfm.util.wfmtasklog.WfmTaskLog	logger
protected static final String	MODEL_XLSX_SHEET_FILE_NAME
protected static final String	MODEL_XLSX_TABLE_VIEW_NAME
protected static final String	RECAP_XLSX_SHEET_NAME
protected static final String	SHEET_ID_COLUMN_LABEL
protected static final String	SHEET_ID_COLUMN_NAME
protected static final String	XLSX_DOCUMENT_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionSheetInstanceExportXlsx()

Method Summary

Modifier and Type	Method	Description
protected void	appendSheetsRecap(List<BODataCollectionSheet> sheets, XlsxDocument excelDocument, PoolKit poolKit)	Appends the sheets recap.
protected void	appendTemplateStructureSheetsModel(List<BODataCollectionSheet> sheets, XlsxDocument excelDocument, Teacher teacher)	Appends the template structure sheets model.
protected void	completeAccountDBViewData(DBView dbv, PoolKit poolKit)	Completes the account DB view data.
protected void	completeAssetDBViewData(DBView dbv, PoolKit poolKit)	Completes the asset DB view data.
protected void	completeDBViewData(DBView dbv, PoolKit poolKit)	Completes the DB view data.
protected void	execute(DataCollectionSheetInstanceExportXlsxEvent event, PoolKit poolKit)	Exports the xlsx associated to the data collection sheet instance.
protected BOCache<BOAccount>	getAccountCache()	Returns the account cache.
protected List<String>	getAdditionalColumns()	Returns the additional columns.
protected BOCache<BOAsset>	getAssetCache()
protected WebResource	getReportWebResource()	Returns the report web resource.
protected List<TreeModel<DataCollectionNode>>	getTreeModelNodes(BODataCollectionSheet sheet)	Returns the tree model nodes.
protected List<BODataCollectionSheet>	loadSheets(Map<String,Object> filters, PoolKit poolkit)	Loads the sheets.
protected void	logError(String message, String... parameters)	Logs the error.

Methods inherited from class overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollection

getException, isValidExecution, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask

body, checkValidExecution, getEvent

Methods inherited from class overit.geocall.bl.BusinessTask

start, start, startAlone, startInBackground

Methods inherited from class java.lang.Object

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

Field Details

XLSX_DOCUMENT_FILE_NAME

protected static final String XLSX_DOCUMENT_FILE_NAME

See Also:

• Constant Field Values

MODEL_XLSX_SHEET_FILE_NAME

protected static final String MODEL_XLSX_SHEET_FILE_NAME

See Also:

• Constant Field Values

RECAP_XLSX_SHEET_NAME

protected static final String RECAP_XLSX_SHEET_NAME

See Also:

• Constant Field Values

MODEL_XLSX_TABLE_VIEW_NAME

protected static final String MODEL_XLSX_TABLE_VIEW_NAME

See Also:

• Constant Field Values

GENERIC_COLUMN_TAG

protected static final String GENERIC_COLUMN_TAG

See Also:

• Constant Field Values

SHEET_ID_COLUMN_NAME

protected static final String SHEET_ID_COLUMN_NAME

See Also:

• Constant Field Values

SHEET_ID_COLUMN_LABEL

protected static final String SHEET_ID_COLUMN_LABEL

See Also:

• Constant Field Values

logger

protected overit.geocallapp.wfm.util.wfmtasklog.WfmTaskLog logger

Constructor Details

BTDataCollectionSheetInstanceExportXlsx

public BTDataCollectionSheetInstanceExportXlsx()

Method Details

execute

protected void execute(DataCollectionSheetInstanceExportXlsxEvent event,
 PoolKit poolKit)
                throws DAException,
DAValidateException

Exports the xlsx associated to the data collection sheet instance.

Specified by:

execute in class ValidExecutionBusinessTask<DataCollectionSheetInstanceExportXlsxEvent>

Parameters:

event - the DataCollectionSheetInstanceExportXlsxEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadSheets

protected List<BODataCollectionSheet> loadSheets(Map<String,Object> filters,
 PoolKit poolkit)
                                          throws DAValidateException,
DAException

Loads the sheets.

Parameters:

filters - the filters

poolkit - the PoolKit

Returns:

a list of BO data collection sheet elements of type BODataCollectionSheet

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

See Also:

• BODataCollectionSheet

appendSheetsRecap

protected void appendSheetsRecap(List<BODataCollectionSheet> sheets,
 XlsxDocument excelDocument,
 PoolKit poolKit)
                          throws DAException,
DAValidateException

Appends the sheets recap.

Parameters:

sheets - list of BODataCollectionSheet elements

excelDocument - the XlsxDocument

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendTemplateStructureSheetsModel

protected void appendTemplateStructureSheetsModel(List<BODataCollectionSheet> sheets,
 XlsxDocument excelDocument,
 Teacher teacher)
                                           throws DAException,
DAValidateException

Appends the template structure sheets model.

Parameters:

sheets - list of BODataCollectionSheet elements

excelDocument - the XlsxDocument

teacher - the teacher

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

logError

protected void logError(String message,
 String... parameters)

Logs the error.

Parameters:

message - the message

parameters - the parameters

getTreeModelNodes

protected List<TreeModel<DataCollectionNode>> getTreeModelNodes(BODataCollectionSheet sheet)

Returns the tree model nodes.

Parameters:

sheet - the BODataCollectionSheet

Returns:

a list of tree model elements of type TreeModel

See Also:

• TreeModel

getReportWebResource

protected WebResource getReportWebResource()

Returns the report web resource.

Returns:

the report web resource

completeDBViewData

protected void completeDBViewData(DBView dbv,
 PoolKit poolKit)
                           throws DAException,
DAValidateException

Completes the DB view data.

Parameters:

dbv - the DB view

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

completeAssetDBViewData

protected void completeAssetDBViewData(DBView dbv,
 PoolKit poolKit)
                                throws DAException,
DAValidateException

Completes the asset DB view data.

Parameters:

dbv - the DB view

poolKit - the pool kit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

completeAccountDBViewData

protected void completeAccountDBViewData(DBView dbv,
 PoolKit poolKit)
                                  throws DAException,
DAValidateException

Completes the account DB view data.

Parameters:

dbv - the DB view

poolKit - the pool kit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAdditionalColumns

protected List<String> getAdditionalColumns()

Returns the additional columns.

Returns:

the additional columns

getAccountCache

protected BOCache<BOAccount> getAccountCache()

Returns the account cache.

Returns:

the account cache

getAssetCache

protected BOCache<BOAsset> getAssetCache()