org.barrelorgandiscovery.model

Class ModelStep

java.lang.Object

org.barrelorgandiscovery.model.ModelStep

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GroovyScriptModelStep, MidiFileInput, ModelStepWithConsole, ObjectMethodStep

public abstract class ModelStep
extends java.lang.Object
implements java.io.Serializable

Modeling a model step

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelStep.ParameterError

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelValuedParameter[]	configureParameters Parametres de configuration, ces paramètres sont construits par référence dans la construction de l'objet et ne changent pas dans le cycle de vie de l'objet
protected java.lang.String	label label for this model step

Constructor Summary

Constructors

Constructor and Description
ModelStep() Constructor

Method Summary

Modifier and Type	Method and Description
abstract void	applyConfig() This method adapt parameters from the configuration, this method is called after config parameters has been adjusted usually this method modify the getInputParametersByRef and getOutputParametersByRef return
abstract java.util.Map<AbstractParameter,java.lang.Object>	execute(java.util.Map<AbstractParameter,java.lang.Object> inputValues) Execute the step, for interpret engine
protected ModelParameter[]	filterParameters(org.barrelorgandiscovery.model.ModelStep.IFilterParameters f)
AbstractParameter	findModelParameterRefByName(java.lang.String name) find model parameter reference using its name
abstract ModelParameter[]	getAllParametersByRef() Get the parameter list reference
ModelValuedParameter[]	getConfigureParametersByRef() retourne les paramètres de configuration
java.lang.String	getId()
ModelParameter[]	getInputParametersByRef()
java.lang.String	getLabel()
abstract java.lang.String	getName()
ModelParameter[]	getOutputParametersByRef()
ModelParameter	getParameterByName(java.lang.String name)
int	getScheduleOrder()
boolean	isConfigured() is the step still in configuration state ?
void	setId(java.lang.String id)
void	setLabel(java.lang.String label)
java.lang.String	toString()
protected ModelStep.ParameterError[]	validateConfigValues() Internal method to check config values
ModelStep.ParameterError[]	validateParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues) Check the given parameters

Methods inherited from class java.lang.Object

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

Field Detail

label

protected java.lang.String label

label for this model step

configureParameters

protected ModelValuedParameter[] configureParameters

Parametres de configuration, ces paramètres sont construits par référence dans la construction de l'objet et ne changent pas dans le cycle de vie de l'objet

Constructor Detail

ModelStep

public ModelStep()

Constructor

Method Detail

getScheduleOrder

public int getScheduleOrder()

getAllParametersByRef

public abstract ModelParameter[] getAllParametersByRef()

Get the parameter list reference

Returns:

filterParameters

protected ModelParameter[] filterParameters(org.barrelorgandiscovery.model.ModelStep.IFilterParameters f)

getInputParametersByRef

public ModelParameter[] getInputParametersByRef()

getOutputParametersByRef

public ModelParameter[] getOutputParametersByRef()

getParameterByName

public ModelParameter getParameterByName(java.lang.String name)

findModelParameterRefByName

public AbstractParameter findModelParameterRefByName(java.lang.String name)

find model parameter reference using its name

Parameters:

name - the modelparameter name

Returns:

null if not found

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

getName

public abstract java.lang.String getName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateConfigValues

protected ModelStep.ParameterError[] validateConfigValues()

Internal method to check config values

Returns:

validateParameterValues

public ModelStep.ParameterError[] validateParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)

Check the given parameters

Parameters:

parameterValues -

Returns:

getConfigureParametersByRef

public ModelValuedParameter[] getConfigureParametersByRef()

retourne les paramètres de configuration

Returns:

isConfigured

public boolean isConfigured()

is the step still in configuration state ? this base implementation check if the value of the configparameter is not null

Returns:

applyConfig

public abstract void applyConfig()
                          throws java.lang.Exception

This method adapt parameters from the configuration, this method is called after config parameters has been adjusted usually this method modify the getInputParametersByRef and getOutputParametersByRef return

Throws:

java.lang.Exception

execute

public abstract java.util.Map<AbstractParameter,java.lang.Object> execute(java.util.Map<AbstractParameter,java.lang.Object> inputValues)
                                                                   throws java.lang.Exception

Execute the step, for interpret engine

Parameters:

values - , input values

Returns:

output values

Throws:

java.lang.Exception