Class AProjektUtil

java.lang.Object

de.xima.fc.export.AProjektUtil

Direct Known Subclasses:

ProjektCopyUtil, ProjektExportUtil, ProjektImportUtil, ProjektUpdateUtil

public class AProjektUtil
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final Mandant	client
protected final IEntityContext	ec
protected final List<FCMessage>	errorMsgList
protected static final String	FC_EXPORT_AKTIONEN
protected static final String	FC_EXPORT_AKTIVE_VERSION
protected static final String	FC_EXPORT_BEDINGUNG
protected static final String	FC_EXPORT_DOI
protected static final String	FC_EXPORT_DOI_DATA
protected static final String	FC_EXPORT_FORM_ELEMENTS
protected static final String	FC_EXPORT_FORM_RESSOURCES
protected static final String	FC_EXPORT_FORMVERSION
protected static final String	FC_EXPORT_FORMVERSION_DATA
protected static final String	FC_EXPORT_METADATA
protected static final String	FC_EXPORT_PROJEKT
protected static final String	FC_EXPORT_PROJEKTHELP
protected static final String	FC_EXPORT_RESOURCE
protected static final String	FC_EXPORT_STATUS
protected static final String	FC_EXPORT_STATUSHELP
protected static final String	FC_EXPORT_VORGAENGE
protected static final String	FC_EXPORT_VORGAENGE_DATA
protected final List<FCMessage>	infoMsgList
protected static final org.slf4j.Logger	LOG
protected final Mandant	m	Deprecated.

Constructor Summary

Constructors

Constructor	Description
AProjektUtil(Mandant man, IEntityContext ec)

Method Summary

