de.xima.fc.bl.fdv

Class WorkflowProcessingContext

java.lang.Object

de.xima.fc.bl.fdv.WorkflowProcessingContext

All Implemented Interfaces:

IWorkflowProcessingContext

public class WorkflowProcessingContext
extends Object
implements IWorkflowProcessingContext

Diese Klasse bildet einen Container, um Objekte, die bei der Verarbeitung einer Aktion erzeugt wurden, einer anderen Aktion zur Verfügung zu stellen, wobei diese beiden Aktionen innerhalb einer Verarbeitung (eines Statuswechsels) sein müssen. Alle Ergebnisse einer Aktion werden als Key-Value-Paare in einer Map abgelegt. Diese Map befindet sich wiederum in einer Map, welche die Zuordnung der Aktion, welche die Ergebnismenge erzeugt hat, abbildet. Das Ablegen von Ergebnismengen sieht also wie folgt aus:

 

 
AktionsId=1
 

 
"key1":"value1"
 
"key2":"value2"
 
"key3":"value3"
 
 
AktionsId=2
 

 
"key1":"value1"
 
"key2":"value2"
 
"key3":"value3"
 
 
 Die Keys sind Zeichenkettenwerte und die Values vom Typ Object. Beim Auslesen könnte ein Type-Cast
 notwendig werden. Zum Ermitteln eines Wertes muss folgende Objekt-Kette ausgebaut werden:
 

 WorkflowProcessingContextManager --(Vorgang.getProzessId())--> WorkflowProcessingContext --(
 Aktion.getId())--> Aktionsergebnisobjekt(Key:Value)
 
 

Author:

Xima Media GmbH, Dresden - 20.06.2011 - mgu

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG Beinhaltet die Zuordnung zwischen Aktion und Aktionsergebnisobjekten Die Aktionsergebnisobjekte sind Key-Value-Paare, die in Form einer Map in einer dieser Map abgelegt werden und anhand der AktionsId zugreifbar sind.

Constructor Summary

Constructors

Constructor and Description
WorkflowProcessingContext(Vorgang vorgang, IWorkflowProcessing processing, IXForm xForm, IXFormRenderConfig xformConfig, IFormDataAdapter formDataAdapter, IEntityContext entityContext, Map<String,Serializable> sessionAttributes)

Method Summary

Modifier and Type	Method and Description
void	addProcessingResult(Integer aktionsId, IProcessingResult value) neues Aktionsergebnisobjekt hinzuzufügen
HashMap<Integer,IProcessingResult>	getAktionsErgebnisse()
IEntityContext	getEntityContext()
IFormDataAdapter	getFormDataAdapter()
IWorkflowProcessing	getProcessing()
Map<String,Serializable>	getSessionAttributeMap()
SessionAttributes	getSessionAttributes() Deprecated.
File	getSourceDir(Aktion aktion) Verzeichnis in dem die Dateien abgelegt werden können, welche für die Verarbeitung in dieser Aktion erzeugt werden.
String	getSourceDirPath(Aktion aktion) Pfad zum temporären Ressourcen-Verzeichnis.
<E extends IAbstractDateiData> File	getSourceFile(Aktion aktion, IFileProviding<E> file) Methode zum Ermitteln und temporären Ablegen von Dateien aus der Datenbank.
File	getTargetDir(Aktion aktion) Verzeichnis in dem die Dateien abgelegt werden können, welche in dieser Aktion erzeugt werden.
String	getTargetDirPath(Aktion aktion) Pfad zum temporären Ziel-Verzeichnis.
String	getTempDirPath(Aktion aktion) Deprecated. use getTargetDirPath(Aktion)
Vorgang	getVorgang()
IXForm	getXForm()
IXFormRenderConfig	getXFormRenderConfig()
boolean	hasKey(int aktionsId) ermitteln, ob ein Eintrag zu einer Aktions-ID vorhanden ist
IProcessingResult	instanceFor(int aktionsId) spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln
void	setAktionsErgebnisse(HashMap<Integer,IProcessingResult> aktionsErgebnisse)
void	setEntityContext(IEntityContext entityContext)
void	setFormDataAdapter(IFormDataAdapter formDataAdapter)
void	setSessionAttributes(Map<String,Serializable> sessionAttributes)
void	setSessionAttributes(SessionAttributes sessionAttributes) Deprecated.
void	setVorgang(Vorgang vorgang)
void	setxForm(IXForm xForm) Deprecated. use setXForm(IXForm)
void	setXForm(IXForm xForm)
void	shutdown() alle geöffneten Referenzen des Kontexts schließen und temporär angelegte Dateien löschen (sollte erst passieren, wenn der Statuswechsel vollzogen ist und kein Kontext mehr benötigt wird)
IProcessingResult	valueFor(int aktionsId) spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln
String	valueFor(int aktionId, EProcessingResult eProcessingResult, int index, String key)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Beinhaltet die Zuordnung zwischen Aktion und Aktionsergebnisobjekten Die Aktionsergebnisobjekte sind Key-Value-Paare, die in Form einer Map in einer dieser Map abgelegt werden und anhand der AktionsId zugreifbar sind.

