org.jactr.tools.io

Class ModelRecorder

java.lang.Object

org.jactr.tools.io.ModelRecorder

All Implemented Interfaces:

IInitializable, IInstallable, IParameterized, IInstrument

public class ModelRecorder
extends java.lang.Object
implements IInstrument, IParameterized

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

Author:

developer

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ModelRecorder() IInstruments should always have a zero arg constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameter(java.lang.String key) return parameter value - null if not defined.
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	initialize() perform any dependent initialization.
void	install(IModel model) Description of the Method
static void	saveModel(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(IModel model) Description of the Method

Methods inherited from class java.lang.Object

clone, equals, finalize, 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()

Description copied from interface: IInstrument

perform any dependent initialization. this is called before the model starts, on the model thread. All model data will be available at this time. this method should excecute as quickly as possible so that all the model can start running sooner. Any long running actions should likely be started during install and harvested by initialize()

Specified by:

initialize in interface IInitializable

Specified by:

initialize in interface IInstrument

See Also:

IInstrument.initialize()

install

public void install(IModel model)

Description copied from interface: IInstrument

Description of the Method

Specified by:

install in interface IInstallable

Specified by:

install in interface IInstrument

Parameters:

model - Description of the Parameter

See Also:

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

uninstall

public void uninstall(IModel model)

Description copied from interface: IInstrument

Description of the Method

Specified by:

uninstall in interface IInstallable

Specified by:

uninstall in interface IInstrument

Parameters:

model - Description of the Parameter

See Also:

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

getParameter

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

Description copied from interface: IParameterized

return parameter value - null if not defined.

Specified by:

getParameter in interface IParameterized

Parameters:

key - Description of the Parameter

Returns:

The parameter value

See Also:

IParameterized.getParameter(java.lang.String)

getPossibleParameters

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

Description copied from interface: IParameterized

Return all parameters that can be read

Specified by:

getPossibleParameters in interface IParameterized

Returns:

The possibleParameters value

See Also:

IParameterized.getPossibleParameters()

getSetableParameters

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

Description copied from interface: IParameterized

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Returns:

The setableParameters value

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 IParameterized

See Also:

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

saveModel

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