de.aristaflow.adept2.model.runtimeenvironment

Class SettableDataContext

java.lang.Object

SerialisablePluginDataContainer

de.aristaflow.adept2.model.runtimeenvironment.SettableDataContext

All Implemented Interfaces:

PluginDataContainer, UserAttributeContainer, InputDataContext, DataContext

public class SettableDataContext
extends SerialisablePluginDataContainer
implements DataContext

A SettableDataContext allows to set the arbitrary input and output parameters as well as the corresponding values. This allows for using a data context with arbitrary parameters and values and also retrieving the values of output parameters after usage. This way this data context serves the same purpose as an InstanceDataContainer.

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,ProcessModelParameter>	inputParams A map of all input parameters, mapping the name of a parameter to the corresponding parameter object.
protected java.util.HashMap<java.lang.String,ProcessModelParameter>	outputParams A map of all output parameters, mapping the name of a parameter to the corresponding parameter object.
protected java.util.HashMap<java.lang.String,java.io.Serializable>	values The value of the input and output parameters.

Constructor Summary

Constructors

Constructor and Description
SettableDataContext() Creates a new SettableDataContext with no parameters and no values.
SettableDataContext(java.util.Map<java.lang.String,java.io.Serializable> values, java.util.Map<java.lang.String,ProcessModelParameter> inputParams, java.util.Map<java.lang.String,ProcessModelParameter> outputParams) Creates a new SettableDataContext with the designated parameters and values.

Method Summary

Modifier and Type	Method and Description
void	addInputParameter(ProcessModelParameter param, java.io.Serializable value) Adds the designated parameter as input parameter to this data context having the designated value.
void	addOutputParameter(ProcessModelParameter param) Adds the designated parameter as output parameter to this data context.
protected void	checkInputExistence(java.lang.String parameterName) Checks whether the designated parameter is an input parameter (exists in the input parameter map).
protected void	checkInputExistenceAndType(java.lang.String parameterName, ProcessConstants.AdeptDataType expectedType) Checks whether the designated parameter is an input parameter (exists in the input parameter map) and whether it is of the Java-type corresponding to the designated expected ADEPT-data type.
protected void	checkOutputExistence(java.lang.String parameterName) Checks whether the designated parameter is an output parameter (exists in the output parameter map).
protected void	checkOutputExistenceAndType(java.lang.String parameterName, ProcessConstants.AdeptDataType expectedType) Checks whether the designated parameter is an output parameter (exists in the output parameter map) and whether it is of the Java-type corresponding to the designated expected ADEPT-data type.
protected void	checkType(java.lang.Object value, ProcessConstants.AdeptDataType expectedType) Checks whether the designated value is of the Java-type corresponding to the designated ADEPT-data type.
java.util.Map<java.lang.String,java.io.Serializable>	getValues() Returns the values set for the data context, that is a mapping from parameter names to the corresponding values as Java-objects.
boolean	ignoredValue(java.lang.String parameterName) Returns whether the value of the designated output parameter is not or has not been set (ignored) by the application.
void	ignoreValue(java.lang.String parameterName) Ignores the value of the designated parameter that is the value has not been written.
boolean	isNull(java.lang.String parameterName) Returns whether the value of the designated parameter is NULL which means the data element has not been written or has been consumed yet or has been explicitly set to NULL by a previous application.
boolean	isReadOnly() Returns whether this data container is read only and therefore does not allow to store values (and throws an UnsupportedOperationException at the corresponding methods).
boolean	retrieveBooleanParameterValue(java.lang.String parameterName) Reads from an input parameter.
java.util.Date	retrieveDateParameterValue(java.lang.String parameterName) Reads from an input parameter.
double	retrieveFloatParameterValue(java.lang.String parameterName) Reads from an input parameter.
long	retrieveIntegerParameterValue(java.lang.String parameterName) Reads from an input parameter.
java.lang.String	retrieveStringParameterValue(java.lang.String parameterName) Reads from an input parameter.
UDTValue	retrieveUDTParameterValue(java.lang.String parameterName) Reads from an input parameter.
java.net.URI	retrieveURIParameterValue(java.lang.String parameterName) Reads from an input parameter.
void	storeBooleanParameterValue(java.lang.String parameterName, boolean value) Writes an output parameter of the type boolean to the data container of the process management system.
void	storeDateParameterValue(java.lang.String parameterName, java.util.Date value) Writes an output parameter of the type date to the data context of the process management system.
boolean	storedBooleanParameterValue(java.lang.String parameterName) Reads the boolean value of the designated output parameter.
java.util.Date	storedDateParameterValue(java.lang.String parameterName) Reads the date value of the designated output parameter.
double	storedFloatParameterValue(java.lang.String parameterName) Reads the double value of the designated output parameter.
long	storedIntegerParameterValue(java.lang.String parameterName) Reads the long value of the designated output parameter.
java.lang.String	storedStringParameterValue(java.lang.String parameterName) Reads the string value of the designated output parameter.
UDTValue	storedUDTParameterValue(java.lang.String parameterName) Reads the value of the designated output parameter of user-defined type.
java.net.URI	storedURIParameterValue(java.lang.String parameterName) Reads the URI value of the designated output parameter.
void	storeFloatParameterValue(java.lang.String parameterName, double value) Writes an output parameter of the type float to the data container of the process management system.
void	storeIntegerParameterValue(java.lang.String parameterName, long value) Writes an output parameter of the type integer (in java: long) to the data context of the process management system.
void	storeStringParameterValue(java.lang.String parameterName, java.lang.String value) Writes an output parameter of type String to the data container of the process management system.
void	storeUDTParameterValue(java.lang.String parameterName, UDTValue value) Writes an output parameter of an user defined type to the data container of the process management system.
void	storeURIParameterValue(java.lang.String parameterName, java.net.URI value) Writes an output parameter of type URI to the data container of the process management system.
boolean	subEquals(java.lang.Object obj) An implementation of Object.equals(Object) for various purpose.
int	subHashCode() An implementation of Object.hashCode() for various purpose.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