Constructor Detail

WorkflowProcessingContext

public WorkflowProcessingContext(Vorgang vorgang,
                                 IWorkflowProcessing processing,
                                 IXForm xForm,
                                 IXFormRenderConfig xformConfig,
                                 IFormDataAdapter formDataAdapter,
                                 IEntityContext entityContext,
                                 Map<String,Serializable> sessionAttributes)

Parameters:

vorgang - - der Vorgang für diesen Kontext

xformConfig -

Method Detail

addProcessingResult

public void addProcessingResult(Integer aktionsId,
                                IProcessingResult value)

neues Aktionsergebnisobjekt hinzuzufügen

Specified by:

addProcessingResult in interface IWorkflowProcessingContext

Parameters:

aktionsId - - Id der Aktion zu welcher die Aktionsergebnisobjekte zugeordnet werden

key - - Key unter welchem das Aktionsergebnisobjekt zugreifbar sein soll

value - - Value das eigentliche Aktionsergebnisobjekt das abgelegt werden soll

instanceFor

public IProcessingResult instanceFor(int aktionsId)

spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln

Parameters:

aktionsId - - die Id der Aktion für die die Ergebnismenge ermittelt werden soll.

key - - die Zeichenkette, die den Key darstellt für welchen das Aktionsergebnisobjekt ermittelt werden soll.

Returns:

Objekt, welches das Aktionsergebnis darstellt

valueFor

public IProcessingResult valueFor(int aktionsId)

Description copied from interface: IWorkflowProcessingContext

spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln

Specified by:

valueFor in interface IWorkflowProcessingContext

Parameters:

aktionsId - - die Id der Aktion für die die Ergebnismenge ermittelt werden soll.

Returns:

Objekt, welches das Aktionsergebnis darstellt

getTempDirPath

@Deprecated
public String getTempDirPath(Aktion aktion)
                                  throws IOException

Deprecated. use getTargetDirPath(Aktion)

Specified by:

getTempDirPath in interface IWorkflowProcessingContext

Throws:

IOException

getTargetDirPath

public String getTargetDirPath(Aktion aktion)
                        throws IOException

Description copied from interface: IWorkflowProcessingContext

Pfad zum temporären Ziel-Verzeichnis. @see IWorkflowProcessingContext.getTargetDir(Aktion)

Specified by:

getTargetDirPath in interface IWorkflowProcessingContext

Parameters:

aktion - Aktion für die dieser Pfad ermittelt werden soll

Returns:

String Pfad auf das temporäre Ziel-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getTargetDir

public File getTargetDir(Aktion aktion)
                  throws IOException

Description copied from interface: IWorkflowProcessingContext

Verzeichnis in dem die Dateien abgelegt werden können, welche in dieser Aktion erzeugt werden. Beim Schließen des Kontextes wird diese Verzeichnis gelöscht

Specified by:

getTargetDir in interface IWorkflowProcessingContext

Parameters:

aktion - Aktion für die dieses Verzeichnis ermittelt werden soll

Returns:

File das temporäre Ziel-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getSourceDir

public File getSourceDir(Aktion aktion)
                  throws IOException

Description copied from interface: IWorkflowProcessingContext

Verzeichnis in dem die Dateien abgelegt werden können, welche für die Verarbeitung in dieser Aktion erzeugt werden. Beim Schließen des Kontextes wird dieses Verzeichnis gelöscht

Specified by:

getSourceDir in interface IWorkflowProcessingContext

Parameters:

aktion - Aktion für die dieses Verzeichnis ermittelt werden soll

Returns:

File das temporäre Ressourcen-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getSourceDirPath

public String getSourceDirPath(Aktion aktion)
                        throws IOException

