org.jactr.tools.itr
Class AbstractParameterModifier

java.lang.Object
  org.jactr.tools.itr.AbstractParameterModifier

All Implemented Interfaces:

org.jactr.core.utils.parameter.IParameterized, IIterativeRunListener, IParameterModifier

Direct Known Subclasses:

BufferParameterModifier, ChunkParameterModifier, ChunkTypeSlotModifier, ModelParameterModifier, ModuleParameterModifier, ProductionParameterModifier

public abstract class AbstractParameterModifier
extends java.lang.Object
implements IIterativeRunListener, org.jactr.core.utils.parameter.IParameterized, IParameterModifier

base class for an iterative listener that can modify a parameter value in a model.

Author:

harrison

Field Summary

Fields inherited from interface org.jactr.tools.itr.IParameterModifier

PARAMETER_NAME, PARAMETER_VALUES

Constructor Summary

AbstractParameterModifier()

Method Summary

void	exceptionThrown(int index, org.jactr.core.model.IModel model, java.lang.Throwable thrown) called if something goes horribly wrong.
java.lang.String	getParameter(java.lang.String key)
java.lang.String	getParameterDisplayName()
java.lang.String	getParameterName()
java.util.List<java.lang.String>	getParameterValues()
java.util.Collection<java.lang.String>	getPossibleParameters()
java.util.Collection<java.lang.String>	getSetableParameters()
void	postRun(int currentRunIndex, int totalRuns, java.util.Collection<org.jactr.core.model.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<org.jactr.core.model.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)
void	setParameter(java.lang.String key, java.lang.String value)
void	setParameterName(java.lang.String name)
void	setParameterValues(java.util.Collection<java.lang.String> values)
void	start(int totalRuns)
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractParameterModifier

public AbstractParameterModifier()

Method Detail

exceptionThrown

public void exceptionThrown(int index,
                            org.jactr.core.model.IModel model,
                            java.lang.Throwable thrown)

Description copied from interface: IIterativeRunListener

called if something goes horribly wrong. This can be invoked at any of three locations:

During a model execution (in which case index>=1, model!=null)

If something goes wrong after the run during cleanup (index>=1, model==null)

or at the end if something goes wrong (index==0, model==null)

Specified by:

exceptionThrown in interface IIterativeRunListener

preLoad

public void preLoad(int currentRunIndex,
                    int totalRuns)

Specified by:

preLoad in interface IIterativeRunListener

postRun

public void postRun(int currentRunIndex,
                    int totalRuns,
                    java.util.Collection<org.jactr.core.model.IModel> models)

Specified by:

postRun in interface IIterativeRunListener

getParameterValues

public java.util.List<java.lang.String> getParameterValues()

Specified by:

getParameterValues in interface IParameterModifier

setParameterValues

public void setParameterValues(java.util.Collection<java.lang.String> values)

setParameterName

public void setParameterName(java.lang.String name)

getParameterName

public java.lang.String getParameterName()

Specified by:

getParameterName in interface IParameterModifier

getParameterDisplayName

public java.lang.String getParameterDisplayName()

Specified by:

getParameterDisplayName in interface IParameterModifier

setParameter

public void setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor,
                         java.lang.String parameterValue)

Specified by:

setParameter in interface IParameterModifier

setParameter

public void setParameter(org.antlr.runtime.tree.CommonTree modelDescriptor,
                         int parameterValueIndex)

Specified by:

setParameter in interface IParameterModifier

preBuild

public void preBuild(int currentRunIndex,
                     int totalRuns,
                     java.util.Collection<org.antlr.runtime.tree.CommonTree> modelDescriptors)

Description copied from interface: IIterativeRunListener

called before each build of the models in the IterativeMain. This gives the listener a chance to tweak the models before they are constructed

Specified by:

preBuild in interface IIterativeRunListener

modelDescriptors - all the descriptors of the models to be created.

preRun

public void preRun(int currentRunIndex,
                   int totalRuns,
                   java.util.Collection<org.jactr.core.model.IModel> models)

Description copied from interface: IIterativeRunListener

called before the run starts

Specified by:

preRun in interface IIterativeRunListener

start

public void start(int totalRuns)

Specified by:

start in interface IIterativeRunListener

stop

public void stop()

Specified by:

stop in interface IIterativeRunListener

getParameter

public java.lang.String getParameter(java.lang.String key)

Specified by:

getParameter in interface org.jactr.core.utils.parameter.IParameterized

getPossibleParameters

public java.util.Collection<java.lang.String> getPossibleParameters()

Specified by:

getPossibleParameters in interface org.jactr.core.utils.parameter.IParameterized

getSetableParameters

public java.util.Collection<java.lang.String> getSetableParameters()

Specified by:

getSetableParameters in interface org.jactr.core.utils.parameter.IParameterized

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Specified by:

setParameter in interface org.jactr.core.utils.parameter.IParameterized