Package 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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	exportCreationDate
protected boolean	exportExportMetaData
protected boolean	exportID
protected boolean	exportInbox
protected boolean	exportModificationDate
protected boolean	exportProcessID
protected boolean	exportStatus
protected boolean	exportSubject
protected boolean	exportTechnicalFields
protected boolean	exportVariables
protected Projekt	inboxProject
protected boolean	isForProjectInbox

Constructor Summary

Constructors

Constructor	Description
AFdTransformBuilder()

Method Summary

Modifier and Type	Method	Description
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.
protected String	getIdAttr()
boolean	isExportCreationDate()
boolean	isExportExportMetaData()
boolean	isExportID()
boolean	isExportInbox()
boolean	isExportModificationDate()
boolean	isExportProcessID()
boolean	isExportStatus()
boolean	isExportSubject()
boolean	isExportTechnicalFields()
boolean	isExportVariables()
void	setExportCreationDate(boolean exportCreationDate)
void	setExportExportMetaData(boolean exportExportMetadata)
void	setExportID(boolean exportID)
void	setExportInbox(boolean exportInbox)
void	setExportModificationDate(boolean exportModificationDate)
void	setExportProcessID(boolean exportProcessID)
void	setExportStatus(boolean exportStatus)
void	setExportSubject(boolean exportSubject)
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

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

Field Detail

exportID

protected boolean exportID

exportSubject

protected boolean exportSubject

exportInbox

protected boolean exportInbox

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

inboxProject

protected Projekt inboxProject

isForProjectInbox

protected boolean isForProjectInbox

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

setExportCreationDate

public void setExportCreationDate(boolean exportCreationDate)

Specified by:

setExportCreationDate in interface IFdTransformBuilder

Parameters:

exportCreationDate - the exportCreationDate to set

isExportModificationDate

public boolean isExportModificationDate()

Specified by:

isExportModificationDate in interface IFdTransformBuilder

Returns:

boolean if the modification date of form records should be exported

setExportModificationDate

public void setExportModificationDate(boolean exportModificationDate)

Specified by:

setExportModificationDate in interface IFdTransformBuilder

Parameters:

exportModificationDate - the exportModificationDate to set

isExportProcessID

public boolean isExportProcessID()

Specified by:

isExportProcessID in interface IFdTransformBuilder

Returns:

boolean if the process ids of form records should be exported

setExportProcessID

public void setExportProcessID(boolean exportProcessID)

Specified by:

setExportProcessID in interface IFdTransformBuilder

Parameters:

exportProcessID - the exportProcessID to set

isExportStatus

public boolean isExportStatus()

Specified by:

isExportStatus in interface IFdTransformBuilder

Returns:

boolean if the status name of form records should be exported

setExportStatus

public void setExportStatus(boolean exportStatus)

Specified by:

setExportStatus in interface IFdTransformBuilder

Parameters:

exportStatus - the exportStatus to set

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

setExportTechnicalFields

public void setExportTechnicalFields(boolean exportTechnicalFields)

Specified by:

setExportTechnicalFields in interface IFdTransformBuilder

Parameters:

exportTechnicalFields - the exportTechnicalFields to set

isExportVariables

public boolean isExportVariables()

Specified by:

isExportVariables in interface IFdTransformBuilder

Returns:

boolean if variables of form records should be exported

setExportVariables

public void setExportVariables(boolean exportVariables)

Specified by:

setExportVariables in interface IFdTransformBuilder

Parameters:

exportVariables - the exportVariables to set

isExportID

public boolean isExportID()

Specified by:

isExportID in interface IFdTransformBuilder

Returns:

the exportID

setExportID

public void setExportID(boolean exportID)

Specified by:

setExportID in interface IFdTransformBuilder

Parameters:

exportID - the exportID to set

isExportSubject

public boolean isExportSubject()

Specified by:

isExportSubject in interface IFdTransformBuilder

Returns:

the exportSubject

setExportSubject

public void setExportSubject(boolean exportSubject)

Specified by:

setExportSubject in interface IFdTransformBuilder

Parameters:

exportSubject - the exportSubject to set

isExportInbox

public boolean isExportInbox()

Specified by:

isExportInbox in interface IFdTransformBuilder

Returns:

the exportInbox

setExportInbox

public void setExportInbox(boolean exportInbox)

Specified by:

setExportInbox in interface IFdTransformBuilder

Parameters:

exportInbox - the exportInbox to set

isExportExportMetaData

public boolean isExportExportMetaData()

Specified by:

isExportExportMetaData in interface IFdTransformBuilder

Returns:

the exportExportMetaData

setExportExportMetaData

public void setExportExportMetaData(boolean exportExportMetadata)

Specified by:

setExportExportMetaData in interface IFdTransformBuilder

Parameters:

exportExportMetadata - the exportExportMetadata to set

getElementsList

public 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

getIdAttr

@NotNull
protected String getIdAttr()