Modifier and Type	Method	Description
protected void	addErrorMessage(String i18nKey, FCMessage.ParamsLocalizer params)
protected void	addErrorMessage(String i18nKey, Serializable... param)
protected void	addInfoMessage(String i18nKey, FCMessage.ParamsLocalizer params)
protected void	addInfoMessage(String i18nKey, Serializable... param)
protected void	addWarnMessage(String i18nKey, FCMessage.ParamsLocalizer params)
protected void	addWarnMessage(String i18nKey, Serializable... param)
protected void	checkClientResourceExists(ERessourcenTyp resourceType, String resourceName)	Checks whether the given resource exists for the action and issues and error message in case it does not.
static final boolean	checkProjectAliasExist(IEntityContext ec, String projectAlias, Mandant client)	Checks whether or not the given project name already exist within the given client
static final boolean	checkProjectNameExist(IEntityContext ec, String projectName, Mandant client)	Checks whether or not the given project name already exist within the given client
protected WorkflowVersion	cloneWorkflowVersion(WorkflowVersion oldVersion)	Creates a copy of the given workflow version.
protected FormVersion	createActiveFormVersion(FormVersion newFormVersion, Projekt neuesProjekt, String formDir, String fcVersion)	Erzeugt eine aktive FormVersion
protected Map<Long,Aktion>	createAktion(Map<Long,Status> mapStatus, boolean disableAllActions)	Deprecated.
protected void	createAktionen(List<Status> statusListe, List<ExportAktionData> exportAktionListe, List<ExportBedingungData> exportBedingungListe)	Deprecated.
protected void	createBedingung(Map<Long,Aktion> aktionMap, Map<Long,Status> statusMap)	Deprecated.
protected List<ExportBedingungData>	createBedingungenExportData(List<ExportBedingungData> exportBedingungListe, Projekt project)
protected void	createFile(String filePath, byte[] data)
protected void	createFormElements(List<FormElement> formElements, FormVersion formVersion)	Erzeugt ein FormElement
protected void	createFormVersionFile(FormVersion fv, String targetPath)
protected <T extends de.xima.cmn.dao.interfaces.IEntity<Long>> Map<Long,T>	createIDsMap(List<T> options)	Generiert aus einer Liste von IEntity-Objekten eine Map mit ID als Key
protected javax.xml.bind.JAXBContext	createJAXBContext(Class<?>[] classesToBeBound, List<String> bindings)
protected <T extends INameProviding> Map<String,T>	createNamedMap(List<T> options)	Generiert aus einer Liste von INameProviding-Objekten eine Map mit Name als Key
static final FormVersion	createNewFormVersion(IEntityContext ec, Projekt project, Benutzer user)	Deprecated. Use createNewFormVersion(IEntityContext, Projekt, IUser) instead.
static final FormVersion	createNewFormVersion(IEntityContext ec, Projekt project, IUser user)
static final FormVersion	createNewFormVersion(IEntityContext ec, Long projectId, Benutzer user)	Deprecated. Use createNewFormVersion(IEntityContext, Long, IUser) instead.
static final FormVersion	createNewFormVersion(IEntityContext ec, Long projectId, IUser user)
protected List<Status>	createPreStatus(HashMap<Long,Status> existierendeStatusListe, List<Status> altStatusListe)	Deprecated.
protected ProjektRessource	createProjektRessource(Projekt neuesProjekt, File file)
protected void	createProjektRessourcenFiles(Projekt projekt, String targetPath)
protected void	createProjektRessources(Projekt neuesProjekt, File resFile)
protected HashMap<Long,Status>	createStatus(List<? extends Status> altStatusListe, Projekt projekt)	Deprecated.
protected <T> T	deproxyEntity(T obj)
String	findUniqueAlias(String alias)	Attempt to find a unique alias (for the current client).
protected List<Aktion>	getAktionsListe(Status status)	Deprecated.
protected List<BenutzerGruppe>	getBenutzergruppen(List<BenutzerGruppe> bgl)	Methode zum Auslesen der Benutzergruppen
protected List<BenutzerGruppe>	getBenutzerGruppenListe(List<BenutzerGruppe> benutzerGruppen)	liest Benutzergruppen aus der DB
List<FCMessage>	getErrorMsgList()
protected List<FormElement>	getFormElements(FormVersion formVersion)	Methode zum Ermitteln der FormElements
protected List<String>	getFormVersionBindings()
protected com.google.gson.GsonBuilder	getGsonBuilderWithDefaults()	The defaults that are currently set are as follows: A custom type adapter for Date objects as the built-in one is not cross Java version compatible.
List<FCMessage>	getInfoMsgList()
protected Mandant	getMandant()
protected List<MandantFrontendServer>	getMandantFrontendServer(List<MandantFrontendServer> bgl)	Methode zum Auslesen der MandantFrontendServer
protected Projekt	getNewProjekt(Projekt newProject, Projekt sourceProjekt, String curBenutzer)	Erzeugt ein neues Projekt
protected Collection<ProjektRessource>	getProjektRessources(FormVersion formVersion)
protected List<Status>	getStatusListe(Projekt projekt)	Deprecated.
protected List<String>	getVorgangsBindings()
protected Aktion	handleAction(long oldActionId, Aktion newAction, Map<Long,Aktion> aktionMap, Map<Long,Status> statusMap, ExportBedingungData exportBedingungData)	Deprecated.
protected Bedingung	handleBedingungForImport(Bedingung neueBedingung, Map<Long,Aktion> aktionMap, Map<Long,Status> statusMap, ExportBedingungData exportBedingungData)	Deprecated.
protected void	importProjektRessources(Projekt neuesProjekt, String resDirname, String resFilename)
void	migrateLegacyFormTheme(FormVersion formVersion, com.alibaba.fastjson.JSONObject persistJson, String fcVersionOfForm)	Migrates the form theme to the new ClientFormTheme.
protected void	updatePreviewImage(Projekt newProject, Projekt sourceProject)
protected void	writeJSONtoFile(File tempDir, String filename, String content)

Methods inherited from class Object

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

Field Details

LOG

protected static final org.slf4j.Logger LOG

ec

protected final IEntityContext ec

client

protected final Mandant client

errorMsgList

protected final List<FCMessage> errorMsgList

infoMsgList

protected final List<FCMessage> infoMsgList

FC_EXPORT_PROJEKT

protected static final String FC_EXPORT_PROJEKT

See Also:

• Constant Field Values

FC_EXPORT_PROJEKTHELP

protected static final String FC_EXPORT_PROJEKTHELP

