org.jactr.tools.itr

Class ZipDataListener

java.lang.Object

org.jactr.tools.itr.ZipDataListener

All Implemented Interfaces:

IParameterized, IIterativeRunListener

public class ZipDataListener
extends java.lang.Object
implements IIterativeRunListener, IParameterized

dump the output of an iterative run to a zip archive

Author:

harrison

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ZipDataListener()

Method Summary

Modifier and Type	Method and Description
protected void	archiveAndDeleteContents(java.lang.String pathRoot, java.io.File root, java.io.FilenameFilter filter, java.util.zip.ZipOutputStream zos) archive the contents of root into the zipoutputstream
void	exceptionThrown(int index, IModel model, java.lang.Throwable thrown) called if something goes horribly wrong.
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	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) create the zip file
void	stop() clean up

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_ROOT

public static final java.lang.String IGNORE_ROOT

See Also:

Constant Field Values

Constructor Detail

ZipDataListener

public ZipDataListener()

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

postRun

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

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

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

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

create the zip file

Specified by:

start in interface IIterativeRunListener

Throws:

TerminateIterativeRunException

stop

public void stop()

clean up

Specified by:

stop in interface IIterativeRunListener

archiveAndDeleteContents

protected void archiveAndDeleteContents(java.lang.String pathRoot,
                                        java.io.File root,
                                        java.io.FilenameFilter filter,
                                        java.util.zip.ZipOutputStream zos)
                                 throws java.io.IOException

archive the contents of root into the zipoutputstream

Parameters:

root -

filter -

zos -

Throws:

java.io.IOException

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

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

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

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

preLoad

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

Specified by:

preLoad in interface IIterativeRunListener

Throws:

TerminateIterativeRunException