mev-4.0.01/source/org/tigr/microarray/mev/script/scriptGUI/IScriptGUI.java

Code
Comments
Other
Rev Date Author Line
2 26 Feb 07 jari 1 /*
2 26 Feb 07 jari 2 Copyright @ 1999-2004, The Institute for Genomic Research (TIGR).
2 26 Feb 07 jari 3 All rights reserved.
2 26 Feb 07 jari 4 */
2 26 Feb 07 jari 5 /*
2 26 Feb 07 jari 6  * IScriptGUI.java
2 26 Feb 07 jari 7  *
2 26 Feb 07 jari 8  * Created on March 21, 2004, 12:46 AM
2 26 Feb 07 jari 9  */
2 26 Feb 07 jari 10
2 26 Feb 07 jari 11 package org.tigr.microarray.mev.script.scriptGUI;
2 26 Feb 07 jari 12
2 26 Feb 07 jari 13 import javax.swing.tree.DefaultMutableTreeNode;
2 26 Feb 07 jari 14
2 26 Feb 07 jari 15 import org.tigr.microarray.mev.cluster.algorithm.AlgorithmData;
2 26 Feb 07 jari 16 import org.tigr.microarray.mev.cluster.algorithm.AlgorithmException;
2 26 Feb 07 jari 17 import org.tigr.microarray.mev.cluster.gui.Experiment;
2 26 Feb 07 jari 18 import org.tigr.microarray.mev.cluster.gui.IFramework;
2 26 Feb 07 jari 19
2 26 Feb 07 jari 20 /** IScriptGUI provides the methods required for an algorithm to
2 26 Feb 07 jari 21  * support scripting activities in MeV.
2 26 Feb 07 jari 22  *
2 26 Feb 07 jari 23  * These methods are to be implemented in the gui packages of algorithm
2 26 Feb 07 jari 24  * modules to implement scripting support and usually these are IClusterGUI
2 26 Feb 07 jari 25  * implementations.
2 26 Feb 07 jari 26  * @author braisted
2 26 Feb 07 jari 27  */
2 26 Feb 07 jari 28 public interface IScriptGUI {
2 26 Feb 07 jari 29  
2 26 Feb 07 jari 30     
2 26 Feb 07 jari 31     /** Returns selected parameters for building a script.
2 26 Feb 07 jari 32      * @param framework Framework object to provide IData object.
2 26 Feb 07 jari 33      * @return
2 26 Feb 07 jari 34      */    
2 26 Feb 07 jari 35     public AlgorithmData getScriptParameters(IFramework framework) ;
2 26 Feb 07 jari 36     
2 26 Feb 07 jari 37     /** Excutes algorihtm provided an experiment, parameters, and the framework.
2 26 Feb 07 jari 38      * @param framework <code>IFramework</code> object.
2 26 Feb 07 jari 39      * @param algData Holds parameters
2 26 Feb 07 jari 40      * @param experiment <code>Experiment</code> object wraps <code>FloatMatrix</code>.
2 26 Feb 07 jari 41      *
2 26 Feb 07 jari 42      * @throws AlgorithmException
2 26 Feb 07 jari 43      * @return
2 26 Feb 07 jari 44      */    
2 26 Feb 07 jari 45     public DefaultMutableTreeNode executeScript(IFramework framework, AlgorithmData algData, 
2 26 Feb 07 jari 46                                              Experiment experiment) throws AlgorithmException;
2 26 Feb 07 jari 47  
2 26 Feb 07 jari 48
2 26 Feb 07 jari 49     
2 26 Feb 07 jari 50     
2 26 Feb 07 jari 51 }