getPluginData, getPluginDatas, getSupportedPlugins

Field Detail

values

protected final java.util.HashMap<java.lang.String,java.io.Serializable> values

The value of the input and output parameters. If a parameter is not in the list its value is expected to be null.

inputParams

protected final java.util.HashMap<java.lang.String,ProcessModelParameter> inputParams

A map of all input parameters, mapping the name of a parameter to the corresponding parameter object.

outputParams

protected final java.util.HashMap<java.lang.String,ProcessModelParameter> outputParams

A map of all output parameters, mapping the name of a parameter to the corresponding parameter object.

Constructor Detail

SettableDataContext

public SettableDataContext()

Creates a new SettableDataContext with no parameters and no values.

SettableDataContext

public SettableDataContext(java.util.Map<java.lang.String,java.io.Serializable> values,
                           java.util.Map<java.lang.String,ProcessModelParameter> inputParams,
                           java.util.Map<java.lang.String,ProcessModelParameter> outputParams)

Creates a new SettableDataContext with the designated parameters and values. Please ensure that the maps are consistent, that is the value-map contains only parameters that are either in the input or in the output parameter map. Additionally, all mandatory input parameter need to have a value in the value map.

Parameters:

values - The values of the parameters, mapping the parameter names to the corresponding values.

inputParams - The input parameters for the data context mapping the parameter name to the corresponding parameter object.

outputParams - The output parameters for the data context mapping the parameter name to the corresponding parameter object.

Method Detail

addInputParameter

public void addInputParameter(ProcessModelParameter param,
                              java.io.Serializable value)

Adds the designated parameter as input parameter to this data context having the designated value. If you need to have it as output parameter as well, also add it as output parameter. If the value is not set yet, use null as value. But do not provide null for a mandatory input parameter!

Parameters:

