io.vertigo.dynamox.commons.template.export

Class ExportXlsHelper<R extends io.vertigo.dynamo.domain.model.DtObject>

java.lang.Object

io.vertigo.dynamox.commons.template.export.ExportXlsHelper<R>

Type Parameters:

R - Type d'objet pour la liste

public final class ExportXlsHelper<R extends io.vertigo.dynamo.domain.model.DtObject>
extends Object

Helper pour les editions xls.

Author:

kleegroup

Constructor Summary

Constructors

Constructor and Description
ExportXlsHelper(String fileName, String title) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addDtList(io.vertigo.dynamo.domain.model.DtList<R> dtcToExport, List<String> collectionColumnNameList, Map<String,String> specificLabelMap) Add a DTC to the export.
void	addDtObject(io.vertigo.dynamo.domain.model.DtObject criterion, List<String> criterionExcludedColumnNames) Add a criterion to the export.
void	prepareExport(io.vertigo.dynamo.domain.model.DtList<R> dtcToExport, List<String> collectionColumnNames, io.vertigo.dynamo.domain.model.DtObject criterion, List<String> criterionExcludedColumnNames, Map<String,String> specificLabelMap) Prepare the export generation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportXlsHelper

public ExportXlsHelper(String fileName,
                       String title)

Constructor.

Parameters:

fileName - nom du fichier résultat de l'export

title - titre de la feuille principale de l'export

Method Detail

prepareExport

public final void prepareExport(io.vertigo.dynamo.domain.model.DtList<R> dtcToExport,
                                List<String> collectionColumnNames,
                                io.vertigo.dynamo.domain.model.DtObject criterion,
                                List<String> criterionExcludedColumnNames,
                                Map<String,String> specificLabelMap)

Prepare the export generation. If the screen allows 2 exports, then one must use 2 actions

Parameters:

dtcToExport - the objects collection to be exported

collectionColumnNames - list of the columns taht must be exported in the collection

criterion - search criterion if exists

criterionExcludedColumnNames - list of the criteria that must be excluded for the export

specificLabelMap - map of the column names to be used instead of the default label associated with the field

addDtList

public final void addDtList(io.vertigo.dynamo.domain.model.DtList<R> dtcToExport,
                            List<String> collectionColumnNameList,
                            Map<String,String> specificLabelMap)

Add a DTC to the export.

Parameters:

dtcToExport - collection to be exported

collectionColumnNameList - names of the columns that must be exported

specificLabelMap - map of the column names to be used instead of the default label associated with the field

addDtObject

public final void addDtObject(io.vertigo.dynamo.domain.model.DtObject criterion,
                              List<String> criterionExcludedColumnNames)

Add a criterion to the export.

Parameters:

criterion - criterion object to be exported

criterionExcludedColumnNames - names of the columns to be excluded