See Also:

• Constant Field Values

FC_EXPORT_AKTIVE_VERSION

protected static final String FC_EXPORT_AKTIVE_VERSION

See Also:

• Constant Field Values

FC_EXPORT_DOI

protected static final String FC_EXPORT_DOI

See Also:

• Constant Field Values

FC_EXPORT_DOI_DATA

protected static final String FC_EXPORT_DOI_DATA

See Also:

• Constant Field Values

FC_EXPORT_FORM_ELEMENTS

protected static final String FC_EXPORT_FORM_ELEMENTS

See Also:

• Constant Field Values

FC_EXPORT_STATUS

protected static final String FC_EXPORT_STATUS

See Also:

• Constant Field Values

FC_EXPORT_STATUSHELP

protected static final String FC_EXPORT_STATUSHELP

See Also:

• Constant Field Values

FC_EXPORT_AKTIONEN

protected static final String FC_EXPORT_AKTIONEN

See Also:

• Constant Field Values

FC_EXPORT_BEDINGUNG

protected static final String FC_EXPORT_BEDINGUNG

See Also:

• Constant Field Values

FC_EXPORT_FORMVERSION

protected static final String FC_EXPORT_FORMVERSION

See Also:

• Constant Field Values

FC_EXPORT_FORMVERSION_DATA

protected static final String FC_EXPORT_FORMVERSION_DATA

See Also:

• Constant Field Values

FC_EXPORT_FORM_RESSOURCES

protected static final String FC_EXPORT_FORM_RESSOURCES

See Also:

• Constant Field Values

FC_EXPORT_RESOURCE

protected static final String FC_EXPORT_RESOURCE

See Also:

• Constant Field Values

FC_EXPORT_VORGAENGE

protected static final String FC_EXPORT_VORGAENGE

See Also:

• Constant Field Values

FC_EXPORT_VORGAENGE_DATA

protected static final String FC_EXPORT_VORGAENGE_DATA

See Also:

• Constant Field Values

m

@Deprecated
protected final Mandant m

Deprecated.

FC_EXPORT_METADATA

protected static final String FC_EXPORT_METADATA

See Also:

• Constant Field Values

Constructor Details

AProjektUtil

public AProjektUtil(Mandant man,
 IEntityContext ec)

Method Details

addErrorMessage

protected void addErrorMessage(String i18nKey,
 Serializable... param)

addErrorMessage

protected void addErrorMessage(String i18nKey,
 FCMessage.ParamsLocalizer params)

addWarnMessage

protected void addWarnMessage(String i18nKey,
 Serializable... param)

addWarnMessage

protected void addWarnMessage(String i18nKey,
 FCMessage.ParamsLocalizer params)

getInfoMsgList

public List<FCMessage> getInfoMsgList()

createNewFormVersion

public static final FormVersion createNewFormVersion(IEntityContext ec,
 Long projectId,
 IUser user)

createNewFormVersion

public static final FormVersion createNewFormVersion(IEntityContext ec,
 Projekt project,
 IUser user)

createFile

protected void createFile(String filePath,
 byte[] data)
                   throws IOException

Throws:

IOException

addInfoMessage

protected void addInfoMessage(String i18nKey,
 Serializable... param)

addInfoMessage

protected void addInfoMessage(String i18nKey,
 FCMessage.ParamsLocalizer params)

getMandant

protected Mandant getMandant()

writeJSONtoFile

protected void writeJSONtoFile(File tempDir,
 String filename,
 String content)
                        throws IOException

Throws:

IOException

getFormElements

protected List<FormElement> getFormElements(FormVersion formVersion)

Methode zum Ermitteln der FormElements

findUniqueAlias

public String findUniqueAlias(String alias)
                       throws LimitExceededException

Attempt to find a unique alias (for the current client). If no project with the given alias exists, return that alias. Otherwise, attempt to suffix the given alias with an index.

Parameters:

alias - Desired base alias to be used.

Returns:

A (non-empty) alias that is not used yet by any project of the current client. An empty string iff no unique alias could be found.

Throws:

LimitExceededException - if the alias generation exceeded the length limit