param - The parameter to add as input parameter to this data context.

value - The value of the input parameter (may be null).

Throws:

java.lang.ClassCastException - If the designated value is not of the Java-type corresponding to the ADEPT-data type of the designated parameter, a ClassCastException will be thrown.

addOutputParameter

public void addOutputParameter(ProcessModelParameter param)

Adds the designated parameter as output parameter to this data context. If you need to have it as input parameter as well, also add it as input parameter.

Parameters:

param - The parameter to add as output parameter to this data context.

getValues

public java.util.Map<java.lang.String,java.io.Serializable> getValues()

Returns the values set for the data context, that is a mapping from parameter names to the corresponding values as Java-objects.

Returns:

All values as mapping from parameter names to the values as Java-objects.

checkType

protected void checkType(java.lang.Object value,
                         ProcessConstants.AdeptDataType expectedType)

Checks whether the designated value is of the Java-type corresponding to the designated ADEPT-data type.

Parameters:

value - The value to check the type of.

expectedType - The ADEPT-data type that the value is expected to be.

Throws:

java.lang.ClassCastException - If the designated value is not of an appropriate type, a ClassCastException will be thrown.

isNull

public boolean isNull(java.lang.String parameterName)
               throws NoSuchParameterException

Description copied from interface: InputDataContext

Returns whether the value of the designated parameter is NULL which means the data element has not been written or has been consumed yet or has been explicitly set to NULL by a previous application. This method has to be called before retrieving a value.

Specified by:

isNull in interface InputDataContext

Parameters:

parameterName - The name of the parameter to check on NULL.

Returns:

true if the value of the designated parameter is NULL and therefore has not been written or has been consumed yet.

Throws:

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

retrieveIntegerParameterValue

public long retrieveIntegerParameterValue(java.lang.String parameterName)
                                   throws InvalidDataTypeException,
                                          NoSuchParameterException

Description copied from interface: InputDataContext

Reads from an input parameter. The associated value must be of type long.

Specified by:

retrieveIntegerParameterValue in interface InputDataContext

Parameters:

parameterName - the name of the input parameter to be read

Returns:

The value for the designated input parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type INTEGER, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

retrieveFloatParameterValue

public double retrieveFloatParameterValue(java.lang.String parameterName)
                                   throws InvalidDataTypeException,
                                          NoSuchParameterException

Description copied from interface: InputDataContext

Reads from an input parameter. The associated value must be of type double.

Specified by:

retrieveFloatParameterValue in interface InputDataContext

Parameters:

parameterName - the name of the input parameter to be read

Returns:

The value for the designated input parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type FLOAT, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

retrieveBooleanParameterValue

public boolean retrieveBooleanParameterValue(java.lang.String parameterName)
                                      throws InvalidDataTypeException,
                                             NoSuchParameterException

Description copied from interface: InputDataContext

Reads from an input parameter. The associated value must be of type boolean.

Specified by:

retrieveBooleanParameterValue in interface InputDataContext

Parameters:

parameterName - the name of the input parameter to be read

Returns:

The value for the designated input parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type BOOLEAN, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

retrieveStringParameterValue

public java.lang.String retrieveStringParameterValue(java.lang.String parameterName)
                                              throws InvalidDataTypeException,
                                                     NoSuchParameterException

Description copied from interface: InputDataContext

Reads from an input parameter. The associated value must be of type String.

Specified by:

retrieveStringParameterValue in interface InputDataContext

Parameters:

parameterName - the name of the input parameter to be read

Returns:

The value for the designated input parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type STRING, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

retrieveDateParameterValue

public java.util.Date retrieveDateParameterValue(java.lang.String parameterName)
                                          throws InvalidDataTypeException,
                                                 NoSuchParameterException

Description copied from interface: InputDataContext

Reads from an input parameter. The associated value must be of type java.util.Date.

Specified by:

retrieveDateParameterValue in interface InputDataContext

Parameters:

