de.aristaflow.adept2.model.execution

Interface InputDataContext

All Superinterfaces:

PluginDataContainer, UserAttributeContainer

All Known Subinterfaces:

DataContext, ParameterDataContext, SerialisableDataContext

All Known Implementing Classes:

SettableDataContext

public interface InputDataContext
extends UserAttributeContainer, PluginDataContainer

This interface provides read access to all parameters of an application or a node. Access is based on the name of a parameter. It may be retrieved whether a parameter is null and the corresponding values.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
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	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.

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

Method Detail

isNull

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.