mev-4.0.01/source/org/tigr/microarray/mev/cluster/gui/IFramework.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  * $RCSfile: IFramework.java,v $
2 26 Feb 07 jari 7  * $Revision: 1.11 $
2 26 Feb 07 jari 8  * $Date: 2006/02/23 21:19:42 $
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 java.awt.Color;
2 26 Feb 07 jari 15 import java.awt.Frame;
2 26 Feb 07 jari 16 import java.awt.Rectangle;
2 26 Feb 07 jari 17
2 26 Feb 07 jari 18 import javax.swing.JFrame;
2 26 Feb 07 jari 19 import javax.swing.tree.DefaultMutableTreeNode;
2 26 Feb 07 jari 20
2 26 Feb 07 jari 21 import org.tigr.microarray.mev.ResultTree;
2 26 Feb 07 jari 22 import org.tigr.microarray.mev.cgh.CGHDataModel.CytoBandsModel;
2 26 Feb 07 jari 23 import org.tigr.microarray.mev.cluster.algorithm.AlgorithmFactory;
2 26 Feb 07 jari 24 import org.tigr.microarray.mev.cluster.clusterUtil.ClusterRepository;
2 26 Feb 07 jari 25
2 26 Feb 07 jari 26 /**
2 26 Feb 07 jari 27  * This class serves as an interface to the framework.
2 26 Feb 07 jari 28  *
2 26 Feb 07 jari 29  */
2 26 Feb 07 jari 30 public interface IFramework {
2 26 Feb 07 jari 31     
2 26 Feb 07 jari 32     /**
2 26 Feb 07 jari 33      * Returns instance of <code>IData</code> interface implementation.
2 26 Feb 07 jari 34      */
2 26 Feb 07 jari 35     public IData getData();
2 26 Feb 07 jari 36     
2 26 Feb 07 jari 37     public JFrame getJFrame();
2 26 Feb 07 jari 38     
2 26 Feb 07 jari 39     /**
2 26 Feb 07 jari 40      * Returns instance of <code>AlgorithmFactory</code> interface implementation.
2 26 Feb 07 jari 41      */
2 26 Feb 07 jari 42     public AlgorithmFactory getAlgorithmFactory();
2 26 Feb 07 jari 43     
2 26 Feb 07 jari 44     /**
2 26 Feb 07 jari 45      * Returns instance of <code>IDisplayMenu</code> interface implementation.
2 26 Feb 07 jari 46      */
2 26 Feb 07 jari 47     public IDisplayMenu getDisplayMenu();
2 26 Feb 07 jari 48     
2 26 Feb 07 jari 49     /**
2 26 Feb 07 jari 50      * Returns instance of <code>IDistanceMenu</code> interface implementation.
2 26 Feb 07 jari 51      */
2 26 Feb 07 jari 52     public IDistanceMenu getDistanceMenu();
2 26 Feb 07 jari 53     
2 26 Feb 07 jari 54     /**
2 26 Feb 07 jari 55      * Returns the framework's main frame.
2 26 Feb 07 jari 56      */
2 26 Feb 07 jari 57     public Frame getFrame();
2 26 Feb 07 jari 58     
2 26 Feb 07 jari 59     /**
2 26 Feb 07 jari 60      * Moves scroll pane content to the specified coordinaties.
2 26 Feb 07 jari 61      */
2 26 Feb 07 jari 62     public void setContentLocation(int x, int y);
2 26 Feb 07 jari 63     
2 26 Feb 07 jari 64     /**
2 26 Feb 07 jari 65      * Runs single array viewer for specified column.
2 26 Feb 07 jari 66      */
2 26 Feb 07 jari 67     public void displaySingleArrayViewer(int column);
2 26 Feb 07 jari 68     
2 26 Feb 07 jari 69     /**
2 26 Feb 07 jari 70      * Runs a dialog to display an element info.
2 26 Feb 07 jari 71      */
2 26 Feb 07 jari 72     public void displaySlideElementInfo(int column, int row);
2 26 Feb 07 jari 73     
2 26 Feb 07 jari 74     /**
2 26 Feb 07 jari 75      * Returns text of the framework status bar.
2 26 Feb 07 jari 76      */
2 26 Feb 07 jari 77     public String getStatusText();
2 26 Feb 07 jari 78     
2 26 Feb 07 jari 79     /**
2 26 Feb 07 jari 80      * Sets text to the framework status bar.
2 26 Feb 07 jari 81      */
2 26 Feb 07 jari 82     public void setStatusText(String text);
2 26 Feb 07 jari 83     
2 26 Feb 07 jari 84     /**
2 26 Feb 07 jari 85      * Returns a meta data from a selected tree node.
2 26 Feb 07 jari 86      */
2 26 Feb 07 jari 87     public Object getUserObject();
2 26 Feb 07 jari 88     /**
2 26 Feb 07 jari 89      * Returns the result node containing the supplied object
2 26 Feb 07 jari 90      */
2 26 Feb 07 jari 91     public DefaultMutableTreeNode getNode(Object object);
2 26 Feb 07 jari 92     /**
2 26 Feb 07 jari 93      * Selects passed node in navigation tree, viewer in node is set into MultipleArrayViewer
2 26 Feb 07 jari 94      */
2 26 Feb 07 jari 95     public void setTreeNode(DefaultMutableTreeNode node);    
2 26 Feb 07 jari 96     /**
2 26 Feb 07 jari 97      * Adds passed node in navigation tree, viewer in node is set into MultipleArrayViewer
2 26 Feb 07 jari 98      */
2 26 Feb 07 jari 99     public void addNode(DefaultMutableTreeNode parent, DefaultMutableTreeNode child);
2 26 Feb 07 jari 100     
2 26 Feb 07 jari 101     /**
2 26 Feb 07 jari 102      * Returns the currently selected node.
2 26 Feb 07 jari 103      */       
2 26 Feb 07 jari 104     public DefaultMutableTreeNode getCurrentNode();
2 26 Feb 07 jari 105
2 26 Feb 07 jari 106     /**
2 26 Feb 07 jari 107      * Stores the indices into the cluster repository
2 26 Feb 07 jari 108      */    
2 26 Feb 07 jari 109     public Color storeCluster(int [] indices, Experiment experiment, int clusterType);    
2 26 Feb 07 jari 110
2 26 Feb 07 jari 111     /**
2 26 Feb 07 jari 112      *  Stores indices to a cluster in the manager but doesn't link to a particular viewer node.
2 26 Feb 07 jari 113      */
2 26 Feb 07 jari 114     public void storeOperationCluster(String source, String clusterID, int [] indices, boolean geneCluster);
2 26 Feb 07 jari 115     
2 26 Feb 07 jari 116     /**
2 26 Feb 07 jari 117      * Stores the indices into the cluster repository even if indices represent a subset
2 26 Feb 07 jari 118      * of the displayed cluster.
2 26 Feb 07 jari 119      */
2 26 Feb 07 jari 120     public Color storeSubCluster(int [] indices, Experiment experiment, int clusterType);
2 26 Feb 07 jari 121
2 26 Feb 07 jari 122     /**
2 26 Feb 07 jari 123      * Removes the cluster from the repository
2 26 Feb 07 jari 124      */    
2 26 Feb 07 jari 125     public boolean removeSubCluster(int [] indices, Experiment experiment, int clusterType);
2 26 Feb 07 jari 126     
2 26 Feb 07 jari 127     /**
2 26 Feb 07 jari 128      * Removes the cluster from the repository
2 26 Feb 07 jari 129      */    
2 26 Feb 07 jari 130     public boolean removeCluster(int [] indices, Experiment experiment, int clusterType);
2 26 Feb 07 jari 131     
2 26 Feb 07 jari 132     /**
2 26 Feb 07 jari 133      * Launches a new Multiple Array Viewer given indices
2 26 Feb 07 jari 134      */
2 26 Feb 07 jari 135     public void launchNewMAV(int [] indices, Experiment experiment, String label, int clusterType);
2 26 Feb 07 jari 136     
2 26 Feb 07 jari 137     /**
2 26 Feb 07 jari 138      * Opens viewer a parent node name and a cluster node name
2 26 Feb 07 jari 139      */
2 26 Feb 07 jari 140     public void openClusterNode(String parentNodeName, String childNodeName);
2 26 Feb 07 jari 141     
2 26 Feb 07 jari 142     /**
2 26 Feb 07 jari 143      * Returns the specified cluster repository
2 26 Feb 07 jari 144      */
2 26 Feb 07 jari 145     public ClusterRepository getClusterRepository(int clusterType);
2 26 Feb 07 jari 146     
2 26 Feb 07 jari 147     /** Adds string to history node
2 26 Feb 07 jari 148      */
2 26 Feb 07 jari 149     public void addHistory(String historyEvent);
2 26 Feb 07 jari 150     
2 26 Feb 07 jari 151     /** Returns the ResultTree object
2 26 Feb 07 jari 152      */
2 26 Feb 07 jari 153     public ResultTree getResultTree();
2 26 Feb 07 jari 154     
2 26 Feb 07 jari 155            
2 26 Feb 07 jari 156     /** Adds result to the ResultTree    
2 26 Feb 07 jari 157      */
2 26 Feb 07 jari 158     public void addAnalysisResult(DefaultMutableTreeNode resultNode);
2 26 Feb 07 jari 159     
2 26 Feb 07 jari 160     /** Refreshes current viewer if it's an IViewer **/
2 26 Feb 07 jari 161     public void refreshCurrentViewer();
2 26 Feb 07 jari 162     
2 26 Feb 07 jari 163     /**
2 26 Feb 07 jari 164    * Raktim Nov 02, 2005
2 26 Feb 07 jari 165    * CGH Specific methods
2 26 Feb 07 jari 166    */
2 26 Feb 07 jari 167
2 26 Feb 07 jari 168   /**
2 26 Feb 07 jari 169    * Access to CGH Display Menu
2 26 Feb 07 jari 170    */
2 26 Feb 07 jari 171   public ICGHDisplayMenu getCghDisplayMenu();
2 26 Feb 07 jari 172   /**
2 26 Feb 07 jari 173    * Access to CGH Clones Menu
2 26 Feb 07 jari 174    * @return
2 26 Feb 07 jari 175    */
2 26 Feb 07 jari 176   public ICGHCloneValueMenu getCghCloneValueMenu();
2 26 Feb 07 jari 177   /**
2 26 Feb 07 jari 178    *
2 26 Feb 07 jari 179    * @return
2 26 Feb 07 jari 180    */
2 26 Feb 07 jari 181   public Rectangle getViewerBounds();
2 26 Feb 07 jari 182   /**
2 26 Feb 07 jari 183    * Returns the cytobandmodel associated with the CGH Data
2 26 Feb 07 jari 184    * @return
2 26 Feb 07 jari 185    */
2 26 Feb 07 jari 186     public CytoBandsModel getCytoBandsModel();
2 26 Feb 07 jari 187     
2 26 Feb 07 jari 188 }

Generated on Thu Jul 20 09:29:39 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)