parameterName - the name of the input parameter to be read

Returns:

The value for the designated input parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type DATE, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

retrieveURIParameterValue

public java.net.URI retrieveURIParameterValue(java.lang.String parameterName)
                                       throws InvalidDataTypeException,
                                              NoSuchParameterException

Description copied from interface: InputDataContext

Reads from an input parameter. The associated value must be of type URI.

Specified by:

retrieveURIParameterValue in interface InputDataContext

Parameters:

parameterName - the name of the input parameter to be read

Returns:

The value for the designated input parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type URI, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

retrieveUDTParameterValue

public UDTValue retrieveUDTParameterValue(java.lang.String parameterName)
                                   throws InvalidDataTypeException,
                                          NoSuchParameterException

Description copied from interface: InputDataContext

Reads from an input parameter. The associated value must be of an user-defined type.

Specified by:

retrieveUDTParameterValue in interface InputDataContext

Parameters:

parameterName - the name of the input parameter to be read

Returns:

The value for the designated input parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type UDT, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

checkInputExistence

protected void checkInputExistence(java.lang.String parameterName)
                            throws NoSuchParameterException

Checks whether the designated parameter is an input parameter (exists in the input parameter map).

Parameters:

parameterName - The name of the input parameter to check for its existence.

Throws:

NoSuchParameterException - If the designated parameter name is not known as input parameter, a NoSuchParameterException will be thrown.

checkInputExistenceAndType

protected void checkInputExistenceAndType(java.lang.String parameterName,
                                          ProcessConstants.AdeptDataType expectedType)
                                   throws InvalidDataTypeException,
                                          NoSuchParameterException

Checks whether the designated parameter is an input parameter (exists in the input parameter map) and whether it is of the Java-type corresponding to the designated expected ADEPT-data type.

Parameters:

parameterName - The name of the input parameter to check for its existence and type.

expectedType - The type that is expected for the designated parameter.

Throws:

InvalidDataTypeException - If the designated parameter is known but its value is not of the Java-type corresponding to the designated expected type.

NoSuchParameterException - If the designated parameter name is not known as input parameter, a NoSuchParameterException will be thrown.

isReadOnly

public boolean isReadOnly()

Description copied from interface: DataContext

Returns whether this data container is read only and therefore does not allow to store values (and throws an UnsupportedOperationException at the corresponding methods).

Specified by:

isReadOnly in interface DataContext

Returns:

Whether this data container is read only and therefore does not allow to store values.

ignoreValue

public void ignoreValue(java.lang.String parameterName)
                 throws NoSuchParameterException

Description copied from interface: DataContext

Ignores the value of the designated parameter that is the value has not been written.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

ignoreValue in interface DataContext

Parameters:

parameterName - The name of the parameter to be ignored.

Throws:

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

ignoredValue

public boolean ignoredValue(java.lang.String parameterName)
                     throws NoSuchParameterException

Description copied from interface: DataContext

Returns whether the value of the designated output parameter is not or has not been set (ignored) by the application.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

ignoredValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to check for being unset.

Returns:

true if the value of the designated output parameter is or has not been written.

Throws:

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

storeIntegerParameterValue

public void storeIntegerParameterValue(java.lang.String parameterName,
                                       long value)
                                throws InvalidDataTypeException,
                                       NoSuchParameterException

Description copied from interface: DataContext

Writes an output parameter of the type integer (in java: long) to the data context of the process management system. The RuntimeEnvironment executes some management routines, e. g. access control, and delegates the function call to the DataContainer object.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storeIntegerParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be written.

value - The value that is written for the designated output parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type INTEGER, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

DataContainer

storedIntegerParameterValue

public long storedIntegerParameterValue(java.lang.String parameterName)
                                 throws InvalidDataTypeException,
                                        NoSuchParameterException

Description copied from interface: DataContext

Reads the long value of the designated output parameter.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storedIntegerParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be read.

Returns:

