com.sap.aii.af.lib.mp.module

Class ModuleData

java.lang.Object
  com.sap.aii.af.lib.mp.module.ModuleData

All Implemented Interfaces:

Serializable

public class ModuleData
extends Object
implements Serializable

ModuleDate is the container which carries the module input data and module output data. It distinguishes between PrincipalData that should contain the message and SupplementalData that carries add-on values which represent e.g. intermediate results to be exchanged between modules.

See Also:

Serialized Form

Field Summary

protected Vector	moduleLogs
protected Object	principalData
protected Hashtable	supplementalDataTable

Constructor Summary

ModuleData()

Method Summary

String	contentToString() String serialization for logging purposes.
Object	getPrincipalData() Retrieves the current principle data, usually the message
Object	getSupplementalData(String name) Gets one supplement data value.
Enumeration	getSupplementalDataNames() Returns the names of all currently existing supplement data.
void	setPrincipalData(Object principalData) Sets the principle data that represents usually the message to be processed.
void	setSupplementalData(String name, Object supplementalData) Sets a supplement data for the rest of the module chain

Methods inherited from class java.lang.Object

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

Field Detail

supplementalDataTable

protected Hashtable supplementalDataTable

principalData

protected Object principalData

moduleLogs

protected Vector moduleLogs

Constructor Detail

ModuleData

public ModuleData()

Method Detail

getSupplementalDataNames

public Enumeration getSupplementalDataNames()

Returns the names of all currently existing supplement data.

Returns:

Enumeration of Strings that contain the supplement names

setSupplementalData

public void setSupplementalData(String name,
                                Object supplementalData)

Sets a supplement data for the rest of the module chain

Parameters:

name - Name of the supplement data, should contain a namespace

supplementalData - Supplement data value, can be an arbitrary object, the receiver must know the object type

getSupplementalData

public Object getSupplementalData(String name)

Gets one supplement data value.

Parameters:

name - Name of the supplement data

Returns:

Object The supplement data value, might by null if name is not known

setPrincipalData

public void setPrincipalData(Object principalData)

Sets the principle data that represents usually the message to be processed.

Parameters:

principalData - The module interfaces do not require a specific message class Thus the principalData might be a XMBMessage, a MS Message, a XIMessage or another Java class. The administrator however must ensure that the pre-module output is type compatible to the post-module input.

getPrincipalData

public Object getPrincipalData()

Retrieves the current principle data, usually the message

Returns:

Object The message representation.

contentToString

public String contentToString()

String serialization for logging purposes. It dumps the principal and supplement data into a string.

Returns:

String Serialization of the current module data