ever.workflowRepresentation

Class Workflow

java.lang.Object

ever.workflowRepresentation.Workflow

All Implemented Interfaces:

java.io.Serializable

public class Workflow
extends java.lang.Object
implements java.io.Serializable

This class is the root for workflow. It contains a Sequence which is the main sequence of the workflow. When an serialization to XML is necessary, the exportToWfTree Method has to be called.

Author:

schumacher

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<Product>	all It contains the list of the resources of the resource list in the original process description.
static java.lang.String	base

Constructor Summary

Constructors

Constructor and Description
Workflow() Standard workflow constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addProduct(Product p) Is used to add an ingredient aka.
boolean	equals(java.lang.Object obj)
java.lang.String	exportWfToTree() This method serializes the workflow to xml and returns it as String.
void	exportWfToTree(java.lang.String location) This method serializes the workflow to xml and writes out to a file.
Sequence	getTopSequence() Get the root sequence of a workflow.
int	hashCode()
void	moveFromThreadLocalAllProducts() This method copies product data from the ThreadLocal to this workflow and resets the ThreadLocal Data.
void	moveFromThreadLocalLastId() This method copies the last id used data from the ThreadLocal to this workflow and resets the ThreadLocal Data.
void	moveToThreadLocalAllProducts() Takes the data which is in workflow scoope and copies it to the ThreadLocal element.
void	moveToThreadLocalLastId() Takes the data which is in workflow scoope and copies it to the ThreadLocal element.
void	setTopLevel(Sequence seq) Sets a new root sequence.
void	setTopSequence(Sequence seq) Sets the root sequence of the workflow.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

all

public java.util.ArrayList<Product> all

It contains the list of the resources of the resource list in the original process description. In a cooking domain this would be the ingredient list. Conceptional this fields belong to the product. It is used e.g. to test if an extracted product is in the resource list or not. Usually this would be done with a static field, which can not be used because of multithreading. See ThreadLocal concept for more information.

base

public static final java.lang.String base

See Also:

Constant Field Values

Constructor Detail

Workflow

public Workflow()

Standard workflow constructor

Method Detail

setTopLevel

public void setTopLevel(Sequence seq)

Sets a new root sequence.

Parameters:

seq - The Sequence which is set as new root sequence

exportWfToTree

public void exportWfToTree(java.lang.String location)

This method serializes the workflow to xml and writes out to a file. The Cake dataformat is used.

Parameters:

location - path to output location

exportWfToTree

public java.lang.String exportWfToTree()

This method serializes the workflow to xml and returns it as String. The Cake dataformat is used.

Returns:

The workflow in an xml string

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getTopSequence

public Sequence getTopSequence()

Get the root sequence of a workflow.

Returns:

root sequence

setTopSequence

public void setTopSequence(Sequence seq)

Sets the root sequence of the workflow.

Parameters:

seq -

addProduct

public void addProduct(Product p)

Is used to add an ingredient aka. a product which was listed in the ressource list of a process description.

Parameters:

p -

moveFromThreadLocalAllProducts

public void moveFromThreadLocalAllProducts()

This method copies product data from the ThreadLocal to this workflow and resets the ThreadLocal Data. The ThreadLocal concept allows a static-like behavior in a multithreaded environment.

moveToThreadLocalAllProducts

public void moveToThreadLocalAllProducts()

Takes the data which is in workflow scoope and copies it to the ThreadLocal element. The ThreadLocal concept allows a static-like behavior in a multithreaded environment.

moveFromThreadLocalLastId

public void moveFromThreadLocalLastId()

This method copies the last id used data from the ThreadLocal to this workflow and resets the ThreadLocal Data. The ThreadLocal concept allows a static-like behavior in a multithreaded environment.

moveToThreadLocalLastId

public void moveToThreadLocalLastId()

Takes the data which is in workflow scoope and copies it to the ThreadLocal element. The ThreadLocal concept allows a static-like behavior in a multithreaded environment.