The value of the parameter of ADEPT2-type INTEGER and of Java-type long.

Throws:

InvalidDataTypeException - If the designated output parameter is not of type INTEGER, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.INTEGER

storeFloatParameterValue

public void storeFloatParameterValue(java.lang.String parameterName,
                                     double value)
                              throws InvalidDataTypeException,
                                     NoSuchParameterException

Description copied from interface: DataContext

Writes an output parameter of the type float to the data container of the process management system. The RuntimeEnvironment executes some management routines, e. g. access control, and delegates the function call to the DataContainer object.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storeFloatParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be written.

value - The value that is written for the designated output parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type FLOAT, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

DataContainer

storedFloatParameterValue

public double storedFloatParameterValue(java.lang.String parameterName)
                                 throws InvalidDataTypeException,
                                        NoSuchParameterException

Description copied from interface: DataContext

Reads the double value of the designated output parameter.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storedFloatParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be read.

Returns:

The value of the output parameter of ADEPT2-type FLOAT and of Java-type double.

Throws:

InvalidDataTypeException - If the designated output parameter is not of type FLOAT, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.FLOAT

storeBooleanParameterValue

public void storeBooleanParameterValue(java.lang.String parameterName,
                                       boolean value)
                                throws InvalidDataTypeException,
                                       NoSuchParameterException

Description copied from interface: DataContext

Writes an output parameter of the type boolean to the data container of the process management system. The RuntimeEnvironment executes some management routines, e. g. access control, and delegates the function call to the DataContainer object.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storeBooleanParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be written.

value - The value that is written for the designated output parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type BOOLEAN, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

DataContainer

storedBooleanParameterValue

public boolean storedBooleanParameterValue(java.lang.String parameterName)
                                    throws InvalidDataTypeException,
                                           NoSuchParameterException

Description copied from interface: DataContext

Reads the boolean value of the designated output parameter.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storedBooleanParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be read.

Returns:

The value of the output parameter of ADEPT2-type BOOLEAN and of Java-type boolean.

Throws:

InvalidDataTypeException - If the designated output parameter is not of type BOOLEAN, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.BOOLEAN

storeStringParameterValue

public void storeStringParameterValue(java.lang.String parameterName,
                                      java.lang.String value)
                               throws InvalidDataTypeException,
                                      NoSuchParameterException

Description copied from interface: DataContext

Writes an output parameter of type String to the data container of the process management system. The RuntimeEnvironment executes some management routines, e. g. access control, and delegates the function call to the DataContainer object.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storeStringParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be written.

value - The value that is written for the designated output parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type STRING, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

DataContainer

storedStringParameterValue

public java.lang.String storedStringParameterValue(java.lang.String parameterName)
                                            throws InvalidDataTypeException,
                                                   NoSuchParameterException

Description copied from interface: DataContext

Reads the string value of the designated output parameter.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storedStringParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be read.

Returns:

The value of the output parameter of ADEPT2-type STRING and of Java-type String.

Throws:

InvalidDataTypeException - If the designated output parameter is not of type STRING, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.STRING

storeDateParameterValue

public void storeDateParameterValue(java.lang.String parameterName,
                                    java.util.Date value)
                             throws InvalidDataTypeException,
                                    NoSuchParameterException

Description copied from interface: DataContext

Writes an output parameter of the type date to the data context of the process management system. The RuntimeEnvironment executes some management routines, e. g. access control, and delegates the function call to the DataContainer object.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storeDateParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be written.

value - The value that is written for the designated output parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type DATE, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

DataContainer

storedDateParameterValue

public java.util.Date storedDateParameterValue(java.lang.String parameterName)
                                        throws InvalidDataTypeException,
                                               NoSuchParameterException

Description copied from interface: DataContext

Reads the date value of the designated output parameter.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storedDateParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be read.

Returns:

The value of the parameter of ADEPT2-type DATE and of Java-type java.util.Date.

Throws:

