org.jactr.tools.itr.fit

Class AbstractModelFitAnalysis

java.lang.Object

org.jactr.tools.itr.fit.AbstractModelFitAnalysis

All Implemented Interfaces:

IParameterized, IIterativeRunListener

Deprecated.

@Deprecated
public abstract class AbstractModelFitAnalysis
extends java.lang.Object
implements IIterativeRunListener, IParameterized

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLUSTER_PREFIX Deprecated.
static java.lang.String	CLUSTERS Deprecated.
static java.lang.String	FILENAME Deprecated.

Constructor Summary

Constructors

Constructor and Description
AbstractModelFitAnalysis() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected abstract void	collectData(int runIndex, java.lang.String clusterName, java.util.Collection<IModel> models, ModelFitStatistics fit) Deprecated. called after each iteration
protected abstract void	collectData(int runIndex, java.lang.String clusterName, ModelFitStatistics fit) Deprecated. called at the end of each cluster
void	exceptionThrown(int index, IModel model, java.lang.Throwable thrown) Deprecated. called if something goes horribly wrong.
protected java.io.PrintWriter	getOutput() Deprecated.
java.lang.String	getParameter(java.lang.String key) Deprecated. return parameter value - null if not defined.
java.util.Collection<java.lang.String>	getPossibleParameters() Deprecated. Return all parameters that can be read
java.util.Collection<java.lang.String>	getSetableParameters() Deprecated. Return list of all parameters that can be set.
protected abstract void	outputFooter(java.io.PrintWriter out) Deprecated.
protected abstract void	outputHeader(java.io.PrintWriter out) Deprecated.
protected abstract void	outputStatistics(ModelFitStatistics fit, java.io.PrintWriter out) Deprecated.
void	postRun(int currentRunIndex, int totalRuns, java.util.Collection<IModel> models) Deprecated.
void	preBuild(int currentRunIndex, int totalRuns, java.util.Collection<org.antlr.runtime.tree.CommonTree> modelDescriptors) Deprecated. called before each build of the models in the IterativeMain.
void	preRun(int currentRunIndex, int totalRuns, java.util.Collection<IModel> models) Deprecated. called before the run starts
void	setParameter(java.lang.String key, java.lang.String value) Deprecated. Set the named parameter
void	start(int totalRuns) Deprecated.
void	stop() Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jactr.entry.iterative.IIterativeRunListener

preLoad

Field Detail

CLUSTERS

public static final java.lang.String CLUSTERS

Deprecated.

See Also:

Constant Field Values

FILENAME

public static final java.lang.String FILENAME

Deprecated.

See Also:

Constant Field Values

CLUSTER_PREFIX

public static final java.lang.String CLUSTER_PREFIX

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AbstractModelFitAnalysis

public AbstractModelFitAnalysis()

Deprecated.

Method Detail

getOutput

protected java.io.PrintWriter getOutput()

Deprecated.

exceptionThrown

public void exceptionThrown(int index,
                            IModel model,
                            java.lang.Throwable thrown)
                     throws TerminateIterativeRunException

Deprecated.

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).
you cannot throw 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()

Specified by:

exceptionThrown in interface IIterativeRunListener

Throws:

TerminateIterativeRunException - if the iterative run should be killed. TODO

postRun

public void postRun(int currentRunIndex,
                    int totalRuns,
                    java.util.Collection<IModel> models)
             throws TerminateIterativeRunException

Deprecated.

Specified by:

postRun in interface IIterativeRunListener

Throws:

TerminateIterativeRunException

preBuild

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

Deprecated.

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.

Throws:

TerminateIterativeRunException - TODO

preRun

public void preRun(int currentRunIndex,
                   int totalRuns,
                   java.util.Collection<IModel> models)
            throws TerminateIterativeRunException

Deprecated.

Description copied from interface: IIterativeRunListener

called before the run starts

Specified by:

preRun in interface IIterativeRunListener

Throws:

TerminateIterativeRunException - TODO

start

public void start(int totalRuns)
           throws TerminateIterativeRunException

Deprecated.

Specified by:

start in interface IIterativeRunListener

Throws:

TerminateIterativeRunException

stop

public void stop()

Deprecated.

Specified by:

stop in interface IIterativeRunListener

collectData

protected abstract void collectData(int runIndex,
                                    java.lang.String clusterName,
                                    java.util.Collection<IModel> models,
                                    ModelFitStatistics fit)

Deprecated.

called after each iteration

Parameters:

models -

collectData

protected abstract void collectData(int runIndex,
                                    java.lang.String clusterName,
                                    ModelFitStatistics fit)

Deprecated.

called at the end of each cluster

Parameters:

runIndex -

fit -

outputStatistics

protected abstract void outputStatistics(ModelFitStatistics fit,
                                         java.io.PrintWriter out)

Deprecated.

outputHeader

protected abstract void outputHeader(java.io.PrintWriter out)

Deprecated.

outputFooter

protected abstract void outputFooter(java.io.PrintWriter out)

Deprecated.

getParameter

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

Deprecated.

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

getPossibleParameters

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

Deprecated.

Description copied from interface: IParameterized

Return all parameters that can be read

Specified by:

getPossibleParameters in interface IParameterized

Returns:

The possibleParameters value

getSetableParameters

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

Deprecated.

Description copied from interface: IParameterized

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Returns:

The setableParameters value

setParameter

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

Deprecated.

Description copied from interface: IParameterized

Set the named parameter

Specified by:

setParameter in interface IParameterized