public abstract class AbstractParameterModifier extends java.lang.Object implements IIterativeRunListener, IParameterized, IParameterModifier
PARAMETER_NAME, PARAMETER_VALUES
Constructor and Description |
---|
AbstractParameterModifier() |
Modifier and Type | Method and Description |
---|---|
void |
exceptionThrown(int index,
IModel model,
java.lang.Throwable thrown)
called if something goes horribly wrong.
|
java.lang.String |
getParameter(java.lang.String key)
return parameter value - null if not defined.
|
java.lang.String |
getParameterDisplayName() |
java.lang.String |
getParameterName() |
java.util.List<java.lang.String> |
getParameterValues() |
java.util.Collection<java.lang.String> |
getPossibleParameters()
Return all parameters that can be read
|
java.util.Collection<java.lang.String> |
getSetableParameters()
Return list of all parameters that can be set.
|
void |
postRun(int currentRunIndex,
int totalRuns,
java.util.Collection<IModel> models) |
void |
preBuild(int currentRunIndex,
int totalRuns,
java.util.Collection<org.antlr.runtime.tree.CommonTree> modelDescriptors)
called before each build of the models in the IterativeMain.
|
void |
preLoad(int currentRunIndex,
int totalRuns) |
void |
preRun(int currentRunIndex,
int totalRuns,
java.util.Collection<IModel> models)
called before the run starts
|
void |
setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor,
int parameterValueIndex) |
void |
setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor,
java.lang.String parameterValue) |
protected abstract void |
setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor,
java.lang.String parameter,
java.lang.String value) |
void |
setParameter(java.lang.String key,
java.lang.String value)
Set the named parameter
|
void |
setParameterName(java.lang.String name) |
void |
setParameterValues(java.util.Collection<java.lang.String> values) |
void |
start(int totalRuns) |
void |
stop() |
public void exceptionThrown(int index, IModel model, java.lang.Throwable thrown) throws TerminateIterativeRunException
IIterativeRunListener
TerminateIterativeRunException
when model!=null,
as it will not be caught by the IterativeMain entry point. If you need to
terminate the iterative run entirely because of a model level exception,
you should record that the exception occured and then terminate from
postRun()exceptionThrown
in interface IIterativeRunListener
TerminateIterativeRunException
- if the iterative run should be killed. TODOpublic void preLoad(int currentRunIndex, int totalRuns) throws TerminateIterativeRunException
preLoad
in interface IIterativeRunListener
TerminateIterativeRunException
public void postRun(int currentRunIndex, int totalRuns, java.util.Collection<IModel> models) throws TerminateIterativeRunException
postRun
in interface IIterativeRunListener
TerminateIterativeRunException
public java.util.List<java.lang.String> getParameterValues()
getParameterValues
in interface IParameterModifier
public void setParameterValues(java.util.Collection<java.lang.String> values)
public void setParameterName(java.lang.String name)
public java.lang.String getParameterName()
getParameterName
in interface IParameterModifier
public java.lang.String getParameterDisplayName()
getParameterDisplayName
in interface IParameterModifier
public void setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor, java.lang.String parameterValue)
setParameter
in interface IParameterModifier
protected abstract void setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor, java.lang.String parameter, java.lang.String value)
public void setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor, int parameterValueIndex)
setParameter
in interface IParameterModifier
public void preBuild(int currentRunIndex, int totalRuns, java.util.Collection<org.antlr.runtime.tree.CommonTree> modelDescriptors) throws TerminateIterativeRunException
IIterativeRunListener
preBuild
in interface IIterativeRunListener
modelDescriptors
- all the descriptors of the models to be created.TerminateIterativeRunException
- TODOpublic void preRun(int currentRunIndex, int totalRuns, java.util.Collection<IModel> models) throws TerminateIterativeRunException
IIterativeRunListener
preRun
in interface IIterativeRunListener
TerminateIterativeRunException
- TODOpublic void start(int totalRuns) throws TerminateIterativeRunException
start
in interface IIterativeRunListener
TerminateIterativeRunException
public void stop()
stop
in interface IIterativeRunListener
public java.lang.String getParameter(java.lang.String key)
IParameterized
getParameter
in interface IParameterized
key
- Description of the Parameterpublic java.util.Collection<java.lang.String> getPossibleParameters()
IParameterized
getPossibleParameters
in interface IParameterized
public java.util.Collection<java.lang.String> getSetableParameters()
IParameterized
getSetableParameters
in interface IParameterized
public void setParameter(java.lang.String key, java.lang.String value)
IParameterized
setParameter
in interface IParameterized