Package com.github.toolarium.processing.unit.runtime

Interface IParameterRuntime

All Known Implementing Classes:

ParameterRuntime

public interface IParameterRuntime

Defines the runtime parameter information.

Method Summary

Modifier and Type	Method	Description
void	addParameterDefinition(ParameterDefinition parameterDefinition)	Gets the parameter definition of a specific key
boolean	existParameter(ParameterDefinition parameterDefinition)	Check if the parameter exists or not
java.util.List<ParameterDefinition>	getParameterDefinition()	Gets the parameter definition list of the processing.
ParameterValue	getParameterValueList(ParameterDefinition parameterDefinition)	Get the parameter value list.
ParameterValue	getParameterValueList(java.util.List<Parameter> parameterList, ParameterDefinition parameterDefinition)	Get the parameter value list.
void	setParameterList(java.util.List<Parameter> parameterList, IProcessingUnitContext processingUnitContext)	Set the processing unit parameters.
void	validateParameterList(java.util.List<Parameter> parameterList)	Validate the parameter list consistency.

Method Detail

getParameterDefinition

java.util.List<ParameterDefinition> getParameterDefinition()

Gets the parameter definition list of the processing.

Returns:

the parameter definition list or null in case of no parameters

addParameterDefinition

void addParameterDefinition(ParameterDefinition parameterDefinition)

Gets the parameter definition of a specific key

Parameters:

parameterDefinition - the parameter definition

existParameter

boolean existParameter(ParameterDefinition parameterDefinition)

Check if the parameter exists or not

Parameters:

parameterDefinition - the parameter definition

Returns:

true or false

setParameterList

void setParameterList(java.util.List<Parameter> parameterList,
                      IProcessingUnitContext processingUnitContext)
               throws ValidationException,
                      ProcessingException

Set the processing unit parameters.

Parameters:

parameterList - the parameter list to run the processing.

processingUnitContext - the processing unit context.

Throws:

ValidationException - This will be throw in case the consistency check failures.

ProcessingException - Throws this exception in case of initialisation failures.

validateParameterList

void validateParameterList(java.util.List<Parameter> parameterList)
                    throws ValidationException

Validate the parameter list consistency. It can be used to verify if the parameter of this processing are well defined.

Parameters:

parameterList - the parameter list.

Throws:

ValidationException - This will be throw in case the consistency check failures.

getParameterValueList

ParameterValue getParameterValueList(ParameterDefinition parameterDefinition)

Get the parameter value list.

Parameters:

parameterDefinition - The parameter definition

Returns:

The parameter value. In case the parameter is not defined and the parameter has a default value the default value will be returned.

getParameterValueList

ParameterValue getParameterValueList(java.util.List<Parameter> parameterList,
                                     ParameterDefinition parameterDefinition)

Get the parameter value list.

Parameters:

parameterList - the parameter list

parameterDefinition - The parameter definition

Returns:

The parameter value. In case the parameter is not defined and the parameter has a default value the default value will be returned.