org.jactr.tools.async.iterative.listener

Class NetworkedIterativeRunListener

java.lang.Object

org.jactr.tools.async.common.MINAEndpoint

org.jactr.tools.async.iterative.listener.NetworkedIterativeRunListener

All Implemented Interfaces:

IParameterized, IIterativeRunListener

public class NetworkedIterativeRunListener
extends MINAEndpoint
implements IIterativeRunListener, IParameterized

Author:

developer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEADLOCK_TIMEOUT_PARAM

Fields inherited from class org.jactr.tools.async.common.MINAEndpoint

ADDRESS, CRED_CLASS, CREDENTAILS, PROTOCOL_CLASS, SERVICE_CLASS, TRANSPORT_CLASS

Constructor Summary

Constructors

Constructor and Description
NetworkedIterativeRunListener()

Method Summary

Modifier and Type	Method and Description
void	exceptionThrown(int index, IModel model, java.lang.Throwable thrown) called if something goes horribly wrong.
BaseIOHandler	getIOHandler() return the io handler that handles all the communications
java.util.Collection<java.lang.String>	getPossibleParameters() Return all parameters that can be read
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(java.lang.String key, java.lang.String value) Set the named parameter
void	start(int totalRuns)
void	stop()

Methods inherited from class org.jactr.tools.async.common.MINAEndpoint

connect, disconnect, disconnect, getActualAddress, getActualCredentials, getClass, getExecutorService, getParameter, getSetableParameters, instance, setAddressInfo, setCredentialInformation, setCredentialsClass, setExecutorService, setProtocol, setService, setTransportProvider

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jactr.core.utils.parameter.IParameterized

getParameter, getSetableParameters

Field Detail

DEADLOCK_TIMEOUT_PARAM

public static final java.lang.String DEADLOCK_TIMEOUT_PARAM

See Also:

Constant Field Values

Constructor Detail

NetworkedIterativeRunListener

public NetworkedIterativeRunListener()

Method Detail

exceptionThrown

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

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

See Also:

IIterativeRunListener.exceptionThrown(int, org.jactr.core.model.IModel, java.lang.Throwable)

postRun

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

Specified by:

postRun in interface IIterativeRunListener

Throws:

TerminateIterativeRunException

See Also:

IIterativeRunListener.postRun(int, int, java.util.Collection)

preBuild

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

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

See Also:

IIterativeRunListener.preBuild(int, int, java.util.Collection)

preRun

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

Description copied from interface: IIterativeRunListener

called before the run starts

Specified by:

preRun in interface IIterativeRunListener

Throws:

TerminateIterativeRunException - TODO

See Also:

IIterativeRunListener.preRun(int, int, java.util.Collection)

getIOHandler

public BaseIOHandler getIOHandler()

Description copied from class: MINAEndpoint

return the io handler that handles all the communications

Specified by:

getIOHandler in class MINAEndpoint

Returns:

See Also:

MINAEndpoint.getIOHandler()

start

public void start(int totalRuns)
           throws TerminateIterativeRunException

Specified by:

start in interface IIterativeRunListener

Throws:

TerminateIterativeRunException

See Also:

IIterativeRunListener.start(int)

stop

public void stop()

Specified by:

stop in interface IIterativeRunListener

See Also:

IIterativeRunListener.stop()

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

Overrides:

getPossibleParameters in class MINAEndpoint

Returns:

The possibleParameters value

See Also:

IParameterized.getPossibleParameters()

setParameter

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

Description copied from interface: IParameterized

Set the named parameter

Specified by:

setParameter in interface IParameterized

Overrides:

setParameter in class MINAEndpoint

See Also:

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

preLoad

public void preLoad(int currentRunIndex,
                    int totalRuns)
             throws TerminateIterativeRunException

Specified by:

preLoad in interface IIterativeRunListener

Throws:

TerminateIterativeRunException