InvalidDataTypeException - If the designated output parameter is not of type DATE, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.DATE

storeURIParameterValue

public void storeURIParameterValue(java.lang.String parameterName,
                                   java.net.URI value)
                            throws InvalidDataTypeException,
                                   NoSuchParameterException

Description copied from interface: DataContext

Writes an output parameter of type URI to the data container of the process management system. The RuntimeEnvironment executes some management routines, e. g. access control, and delegates the function call to the DataContainer object.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storeURIParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be written.

value - The value that is written for the designated output parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type URI, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

DataContainer

storedURIParameterValue

public java.net.URI storedURIParameterValue(java.lang.String parameterName)
                                     throws InvalidDataTypeException,
                                            NoSuchParameterException

Description copied from interface: DataContext

Reads the URI value of the designated output parameter.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storedURIParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be read.

Returns:

The value of the parameter of ADEPT2-type URI and of Java-type java.net.URI.

Throws:

InvalidDataTypeException - If the output designated parameter is not of type URI, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.URI

storeUDTParameterValue

public void storeUDTParameterValue(java.lang.String parameterName,
                                   UDTValue value)
                            throws InvalidDataTypeException,
                                   NoSuchParameterException

Description copied from interface: DataContext

Writes an output parameter of an user defined type to the data container of the process management system. The RuntimeEnvironment executes some management routines, e. g. access control, and delegates the function call to the DataContainer object.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storeUDTParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be written.

value - The value that is written for the designated output parameter.

Throws:

InvalidDataTypeException - If the designated parameter is not of type UDT, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

DataContainer

storedUDTParameterValue

public UDTValue storedUDTParameterValue(java.lang.String parameterName)
                                 throws InvalidDataTypeException,
                                        NoSuchParameterException

Description copied from interface: DataContext

Reads the value of the designated output parameter of user-defined type.
An InvalidExecutorThreadException will be thrown if the method is not called by the main thread of the corresponding component.

Specified by:

storedUDTParameterValue in interface DataContext

Parameters:

parameterName - The name of the output parameter to be read.

Returns:

The value of the output parameter of ADEPT2-type USERDEFINED and of Java-type UDTValue.

Throws:

InvalidDataTypeException - If the designated output parameter is not of type USERDEFINED, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the output parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.USERDEFINED

checkOutputExistence

protected void checkOutputExistence(java.lang.String parameterName)
                             throws NoSuchParameterException

Checks whether the designated parameter is an output parameter (exists in the output parameter map).

Parameters:

parameterName - The name of the output parameter to check for its existence.

Throws:

NoSuchParameterException - If the designated parameter name is not known as output parameter, a NoSuchParameterException will be thrown.

checkOutputExistenceAndType

protected void checkOutputExistenceAndType(java.lang.String parameterName,
                                           ProcessConstants.AdeptDataType expectedType)
                                    throws InvalidDataTypeException,
                                           NoSuchParameterException

Checks whether the designated parameter is an output parameter (exists in the output parameter map) and whether it is of the Java-type corresponding to the designated expected ADEPT-data type.

Parameters:

parameterName - The name of the output parameter to check for its existence and type.

expectedType - The type that is expected for the designated parameter.

Throws:

InvalidDataTypeException - If the designated parameter is known but its value is not of the Java-type corresponding to the designated expected type.

NoSuchParameterException - If the designated parameter name is not known as output parameter, a NoSuchParameterException will be thrown.

subEquals

public boolean subEquals(java.lang.Object obj)

An implementation of Object.equals(Object) for various purpose. Due to several reasons we do not want actually override Object.equals(Object).

Parameters:

obj - The object with which to compare.

Returns:

Whether this is the same object as the designated one.

subHashCode

public int subHashCode()

An implementation of Object.hashCode() for various purpose. Due to several reasons we do not want actually override Object.hashCode().
The implementation conforms to the implementation of subEquals(Object) with respect to Object.equals(Object).

Returns:

A hash code value for this object.