checkProjectNameExist

public static final boolean checkProjectNameExist(IEntityContext ec,
 String projectName,
 Mandant client)

Checks whether or not the given project name already exist within the given client

Parameters:

ec - IEntityContext in which this action should be performed

projectName - String project name to check for

client - Mandant to check for

Returns:

true if name already exists

checkProjectAliasExist

public static final boolean checkProjectAliasExist(IEntityContext ec,
 String projectAlias,
 Mandant client)

Checks whether or not the given project name already exist within the given client

Parameters:

ec - IEntityContext in which this action should be performed

projectAlias - String project alias to check for

client - Mandant to check for

Returns:

true if alias already exists

checkClientResourceExists

protected void checkClientResourceExists(ERessourcenTyp resourceType,
 String resourceName)

Checks whether the given resource exists for the action and issues and error message in case it does not.

Parameters:

resourceType - Type of resource. No check is performed unless this is ERessourcenTyp.MANDANT.

resourceName - Name of the resource to check.

getStatusListe

@Deprecated
protected List<Status> getStatusListe(Projekt projekt)

Deprecated.

Methode zum Erzeugen der Status-Daten

getAktionsListe

@Deprecated
protected List<Aktion> getAktionsListe(Status status)

Deprecated.

Methode zum Erzeugen der Aktion-Daten

getErrorMsgList

public List<FCMessage> getErrorMsgList()

handleAction

@Deprecated
protected Aktion handleAction(long oldActionId,
 Aktion newAction,
 Map<Long,Aktion> aktionMap,
 Map<Long,Status> statusMap,
 ExportBedingungData exportBedingungData)
                       throws Exception

Deprecated.

Throws:

Exception

handleBedingungForImport

@Deprecated
protected Bedingung handleBedingungForImport(Bedingung neueBedingung,
 Map<Long,Aktion> aktionMap,
 Map<Long,Status> statusMap,
 ExportBedingungData exportBedingungData)
                                      throws Exception

Deprecated.

Should only be used for importing older project exports

Throws:

Exception

createBedingung

@Deprecated
protected void createBedingung(Map<Long,Aktion> aktionMap,
 Map<Long,Status> statusMap)
                        throws Exception

Deprecated.

Erstellt Bedingungen anahnd der AktionsListe

Throws:

Exception

createAktion

@Deprecated
protected Map<Long,Aktion> createAktion(Map<Long,Status> mapStatus,
 boolean disableAllActions)

Deprecated.

Erstellt Aktionen anhand der StatusListe

Parameters:

mapStatus - Mapping between the ID of a state and the corresponding entity.

disableAllActions - Flag das angibt, ob neue Aktionen deaktiviert werden sollen

Returns:

Map<Integer, Aktion> New mapping with the created actions.

updatePreviewImage

protected void updatePreviewImage(Projekt newProject,
 Projekt sourceProject)

getNewProjekt

protected Projekt getNewProjekt(Projekt newProject,
 Projekt sourceProjekt,
 String curBenutzer)

Erzeugt ein neues Projekt

cloneWorkflowVersion

protected WorkflowVersion cloneWorkflowVersion(WorkflowVersion oldVersion)

Creates a copy of the given workflow version.

Parameters:

oldVersion - An entity to clone.

Returns:

The cloned entity.

createActiveFormVersion

protected FormVersion createActiveFormVersion(FormVersion newFormVersion,
 Projekt neuesProjekt,
 String formDir,
 String fcVersion)
                                       throws IOException,
com.alibaba.fastjson.JSONException

Erzeugt eine aktive FormVersion

Throws:

IOException

com.alibaba.fastjson.JSONException

createFormElements

protected void createFormElements(List<FormElement> formElements,
 FormVersion formVersion)

Erzeugt ein FormElement

Parameters:

formElements - Elements to create.

formVersion - Form version where to create the elements.

getBenutzergruppen

protected List<BenutzerGruppe> getBenutzergruppen(List<BenutzerGruppe> bgl)

Methode zum Auslesen der Benutzergruppen

getMandantFrontendServer

protected List<MandantFrontendServer> getMandantFrontendServer(List<MandantFrontendServer> bgl)

