edu.jhu.ece.iacl.jist.pipeline.dest
Class PipeParamCopyDestination

java.lang.Object
  extended by edu.jhu.ece.iacl.jist.pipeline.PipeModule
      extended by edu.jhu.ece.iacl.jist.pipeline.PipeDestination
          extended by edu.jhu.ece.iacl.jist.pipeline.dest.PipeParamCopyDestination
All Implemented Interfaces:
PipePort.PortListener, ParamViewObserver

public class PipeParamCopyDestination
extends PipeDestination

Destination for copying output files to specified directory location.

Author:
Blake Lucas (bclucas@jhu.edu)

Nested Class Summary
 
Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule
PipeModule.PipeListener
 
Field Summary
protected  ParamBoolean appendName
          The append name.
protected  java.util.ArrayList<java.lang.Object[]> dataObjects
          The data objects.
protected  ParamString fileName
          The file name.
protected  ParamFile fileOutputDir
          The file output dir.
protected  ParamOption fileType
          The file type.
protected  ParamObject<java.lang.Object[][]> paramSummaryFile
          The param summary file.
 
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeDestination
selectedParams
 
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule
bounds, cell, currentContext, inputHash, inputParams, inputPorts, label, listeners, name, outputHash, outputParams, outputPorts
 
Constructor Summary
PipeParamCopyDestination()
           
 
Method Summary
 void complete()
          Clean up after copying files.
static boolean copyFile(java.io.File src, java.io.File dest)
          Copy a file from source to destination.
protected  ParamCollection createInputParams()
          Create input parameters.
protected  ParamCollection createOutputParams()
          Create output parameters.
 ParamCollection getInputParam()
          Get input parameter
 PipeModuleCell init(PipeJGraph graph)
          Initialize module cell.
 void iterate(javax.swing.ProgressMonitor monitor)
          Iterate through all active experiments and the save the output of each to a specified location.
 void reset()
          Reset data objects to be saved.
 
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeDestination
createModuleCell, getCurrentLayout, pull, release, setCurrentLayout
 
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule
addListener, connectAction, disconnect, disconnectAction, forward, getAncestors, getAncestors, getBounds, getChildren, getCurrentContext, getDescendants, getDescendants, getInputHash, getInputParams, getInputPorts, getLabel, getListeners, getModuleCell, getName, getOutputHash, getOutputParams, getOutputPorts, getParents, isAncestorOf, isDescendantOf, isRoot, push, removeAllListeners, removeListener, setBounds, setCurrentContext, setLabel, setModuleCell, setName, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

paramSummaryFile

protected ParamObject<java.lang.Object[][]> paramSummaryFile
The param summary file.


fileName

protected ParamString fileName
The file name.


fileType

protected ParamOption fileType
The file type.


fileOutputDir

protected ParamFile fileOutputDir
The file output dir.


dataObjects

protected transient java.util.ArrayList<java.lang.Object[]> dataObjects
The data objects.


appendName

protected ParamBoolean appendName
The append name.

Constructor Detail

PipeParamCopyDestination

public PipeParamCopyDestination()
Method Detail

getInputParam

public ParamCollection getInputParam()
Get input parameter

Overrides:
getInputParam in class PipeDestination
Returns:
the input param

complete

public void complete()
Clean up after copying files.

Specified by:
complete in class PipeDestination

copyFile

public static boolean copyFile(java.io.File src,
                               java.io.File dest)
Copy a file from source to destination.

Parameters:
src - source file
dest - destination file
Returns:
true if copy is successful

createInputParams

protected ParamCollection createInputParams()
Create input parameters.

Specified by:
createInputParams in class PipeDestination
Returns:
the param collection

createOutputParams

protected ParamCollection createOutputParams()
Create output parameters.

Specified by:
createOutputParams in class PipeDestination
Returns:
the param collection

init

public PipeModuleCell init(PipeJGraph graph)
Initialize module cell.

Overrides:
init in class PipeDestination
Parameters:
graph - the graph
Returns:
the pipe module cell

iterate

public void iterate(javax.swing.ProgressMonitor monitor)
Iterate through all active experiments and the save the output of each to a specified location.

Specified by:
iterate in class PipeDestination
Parameters:
monitor - the monitor

reset

public void reset()
Reset data objects to be saved.

Specified by:
reset in class PipeDestination