de.xima.fc.transform.excel

Class FdToExcelBuilder

java.lang.Object

de.xima.fc.transform.AFdTransformBuilder

de.xima.fc.transform.excel.FdToExcelBuilder

All Implemented Interfaces:

IFdTransformBuilder

public class FdToExcelBuilder
extends AFdTransformBuilder
implements IFdTransformBuilder

Builder to transform form-data to excel

Field Summary

Fields inherited from class de.xima.fc.transform.AFdTransformBuilder

exportCreationDate, exportExportMetaData, exportModificationDate, exportProcessID, exportStatus, exportTechnicalFields, exportVariables

Constructor Summary

Constructors

Constructor and Description
FdToExcelBuilder()

Method Summary

Modifier and Type	Method and Description
FdToExcelResult	buildForInbox(UserContext uc, Benutzer user, de.xima.cmn.criteria.QueryCriteriaManager qcm) Builds the excel export of Vorgang´s determined with an QueryCriteriaManager
FdToExcelResult	buildForProcessIDs(UserContext uc, Benutzer user, List<Long> processIDs) Builds the excel export for an list of Vorgang.getId()´s
FdToExcelResult	buildForProjectInbox(Projekt projekt, List<ExtendedEntityModel<Vorgang>> records) Builds the excel export for an list of ExtendedEntityModel´s of Vorgang´s
FdToExcelBuilder	withColumnLableType(EColumnLabelType columnLabelType)
FdToExcelBuilder	withCreationDate(boolean withCreationDate)
FdToExcelBuilder	withExportMetaData(boolean withExportMetaData)
FdToExcelBuilder	withModificationDate(boolean withModificationDate)
FdToExcelBuilder	withMultiline(boolean multiline)
FdToExcelBuilder	withProcessID(boolean withProcessID)
FdToExcelBuilder	withStatus(boolean withStatus)
FdToExcelBuilder	withTechnicalFields(boolean withTechnicalFields)
FdToExcelBuilder	withVariables(boolean withVariables)

Methods inherited from class de.xima.fc.transform.AFdTransformBuilder

getElementsList, isExportCreationDate, isExportExportMetadData, isExportModificationDate, isExportProcessID, isExportStatus, isExportTechnicalFields, isExportVariables, setExportCreationDate, setExportExportMetaData, setExportModificationDate, setExportProcessID, setExportStatus, setExportTechnicalFields, setExportVariables

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.transform.IFdTransformBuilder

isExportCreationDate, isExportExportMetadData, isExportModificationDate, isExportProcessID, isExportStatus, isExportTechnicalFields, isExportVariables, setExportCreationDate, setExportExportMetaData, setExportModificationDate, setExportProcessID, setExportStatus, setExportTechnicalFields, setExportVariables

Constructor Detail

FdToExcelBuilder

public FdToExcelBuilder()

Method Detail

withCreationDate

public FdToExcelBuilder withCreationDate(boolean withCreationDate)

Specified by:

withCreationDate in interface IFdTransformBuilder

Parameters:

withCreationDate - if the creation date of form records should be exported

Returns:

this builder instance

withModificationDate

public FdToExcelBuilder withModificationDate(boolean withModificationDate)

Specified by:

withModificationDate in interface IFdTransformBuilder

Parameters:

withModificationDate - if the modification date of form records should be exported

Returns:

this builder instance

withProcessID

public FdToExcelBuilder withProcessID(boolean withProcessID)

Specified by:

withProcessID in interface IFdTransformBuilder

Parameters:

withProcessID - if the process ids of form records should be exported

Returns:

this builder instance

withStatus

public FdToExcelBuilder withStatus(boolean withStatus)

Specified by:

withStatus in interface IFdTransformBuilder

Parameters:

withStatus - if the status name of form records should be exported

Returns:

this builder instance

withTechnicalFields

public FdToExcelBuilder withTechnicalFields(boolean withTechnicalFields)

Specified by:

withTechnicalFields in interface IFdTransformBuilder

Parameters:

withTechnicalFields - if technical fields (e.g. xf-action) of form records should be exported

Returns:

this builder instance

withVariables

public FdToExcelBuilder withVariables(boolean withVariables)

Specified by:

withVariables in interface IFdTransformBuilder

Parameters:

withVariables - if variables of form records should be exported

Returns:

this builder instance

withExportMetaData

public FdToExcelBuilder withExportMetaData(boolean withExportMetaData)

Specified by:

withExportMetaData in interface IFdTransformBuilder

Parameters:

withExportMetaData - if metadata (e.g. export data, FORMCYCLE-version,...) of the export should be exported too

Returns:

this builder instance

withMultiline

public FdToExcelBuilder withMultiline(boolean multiline)

Parameters:

multiline - boolean if the export of records with dynamic should be made with multiple lines

Returns:

this builder instance

withColumnLableType

public FdToExcelBuilder withColumnLableType(EColumnLabelType columnLabelType)

Parameters:

columnLabelType - the EColumnLabelType to use while createing the export

Returns:

this builder instance

buildForInbox

public FdToExcelResult buildForInbox(UserContext uc,
                                     Benutzer user,
                                     de.xima.cmn.criteria.QueryCriteriaManager qcm)
                              throws com.alibaba.fastjson.JSONException,
                                     IOException

Builds the excel export of Vorgang´s determined with an QueryCriteriaManager

Parameters:

uc - the UserContext to user for the export

user - the Benutzer to filter the records for. If the user haven´t access to the current inbox of an process, it shouldn´t be exported

qcm - the QueryCriteriaManager to read the Vorgang´s

Returns:

the FdToExcelResult

Throws:

com.alibaba.fastjson.JSONException - on errors while creating the forms to determine the metadata for the export

IOException - on errors while creating the forms to determine the metadata for the export

buildForProcessIDs

public FdToExcelResult buildForProcessIDs(UserContext uc,
                                          Benutzer user,
                                          List<Long> processIDs)
                                   throws com.alibaba.fastjson.JSONException,
                                          IOException

Builds the excel export for an list of Vorgang.getId()´s

Parameters:

uc - the UserContext to user for the export

user - the Benutzer to filter the records for. If the user haven´t access to the current inbox of an process, it shouldn´t be exported

processIDs - an List of Vorgang.getId()'s

Returns:

the FdToExcelResult

Throws:

com.alibaba.fastjson.JSONException - on errors while creating the forms to determine the metadata for the export

IOException - on errors while creating the forms to determine the metadata for the export

buildForProjectInbox

public FdToExcelResult buildForProjectInbox(Projekt projekt,
                                            List<ExtendedEntityModel<Vorgang>> records)

Builds the excel export for an list of ExtendedEntityModel´s of Vorgang´s

Parameters:

projekt - the Projekt to use the the inbox-columns for

records - the List of ExtendedEntityModel´s of Vorgang´s

Returns:

the FdToExcelResult