org.jactr.tools.io
Class ModelRecorder

java.lang.Object
  org.jactr.tools.io.ModelRecorder

All Implemented Interfaces:

org.jactr.core.utils.IInitializable, org.jactr.core.utils.IInstallable, org.jactr.core.utils.parameter.IParameterized, org.jactr.instrument.IInstrument

public class ModelRecorder
extends java.lang.Object
implements org.jactr.instrument.IInstrument, org.jactr.core.utils.parameter.IParameterized

A simple instrument that saves the state of the model before it starts and after it stops.

Author:

developer

Field Summary

static java.lang.String	SAVE_AS_PARAM
static java.lang.String	START_PARAM
static java.lang.String	STOP_PARAM
static java.lang.String	TRIM_CONTRIBUTIONS_PARAM

Constructor Summary

ModelRecorder()
IInstruments should always have a zero arg constructor

Method Summary

java.lang.String	getParameter(java.lang.String key)
java.util.Collection<java.lang.String>	getPossibleParameters()
java.util.Collection<java.lang.String>	getSetableParameters()
void	initialize()
void	install(org.jactr.core.model.IModel model)
static void	saveModel(org.jactr.core.model.IModel model, java.lang.String directory, java.lang.String extension, boolean trim)
void	setParameter(java.lang.String key, java.lang.String value) this chunk of code will permit the ModelRecorder to be configured when the environment.xml file is loaded
void	uninstall(org.jactr.core.model.IModel model)

Methods inherited from class java.lang.Object

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

Field Detail

SAVE_AS_PARAM

public static final java.lang.String SAVE_AS_PARAM

See Also:

Constant Field Values

START_PARAM

public static final java.lang.String START_PARAM

See Also:

Constant Field Values

STOP_PARAM

public static final java.lang.String STOP_PARAM

See Also:

Constant Field Values

TRIM_CONTRIBUTIONS_PARAM

public static final java.lang.String TRIM_CONTRIBUTIONS_PARAM

See Also:

Constant Field Values

Constructor Detail

ModelRecorder

public ModelRecorder()

IInstruments should always have a zero arg constructor

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface org.jactr.core.utils.IInitializable

Specified by:

initialize in interface org.jactr.instrument.IInstrument

See Also:

IInstrument.initialize()

install

public void install(org.jactr.core.model.IModel model)

Specified by:

install in interface org.jactr.core.utils.IInstallable

Specified by:

install in interface org.jactr.instrument.IInstrument

See Also:

IInstrument.install(org.jactr.core.model.IModel)

uninstall

public void uninstall(org.jactr.core.model.IModel model)

Specified by:

uninstall in interface org.jactr.core.utils.IInstallable

Specified by:

uninstall in interface org.jactr.instrument.IInstrument

See Also:

IInstrument.uninstall(org.jactr.core.model.IModel)

getParameter

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

Specified by:

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

See Also:

IParameterized.getParameter(java.lang.String)

getPossibleParameters

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

Specified by:

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

See Also:

IParameterized.getPossibleParameters()

getSetableParameters

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

Specified by:

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

See Also:

IParameterized.getSetableParameters()

setParameter

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

this chunk of code will permit the ModelRecorder to be configured when the environment.xml file is loaded

Specified by:

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

See Also:

IParameterized.setParameter(java.lang.String, java.lang.String)

saveModel

public static void saveModel(org.jactr.core.model.IModel model,
                             java.lang.String directory,
                             java.lang.String extension,
                             boolean trim)