de.xima.fc.transform.xml

Class FDToXmlTransformer

java.lang.Object

de.xima.fc.transform.xml.FDToXmlTransformer

public class FDToXmlTransformer
extends Object

Factory mit welcher ein XForm in ein IRootFdXml umgewandelt und in eine Datei serialisiert werden kann. Das XForm kann hierbei aus verschiedenen Quellen gespeist werden, zum Beispiel einen Formular direkt, Postfachvorgängen oder Projektpostfachvorgängen.

Author:

xima media GmbH, Dresden - mgu - 17.09.2014

Constructor Summary

Constructors

Constructor and Description
FDToXmlTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
static RootFdXml	createForPostfach(UserContext uc, List<String> vl, XfcSession sess, de.xima.cmn.criteria.QueryCriteriaManager qm, Benutzer ben) Methode zum Erzeugen einer XML-Objektstruktur mit Werten von Postfachvorgängen.
static RootFdXml	createForProjektPostfach(List<ExtendedEntityModel<Vorgang>> vorgaenge, XfcSession sess) Methode zum Erzeugen einer XML-Objektstruktur mit Werten von Projektpostfachvorgängen.
static RootFdXml	createForSingleVorgang(Map<String,List<String[]>> dataMap, Vorgang vorgang, IXForm xform) Methode zum Erzeugen einer XML-Objektstruktur mit Werten eines Vorgangs.Da Container-Elemente keine Werte beinhalten, werden diese bei der Abarbeitung nicht beachtet.
static ProcessFdXml	createProcess(Vorgang vorgang) Befüllen der ProcessFdXml mit Daten aus einem Vorgang-Objekt.
static void	fillFieldsList(Map<String,List<String[]>> dataMap, IXForm xform, ArrayList<FieldFdXml> fields, FormVersion fv, boolean skipNotExistingValues) Füllen einer übergebenen ArrayList mit FieldFdXml-Objekten auf Basis von Formularwerten.
static void	fillFormRoot(RootFdXml formRoot)
static void	writeHTMLFile(RootFdXml formRoot, File outputFile) Schreibt ein XML-Objekt in eine Datei wobei ggf. die Datei erzeugt wird.
static void	writeXMLFile(RootFdXml formRoot, File outputFile) Schreibt ein XML-Objekt in eine Datei wobei ggf. die Datei erzeugt wird.

Methods inherited from class java.lang.Object

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

Constructor Detail

FDToXmlTransformer

public FDToXmlTransformer()

Method Detail

createForSingleVorgang

public static RootFdXml createForSingleVorgang(Map<String,List<String[]>> dataMap,
                               Vorgang vorgang,
                               IXForm xform)
                                        throws IOException,
                                               org.json.JSONException

Methode zum Erzeugen einer XML-Objektstruktur mit Werten eines Vorgangs.Da Container-Elemente keine Werte beinhalten, werden diese bei der Abarbeitung nicht beachtet.

Parameters:

xform - das mit Daten gefüllte Formular

formRoot - das XML-Wurzelelement, welches mit den Daten angereichert werden soll.

formVersion -

Throws:

org.json.JSONException

IOException

createForPostfach

public static RootFdXml createForPostfach(UserContext uc,
                          List<String> vl,
                          XfcSession sess,
                          de.xima.cmn.criteria.QueryCriteriaManager qm,
                          Benutzer ben)
                                   throws IOException,
                                          org.json.JSONException

Methode zum Erzeugen einer XML-Objektstruktur mit Werten von Postfachvorgängen. Das auszuwertende Postfach muss diese Methode übergeben werden, sowie ein UserContext um alle Vorgänge des Postfachs ermitteln zu können. Aus den Vorgängen werden die Formularwerte ermittelt, welche in die XML geschrieben werden. Es wird ein konkretes RootFdXml erzeugt, da hierbei die Felder in einen Process-Tag gekapselt werden.

Parameters:

uc - UserContext zum Öffnen eines EntityContext mittels welchem die Vorgänge ermittelt werden

postfach - das Postfach, welches serialisiert werden soll

Returns:

RootFdXml mit der gefüllten RootFdXml.getProcesses() Liste

Throws:

IOException - Fehler beim Lesen der Formulardatei

org.json.JSONException - Fehler beim Umwandel der Formulardatei in ein JSON-Objekt

createForProjektPostfach

public static RootFdXml createForProjektPostfach(List<ExtendedEntityModel<Vorgang>> vorgaenge,
                                 XfcSession sess)
                                          throws IOException,
                                                 org.json.JSONException

Methode zum Erzeugen einer XML-Objektstruktur mit Werten von Projektpostfachvorgängen. Die auszuwertenden erweiterten Vorgänge werden der Methode übergeben. Aus den erweiterten Vorgängen werden die Formularwerte ermittelt, welche in die XML geschrieben werden. Es wird ein konkretes RootFdXml erzeugt, da hierbei die Felder in einen Process-Tag gekapselt werden. Enthalten Formularelemente keine Werte in dem erweiterten Vorgangsdaten, so werden diese Felder nicht mit in die XML aufgenommen.

Parameters:

vorgaenge - Die erweiterten Vorgänge dessen Werte XML-Serialisiert werden sollen

Throws:

IOException - Fehler beim Lesen der Formulardatei

org.json.JSONException - Fehler beim Umwandel der Formulardatei in ein JSON-Objekt

createProcess

public static ProcessFdXml createProcess(Vorgang vorgang)

Befüllen der ProcessFdXml mit Daten aus einem Vorgang-Objekt. Ist kein Vorgang gegeben, so eine leere Instanz von ProcessFdXml zurückgegeben.

Parameters:

vorgang - dessen Inhalt in das ProcessFdXml übertragen wird.

Returns:

ProcessFdXml entweder leer oder mit den entsprechenden Werten aus dem Vorgang befüllt.

fillFormRoot

public static void fillFormRoot(RootFdXml formRoot)

fillFieldsList

public static void fillFieldsList(Map<String,List<String[]>> dataMap,
                  IXForm xform,
                  ArrayList<FieldFdXml> fields,
                  FormVersion fv,
                  boolean skipNotExistingValues)

Füllen einer übergebenen ArrayList mit FieldFdXml-Objekten auf Basis von Formularwerten.

Parameters:

xform - das Formular dessen Felder ausgewertet werden

fields - die Liste, die mit den FieldFdXml-Objekten befüllt wird

skipNotExistingValues - ist in der XForm.getValuesMap() kein Eintrag für ein Formularfeld vorhanden, so wird kein FieldFdXml der Liste hinzugefügt

fv -

writeXMLFile

public static void writeXMLFile(RootFdXml formRoot,
                File outputFile)
                         throws Exception

Schreibt ein XML-Objekt in eine Datei wobei ggf. die Datei erzeugt wird.

Parameters:

formRoot - das XML-Objekt welches serialisiert werden soll

outputFile - die Datei in welche das XML geschrieben wird.

Throws:

Exception - Fehler beim serialisieren der Datei

writeHTMLFile

public static void writeHTMLFile(RootFdXml formRoot,
                 File outputFile)
                          throws Exception

Schreibt ein XML-Objekt in eine Datei wobei ggf. die Datei erzeugt wird. Hierbei wird das XML-Objet in HTML transformiert

Parameters:

formRoot - das XML-Objekt welches serialisiert werden soll

outputFile - die Datei in welche das XML geschrieben wird.

Throws:

Exception - Fehler beim serialisieren der Datei