de.xima.fc.transform.xml

Class FdToXmlBuilder

java.lang.Object

de.xima.fc.transform.AFdTransformBuilder

de.xima.fc.transform.xml.FdToXmlBuilder

All Implemented Interfaces:

IFdTransformBuilder

public class FdToXmlBuilder
extends AFdTransformBuilder
implements IFdTransformBuilder

Builder for transforming form-data into XML

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
FdToXmlBuilder()

Method Summary

Modifier and Type	Method and Description
FdToXmlResult	buildForInbox(UserContext uc, Benutzer user, de.xima.cmn.criteria.QueryCriteriaManager qcm) Builds the XML export of Vorgang´s determined with an QueryCriteriaManager
FdToXmlResult	buildForProcess(UserContext uc, Vorgang formRecord, IFormDataAdapter fda, IXForm xform) Builds the XML export of an single form record
FdToXmlResult	buildForProcessIDs(UserContext uc, Benutzer user, List<Long> processIDs) Builds the XML export of an List of Vorgang.getId()´s
FdToXmlResult	buildForProjectInbox(UserContext uc, List<ExtendedEntityModel<Vorgang>> records) Builds the XML export of an List of ExtendedEntityModel´s of Vorgang´s
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.
FdToXmlBuilder	withCreationDate(boolean withCreationDate)
FdToXmlBuilder	withExportMetaData(boolean withExportMetaData)
FdToXmlBuilder	withModificationDate(boolean withModificationDate)
FdToXmlBuilder	withProcessID(boolean withProcessID)
FdToXmlBuilder	withStatus(boolean withStatus)
FdToXmlBuilder	withTechnicalFields(boolean withTechnicalFields)
FdToXmlBuilder	withVariables(boolean withVariables)

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

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

FdToXmlBuilder

public FdToXmlBuilder()

Method Detail

withCreationDate

public FdToXmlBuilder 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 FdToXmlBuilder 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 FdToXmlBuilder 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 FdToXmlBuilder 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 FdToXmlBuilder 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 FdToXmlBuilder 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 FdToXmlBuilder 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

buildForProcess

public FdToXmlResult buildForProcess(UserContext uc,
                                     Vorgang formRecord,
                                     IFormDataAdapter fda,
                                     IXForm xform)

Builds the XML export of an single form record

Parameters:

uc - the UserContext to user for the export

formRecord - the Vorgang to export

fda - the IFormDataAdapter to use as the data for the export

xform - the IXForm to use for the export

Returns:

the FdToXmlResult

buildForProcessIDs

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

Builds the XML export of 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 FdToXmlResult

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

buildForInbox

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

Builds the XML 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 FdToXmlResult

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 FdToXmlResult buildForProjectInbox(UserContext uc,
                                          List<ExtendedEntityModel<Vorgang>> records)
                                   throws com.alibaba.fastjson.JSONException,
                                          IOException

Builds the XML export of an List of ExtendedEntityModel´s of Vorgang´s

Parameters:

uc - the UserContext to user for the export

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

Returns:

the FdToXmlResult

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

getElementsList

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

Description copied from class: AFdTransformBuilder

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.

Overrides:

getElementsList in class AFdTransformBuilder

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