Methode zum Auslesen der MandantFrontendServer

createStatus

@Deprecated
protected HashMap<Long,Status> createStatus(List<? extends Status> altStatusListe,
 Projekt projekt)

Deprecated.

Methode zum Erzeugen eines Status

getBenutzerGruppenListe

protected List<BenutzerGruppe> getBenutzerGruppenListe(List<BenutzerGruppe> benutzerGruppen)

liest Benutzergruppen aus der DB

createPreStatus

@Deprecated
protected List<Status> createPreStatus(HashMap<Long,Status> existierendeStatusListe,
 List<Status> altStatusListe)

Deprecated.

createBedingungenExportData

protected List<ExportBedingungData> createBedingungenExportData(List<ExportBedingungData> exportBedingungListe,
 Projekt project)

createProjektRessourcenFiles

protected void createProjektRessourcenFiles(Projekt projekt,
 String targetPath)
                                     throws IOException

Throws:

IOException

getProjektRessources

protected Collection<ProjektRessource> getProjektRessources(FormVersion formVersion)

createFormVersionFile

protected void createFormVersionFile(FormVersion fv,
 String targetPath)
                              throws IOException

Throws:

IOException

createAktionen

@Deprecated
protected void createAktionen(List<Status> statusListe,
 List<ExportAktionData> exportAktionListe,
 List<ExportBedingungData> exportBedingungListe)

Deprecated.

importProjektRessources

protected void importProjektRessources(Projekt neuesProjekt,
 String resDirname,
 String resFilename)
                                throws IOException

Throws:

IOException

createProjektRessources

protected void createProjektRessources(Projekt neuesProjekt,
 File resFile)
                                throws IOException

Throws:

IOException

createProjektRessource

protected ProjektRessource createProjektRessource(Projekt neuesProjekt,
 File file)
                                           throws IOException

Throws:

IOException

deproxyEntity

protected <T> T deproxyEntity(T obj)

getGsonBuilderWithDefaults

protected com.google.gson.GsonBuilder getGsonBuilderWithDefaults()

The defaults that are currently set are as follows:

• A custom type adapter for Date objects as the built-in one is not cross Java version compatible.

Returns:

A newly created GsonBuilder with some defaults already set.

createJAXBContext

protected javax.xml.bind.JAXBContext createJAXBContext(Class<?>[] classesToBeBound,
 List<String> bindings)
                                                throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

getVorgangsBindings

protected List<String> getVorgangsBindings()

getFormVersionBindings

protected List<String> getFormVersionBindings()

createNamedMap

protected <T extends INameProviding> Map<String,T> createNamedMap(List<T> options)

Generiert aus einer Liste von INameProviding-Objekten eine Map mit Name als Key

createIDsMap

protected <T extends de.xima.cmn.dao.interfaces.IEntity<Long>>
Map<Long,T> createIDsMap(List<T> options)

Generiert aus einer Liste von IEntity-Objekten eine Map mit ID als Key

migrateLegacyFormTheme

public void migrateLegacyFormTheme(FormVersion formVersion,
 com.alibaba.fastjson.JSONObject persistJson,
 String fcVersionOfForm)

Migrates the form theme to the new ClientFormTheme. Tries to find a matching ClientFormTheme from the data in the given form version. If none can be found, defaults to the system classic or modern theme (depending on whether the modern flag is set). Then set the form theme to that theme, and removes the old theme properties from the form version and persist JSON.

Parameters:

formVersion - The form version to migrate the theme for.

persistJson - The persist JSON of the form version.

fcVersionOfForm - The current formcycle version in which the form is on.

createNewFormVersion

@Deprecated
public static final FormVersion createNewFormVersion(IEntityContext ec,
 Long projectId,
 Benutzer user)

Deprecated.

Use createNewFormVersion(IEntityContext, Long, IUser) instead.

createNewFormVersion

@Deprecated
public static final FormVersion createNewFormVersion(IEntityContext ec,
 Projekt project,
 Benutzer user)

Deprecated.

Use createNewFormVersion(IEntityContext, Projekt, IUser) instead.