Description copied from interface: IWorkflowProcessingContext

Pfad zum temporären Ressourcen-Verzeichnis. @see IWorkflowProcessingContext.getSourceDir(Aktion)

Specified by:

getSourceDirPath in interface IWorkflowProcessingContext

Parameters:

aktion - Aktion für die dieser Pfad ermittelt werden soll

Returns:

String Pfad auf das temporäre Ressourcen-Verzeichnis

Throws:

IOException - wenn Fehler beim Anlegen dieses Verzeichnisses auftreten

getSourceFile

public <E extends IAbstractDateiData> File getSourceFile(Aktion aktion,
                                                         IFileProviding<E> file)
                                                  throws IOException

Description copied from interface: IWorkflowProcessingContext

Methode zum Ermitteln und temporären Ablegen von Dateien aus der Datenbank. Diese werden in das Verzeichnis IWorkflowProcessingContext.getSourceDir(Aktion) abgelegt und werden entsprechend beim Schließen des Kontextes mit gelöscht.

Specified by:

getSourceFile in interface IWorkflowProcessingContext

Parameters:

aktion - Aktion die Aktion in welcher die Datei zur Verfügung gestellt werden soll

file - IFileProviding Die Entität dessen Datei ausgelesen werden soll

Returns:

File die temporär abgelegte Datei

Throws:

IOException - wenn Fehler beim Anlegen der Datei auftreten

shutdown

public void shutdown()
              throws IOException

alle geöffneten Referenzen des Kontexts schließen und temporär angelegte Dateien löschen (sollte erst passieren, wenn der Statuswechsel vollzogen ist und kein Kontext mehr benötigt wird)

Specified by:

shutdown in interface IWorkflowProcessingContext

Throws:

IOException - - wenn ein Fehler beim Löschen des temporären Verzeichnisses auftritt

hasKey

public boolean hasKey(int aktionsId)

ermitteln, ob ein Eintrag zu einer Aktions-ID vorhanden ist

Specified by:

hasKey in interface IWorkflowProcessingContext

Parameters:

aktionsId - - ID der Aktion, deren Existenz geprüft werden soll

Returns:

true wenn element vorhanden, ansonsten false

valueFor

public String valueFor(int aktionId,
                       EProcessingResult eProcessingResult,
                       int index,
                       String key)

Specified by:

valueFor in interface IWorkflowProcessingContext

getXForm

public IXForm getXForm()

Specified by:

getXForm in interface IWorkflowProcessingContext

getXFormRenderConfig

public IXFormRenderConfig getXFormRenderConfig()

Specified by:

getXFormRenderConfig in interface IWorkflowProcessingContext

getVorgang

public Vorgang getVorgang()

Specified by:

getVorgang in interface IWorkflowProcessingContext

setVorgang

public void setVorgang(Vorgang vorgang)

Specified by:

setVorgang in interface IWorkflowProcessingContext

getFormDataAdapter

public IFormDataAdapter getFormDataAdapter()

Specified by:

getFormDataAdapter in interface IWorkflowProcessingContext

getEntityContext

public IEntityContext getEntityContext()

Specified by:

getEntityContext in interface IWorkflowProcessingContext

getAktionsErgebnisse

public HashMap<Integer,IProcessingResult> getAktionsErgebnisse()

setAktionsErgebnisse

public void setAktionsErgebnisse(HashMap<Integer,IProcessingResult> aktionsErgebnisse)

setXForm

public void setXForm(IXForm xForm)

setFormDataAdapter

public void setFormDataAdapter(IFormDataAdapter formDataAdapter)

setEntityContext

public void setEntityContext(IEntityContext entityContext)

getProcessing

public IWorkflowProcessing getProcessing()

Specified by:

getProcessing in interface IWorkflowProcessingContext

getSessionAttributeMap

public Map<String,Serializable> getSessionAttributeMap()

Specified by:

getSessionAttributeMap in interface IWorkflowProcessingContext

setSessionAttributes

public void setSessionAttributes(Map<String,Serializable> sessionAttributes)

setSessionAttributes

@Deprecated
public void setSessionAttributes(SessionAttributes sessionAttributes)

Deprecated.

getSessionAttributes

@Deprecated
public SessionAttributes getSessionAttributes()

Deprecated.

Specified by:

getSessionAttributes in interface IWorkflowProcessingContext

setxForm

@Deprecated
public void setxForm(IXForm xForm)

Deprecated. use setXForm(IXForm)