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

Class ParameterRuntime

java.lang.Object

com.github.toolarium.processing.unit.runtime.ParameterRuntime

All Implemented Interfaces:

IParameterRuntime, java.io.Serializable

public class ParameterRuntime
extends java.lang.Object
implements IParameterRuntime, java.io.Serializable

Implements the IParameterRuntime.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParameterRuntime()	Constructor for ParameterRuntime

Method Summary

Modifier and Type	Method	Description
void	addParameterDefinition(ParameterDefinition parameterDefinition)	Gets the parameter definition of a specific key
protected java.lang.String	convertToString(java.lang.Object defaultValue)	Convert the default value into a string value
protected Parameter	createParameter(ParameterDefinition paramDefinition)	Create parameter
boolean	existParameter(ParameterDefinition parameterDefinition)	Check if the parameter exists or not
protected boolean	existParameter(java.lang.String key)	Check if the parameter exists or not
protected Parameter	getParameter(ParameterDefinition parameterDefinition)	Gets the parameter
protected Parameter	getParameter(java.lang.String key)	Gets the parameter
java.util.List<ParameterDefinition>	getParameterDefinition()	Gets the parameter definition list of the processing.
protected ParameterDefinition	getParameterDefinition(java.lang.String key)	Gets the parameter definition of a specific key
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 processingContext)	Set the processing unit parameters.
void	validateParameterList(java.util.List<Parameter> parameterList)	Validate the parameter list consistency.
protected java.lang.String	verifyParameter(java.util.Set<java.lang.String> mandatoryParameters, Parameter parameter, int parameterCounterIdx)	Verify parameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterRuntime

public ParameterRuntime()

Constructor for ParameterRuntime

Method Detail

getParameterDefinition

public java.util.List<ParameterDefinition> getParameterDefinition()

Description copied from interface: IParameterRuntime

Gets the parameter definition list of the processing.

Specified by:

getParameterDefinition in interface IParameterRuntime

Returns:

the parameter definition list or null in case of no parameters

See Also:

IParameterRuntime.getParameterDefinition()

getParameterDefinition

protected ParameterDefinition getParameterDefinition(java.lang.String key)

Gets the parameter definition of a specific key

Parameters:

key - the key

Returns:

the parameter definition

addParameterDefinition

public void addParameterDefinition(ParameterDefinition parameterDefinition)

Description copied from interface: IParameterRuntime

Gets the parameter definition of a specific key

Specified by:

addParameterDefinition in interface IParameterRuntime

Parameters:

parameterDefinition - the parameter definition

See Also:

IParameterRuntime.addParameterDefinition(com.github.toolarium.processing.unit.dto.ParameterDefinition)

existParameter

public boolean existParameter(ParameterDefinition parameterDefinition)

Description copied from interface: IParameterRuntime

Check if the parameter exists or not

Specified by:

existParameter in interface IParameterRuntime

Parameters:

parameterDefinition - the parameter definition

Returns:

true or false

See Also:

IParameterRuntime.existParameter(com.github.toolarium.processing.unit.dto.ParameterDefinition)

existParameter

protected boolean existParameter(java.lang.String key)

Check if the parameter exists or not

Parameters:

key - the key

Returns:

true or false

setParameterList

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

Description copied from interface: IParameterRuntime

Set the processing unit parameters.

Specified by:

setParameterList in interface IParameterRuntime

Parameters:

parameterList - the parameter list to run the processing.

processingContext - 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.

See Also:

IParameterRuntime.setParameterList(java.util.List, com.github.toolarium.processing.unit.IProcessingUnitContext)

validateParameterList

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

Description copied from interface: IParameterRuntime

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

Specified by:

validateParameterList in interface IParameterRuntime

Parameters:

parameterList - the parameter list.

Throws:

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

See Also:

IParameterRuntime.validateParameterList(java.util.List)

getParameterValueList

public ParameterValue getParameterValueList(ParameterDefinition parameterDefinition)

Description copied from interface: IParameterRuntime

Get the parameter value list.

Specified by:

getParameterValueList in interface IParameterRuntime

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.

See Also:

IParameterRuntime.getParameterValueList(com.github.toolarium.processing.unit.dto.ParameterDefinition)

getParameterValueList

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

Description copied from interface: IParameterRuntime

Get the parameter value list.

Specified by:

getParameterValueList in interface IParameterRuntime

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.

See Also:

IParameterRuntime.getParameterValueList(java.util.List, com.github.toolarium.processing.unit.dto.ParameterDefinition)

getParameter

protected Parameter getParameter(ParameterDefinition parameterDefinition)

Gets the parameter

Parameters:

parameterDefinition - the parameter definition

Returns:

the parameter or null

getParameter

protected Parameter getParameter(java.lang.String key)

Gets the parameter

Parameters:

key - the key

Returns:

the parameter or null

verifyParameter

protected java.lang.String verifyParameter(java.util.Set<java.lang.String> mandatoryParameters,
                                           Parameter parameter,
                                           int parameterCounterIdx)

Verify parameter

Parameters:

mandatoryParameters - the mandatory parameters

parameter - the parameter to check

parameterCounterIdx - the parameter counter index

Returns:

the message

createParameter

protected Parameter createParameter(ParameterDefinition paramDefinition)

Create parameter

Parameters:

paramDefinition - the parameter definition

Returns:

the parameter

convertToString

protected java.lang.String convertToString(java.lang.Object defaultValue)

Convert the default value into a string value

Parameters:

defaultValue - the default value

Returns:

the default value as string