de.xima.fc.transform

Class AFdTransformBuilder

java.lang.Object

de.xima.fc.transform.AFdTransformBuilder

All Implemented Interfaces:

IFdTransformBuilder

Direct Known Subclasses:

FdToExcelBuilder, FdToXmlBuilder

public abstract class AFdTransformBuilder
extends Object
implements IFdTransformBuilder

Author:

XIMA MEDIA GmbH, Dresden - Michael Kohlsche - 29.08.2019

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	exportCreationDate
protected boolean	exportExportMetaData
protected boolean	exportModificationDate
protected boolean	exportProcessID
protected boolean	exportStatus
protected boolean	exportTechnicalFields
protected boolean	exportVariables

Constructor Summary

Constructors

Constructor and Description
AFdTransformBuilder()

Method Summary

Modifier and Type	Method and Description
protected List<FormElement>	getElementsList(FormVersion formVersion, HashMap<Long,List<FormElement>> elementMap, HashMap<Long,Set<String>> variablesMap) Method to get the list of FormElements of an FormVersion.
boolean	isExportCreationDate()
boolean	isExportExportMetadData()
boolean	isExportModificationDate()
boolean	isExportProcessID()
boolean	isExportStatus()
boolean	isExportTechnicalFields()
boolean	isExportVariables()
void	setExportCreationDate(boolean exportCreationDate)
void	setExportExportMetaData(boolean exportExportMetadata)
void	setExportModificationDate(boolean exportModificationDate)
void	setExportProcessID(boolean exportProcessID)
void	setExportStatus(boolean exportStatus)
void	setExportTechnicalFields(boolean exportTechnicalFields)
void	setExportVariables(boolean exportVariables)

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

withCreationDate, withExportMetaData, withModificationDate, withProcessID, withStatus, withTechnicalFields, withVariables

Field Detail

exportStatus

protected boolean exportStatus

exportProcessID

protected boolean exportProcessID

exportCreationDate

protected boolean exportCreationDate

exportModificationDate

protected boolean exportModificationDate

exportVariables

protected boolean exportVariables

exportTechnicalFields

protected boolean exportTechnicalFields

exportExportMetaData

protected boolean exportExportMetaData

Constructor Detail

AFdTransformBuilder

public AFdTransformBuilder()

Method Detail

isExportCreationDate

public boolean isExportCreationDate()

Specified by:

isExportCreationDate in interface IFdTransformBuilder

Returns:

boolean if the creation date of form records should be exported

isExportModificationDate

public boolean isExportModificationDate()

Specified by:

isExportModificationDate in interface IFdTransformBuilder

Returns:

boolean if the modification date of form records should be exported

isExportProcessID

public boolean isExportProcessID()

Specified by:

isExportProcessID in interface IFdTransformBuilder

Returns:

boolean if the process ids of form records should be exported

isExportStatus

public boolean isExportStatus()

Specified by:

isExportStatus in interface IFdTransformBuilder

Returns:

boolean if the status name of form records should be exported

isExportTechnicalFields

public boolean isExportTechnicalFields()

Specified by:

isExportTechnicalFields in interface IFdTransformBuilder

Returns:

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

isExportVariables

public boolean isExportVariables()

Specified by:

isExportVariables in interface IFdTransformBuilder

Returns:

boolean if variables of form records should be exported

isExportExportMetadData

public boolean isExportExportMetadData()

Specified by:

isExportExportMetadData in interface IFdTransformBuilder

Returns:

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

setExportStatus

public void setExportStatus(boolean exportStatus)

Specified by:

setExportStatus in interface IFdTransformBuilder

Parameters:

exportStatus - the exportStatus to set

setExportProcessID

public void setExportProcessID(boolean exportProcessID)

Specified by:

setExportProcessID in interface IFdTransformBuilder

Parameters:

exportProcessID - the exportProcessID to set

setExportCreationDate

public void setExportCreationDate(boolean exportCreationDate)

Specified by:

setExportCreationDate in interface IFdTransformBuilder

Parameters:

exportCreationDate - the exportCreationDate to set

setExportModificationDate

public void setExportModificationDate(boolean exportModificationDate)

Specified by:

setExportModificationDate in interface IFdTransformBuilder

Parameters:

exportModificationDate - the exportModificationDate to set

setExportVariables

public void setExportVariables(boolean exportVariables)

Specified by:

setExportVariables in interface IFdTransformBuilder

Parameters:

exportVariables - the exportVariables to set

setExportTechnicalFields

public void setExportTechnicalFields(boolean exportTechnicalFields)

Specified by:

setExportTechnicalFields in interface IFdTransformBuilder

Parameters:

exportTechnicalFields - the exportTechnicalFields to set

setExportExportMetaData

public void setExportExportMetaData(boolean exportExportMetadata)

Specified by:

setExportExportMetaData in interface IFdTransformBuilder

Parameters:

exportExportMetadata - the exportExportMetadata to set

getElementsList

protected List<FormElement> getElementsList(FormVersion formVersion,
                                            HashMap<Long,List<FormElement>> elementMap,
                                            HashMap<Long,Set<String>> variablesMap)

Method to get the list of FormElements of an FormVersion. This method caches the list of elements and ignores technical fields or variables if set so. Variables to ignore are also cached.

Parameters:

formVersion - the FormVersion to get the elements from

elementMap - a Map to cache the FormElements to the FormVersion.getId()

variablesMap - a Map to cache the name of variables to the FormVersion.getId()

Returns:

the list of FormElements to use for the export