mev-4.0.01/source/org/tigr/microarray/mev/cluster/gui/IClusterGUI.java

Code
Comments
Other
Rev Date Author Line
2 26 Feb 07 jari 1 /*
2 26 Feb 07 jari 2 Copyright @ 1999-2003, 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  * $RCSfile: IClusterGUI.java,v $
2 26 Feb 07 jari 7  * $Revision: 1.4 $
2 26 Feb 07 jari 8  * $Date: 2006/02/23 20:59:47 $
2 26 Feb 07 jari 9  * $Author: caliente $
2 26 Feb 07 jari 10  * $State: Exp $
2 26 Feb 07 jari 11  */
2 26 Feb 07 jari 12 package org.tigr.microarray.mev.cluster.gui;
2 26 Feb 07 jari 13
2 26 Feb 07 jari 14 import javax.swing.tree.DefaultMutableTreeNode;
2 26 Feb 07 jari 15
2 26 Feb 07 jari 16 import org.tigr.microarray.mev.cluster.algorithm.AbortException;
2 26 Feb 07 jari 17 import org.tigr.microarray.mev.cluster.algorithm.AlgorithmException;
2 26 Feb 07 jari 18
2 26 Feb 07 jari 19 /**
2 26 Feb 07 jari 20  * The interface of a class which is used to execute an analysis.
2 26 Feb 07 jari 21  *
2 26 Feb 07 jari 22  * @version 1.0
2 26 Feb 07 jari 23  * @author Aleksey D.Rezantsev
2 26 Feb 07 jari 24  */
2 26 Feb 07 jari 25 public interface IClusterGUI {
2 26 Feb 07 jari 26     
2 26 Feb 07 jari 27     /**
2 26 Feb 07 jari 28      * This method should return a tree with calculation results or
2 26 Feb 07 jari 29      * null, if analysis start was canceled.
2 26 Feb 07 jari 30      *
2 26 Feb 07 jari 31      * @param framework the reference to <code>IFramework</code> implementation,
2 26 Feb 07 jari 32      *        which is used to obtain an initial analysis data and parameters.
2 26 Feb 07 jari 33      * @throws AlgorithmException if calculation was failed.
2 26 Feb 07 jari 34      * @throws AbortException if calculation was canceled.
2 26 Feb 07 jari 35      * @see IFramework
2 26 Feb 07 jari 36      */
2 26 Feb 07 jari 37     public DefaultMutableTreeNode execute(IFramework framework) throws AlgorithmException;
2 26 Feb 07 jari 38 }