org.yawlfoundation.yawl.resourcing.codelets

Class AbstractCodelet

java.lang.Object

org.yawlfoundation.yawl.resourcing.codelets.AbstractCodelet

Direct Known Subclasses:

ExampleCodelet, ItemMetaData, RandomWait, ShellExecution, SupervisorInfo, TaskCompleterInfo, XQueryEvaluator

public abstract class AbstractCodelet
extends java.lang.Object

The base class of all codelets.

Author:

Michael Adams

Created/Last Date:

17/06/2008

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_description
protected static java.lang.String	XSD_NAMESPACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCodelet()
protected	AbstractCodelet(java.lang.String desc)

Method Summary

Modifier and Type	Method and Description
void	cancel() This method is called when the work item running this codelet is cancelled.
abstract Element	execute(Element inData, java.util.List<YParameter> inParams, java.util.List<YParameter> outParams) This method must be implemented to do the work of the codelet.
java.lang.String	getCanonicalClassName()
java.lang.String	getClassName()
java.lang.String	getDescription()
protected YParameter	getInputParameter(java.lang.String paramName)
protected Element	getOutputData()
protected YParameter	getOutputParameter(java.lang.String paramName)
protected java.lang.Object	getParameterValue(java.lang.String varName) Converts the string representation of a parameter value to its specified data type, for the most frequent data types.
boolean	getPersist()
java.util.List<YParameter>	getRequiredParams() This method is called when an external entity (such as the YAWL editor) requests the list of parameters required by the codelet.
java.lang.String	getRequiredParamsToXML()
protected java.lang.String	getValue(java.lang.String varName) Gets the value of a parameter
WorkItemRecord	getWorkItem()
void	init() This method is called when a codelet first starts.
void	resume() This method is called when the codelet is resumed after a server shutdown.
void	setDescription(java.lang.String desc)
protected void	setInputs(Element inData, java.util.List<YParameter> inParams, java.util.List<YParameter> outParams)
protected void	setParameterValue(java.lang.String varName, java.lang.String value) Adds a new value to an output parameter, and creates the parameter if it doesn't already exist
protected void	setPersist(boolean persist)
void	setWorkItem(WorkItemRecord wir)
void	shutdown() This method is called when the server is shutting down.
java.lang.String	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

_description

protected java.lang.String _description

XSD_NAMESPACE

protected static final java.lang.String XSD_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

AbstractCodelet

protected AbstractCodelet()

AbstractCodelet

protected AbstractCodelet(java.lang.String desc)

Method Detail

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String desc)

getWorkItem

public WorkItemRecord getWorkItem()

setWorkItem

public void setWorkItem(WorkItemRecord wir)

getPersist

public boolean getPersist()

setPersist

protected void setPersist(boolean persist)

setInputs

protected void setInputs(Element inData,
                         java.util.List<YParameter> inParams,
                         java.util.List<YParameter> outParams)

getParameterValue

protected java.lang.Object getParameterValue(java.lang.String varName)
                                      throws CodeletExecutionException

Converts the string representation of a parameter value to its specified data type, for the most frequent data types. Implementers may override this method to handle other data types if required.

Parameters:

varName - the name of the parameter

Returns:

the appropriately typed value

Throws:

CodeletExecutionException - if the string value can't be converted to the specified type.

setParameterValue

protected void setParameterValue(java.lang.String varName,
                                 java.lang.String value)

Adds a new value to an output parameter, and creates the parameter if it doesn't already exist

Parameters:

varName - the name of the parameter

value - the value to assign to it

getOutputData

protected Element getOutputData()

getInputParameter

protected YParameter getInputParameter(java.lang.String paramName)
                                throws CodeletExecutionException

Throws:

CodeletExecutionException

getOutputParameter

protected YParameter getOutputParameter(java.lang.String paramName)
                                 throws CodeletExecutionException

Throws:

CodeletExecutionException

getValue

protected java.lang.String getValue(java.lang.String varName)
                             throws CodeletExecutionException

Gets the value of a parameter

Parameters:

varName - the name of the parameter

Returns:

its value

Throws:

CodeletExecutionException - if the parameter doesn't exist in the input data

getClassName

public java.lang.String getClassName()

getCanonicalClassName

public java.lang.String getCanonicalClassName()

toXML

public java.lang.String toXML()

getRequiredParamsToXML

public java.lang.String getRequiredParamsToXML()

init

public void init()

This method is called when a codelet first starts. Override to include any initialisations required.

shutdown

public void shutdown()

This method is called when the server is shutting down. Override to include any state saving required.

resume

public void resume()

This method is called when the codelet is resumed after a server shutdown. Override to include any state restoring required.

cancel

public void cancel()

This method is called when the work item running this codelet is cancelled. Override to cancel the codelet as required.

getRequiredParams

public java.util.List<YParameter> getRequiredParams()

This method is called when an external entity (such as the YAWL editor) requests the list of parameters required by the codelet. Override to populate the list. Each parameter should include a name, data type and description as a minimum.

Returns:

the List of parameters required by the codelet.

execute

public abstract Element execute(Element inData,
                                java.util.List<YParameter> inParams,
                                java.util.List<YParameter> outParams)
                         throws CodeletExecutionException

This method must be implemented to do the work of the codelet.

Parameters:

inData - the work item's input data

inParams - the work item's input parameters

outParams - the work item's output parameters

Returns:

a JDOM Element containing the output data generated by this method

Throws:

CodeletExecutionException - if there's any problem getting the required input data, composing the required output data, or performing the execution.