mev-4.0.01/source/org/tigr/microarray/mev/cluster/gui/IData.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: IData.java,v $
2 26 Feb 07 jari 7  * $Revision: 1.9 $
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
2 26 Feb 07 jari 13 package org.tigr.microarray.mev.cluster.gui;
2 26 Feb 07 jari 14
2 26 Feb 07 jari 15 import java.awt.Color;
2 26 Feb 07 jari 16 import java.util.ArrayList;
2 26 Feb 07 jari 17 import java.util.Vector;
2 26 Feb 07 jari 18
2 26 Feb 07 jari 19 import org.tigr.microarray.mev.ISlideData;
2 26 Feb 07 jari 20 import org.tigr.microarray.mev.ISlideDataElement;
2 26 Feb 07 jari 21 import org.tigr.microarray.mev.cgh.CGHDataObj.CGHClone;
2 26 Feb 07 jari 22
2 26 Feb 07 jari 23 public interface IData {
2 26 Feb 07 jari 24     //Log state
2 26 Feb 07 jari 25     public final static int LINEAR = 0;
2 26 Feb 07 jari 26     public final static int LOG = 1;
2 26 Feb 07 jari 27   
2 26 Feb 07 jari 28     public final static int DATA_TYPE_TWO_INTENSITY = 0;
2 26 Feb 07 jari 29     public final static int DATA_TYPE_RATIO_ONLY = 1;
2 26 Feb 07 jari 30     public final static int DATA_TYPE_AFFY_ABS = 2;
2 26 Feb 07 jari 31     public final static int DATA_TYPE_AFFY_REF = 3;
2 26 Feb 07 jari 32     public final static int DATA_TYPE_AFFY_MEAN = 4;
2 26 Feb 07 jari 33     public final static int DATA_TYPE_AFFY_MEDIAN = 5;
2 26 Feb 07 jari 34     
2 26 Feb 07 jari 35     public final static String DEFAULT_SAMPLE_ANNOTATION_KEY = "Default Slide Name";
2 26 Feb 07 jari 36
2 26 Feb 07 jari 37   /**
2 26 Feb 07 jari 38    * Raktim
2 26 Feb 07 jari 39    * CGH Constants
2 26 Feb 07 jari 40    */
2 26 Feb 07 jari 41   public final static int DATA_TYPE_CGH = 6;
2 26 Feb 07 jari 42   public static final int BAD_CLONE = -10;
2 26 Feb 07 jari 43     public static final int NO_COPY_CHANGE = -11;
2 26 Feb 07 jari 44
2 26 Feb 07 jari 45     /**
2 26 Feb 07 jari 46      * Returns the experiment data (ratio values).
2 26 Feb 07 jari 47      * @see Experiment
2 26 Feb 07 jari 48      */
2 26 Feb 07 jari 49     public Experiment getExperiment();
2 26 Feb 07 jari 50     
2 26 Feb 07 jari 51     /**
2 26 Feb 07 jari 52      * Returns the experiment data (ratio values) without application of cutoffs.
2 26 Feb 07 jari 53      * @see Experiment
2 26 Feb 07 jari 54      */
2 26 Feb 07 jari 55     public Experiment getFullExperiment();
2 26 Feb 07 jari 56     
2 26 Feb 07 jari 57     /**
2 26 Feb 07 jari 58      * Returns count of features.
2 26 Feb 07 jari 59      */
2 26 Feb 07 jari 60     public int getFeaturesCount();
2 26 Feb 07 jari 61     
2 26 Feb 07 jari 62     /**
2 26 Feb 07 jari 63      * Returns size of features.
2 26 Feb 07 jari 64      */
2 26 Feb 07 jari 65     public int getFeaturesSize();
2 26 Feb 07 jari 66
2 26 Feb 07 jari 67     /**
2 26 Feb 07 jari 68      * Retruns the indicated feature
2 26 Feb 07 jari 69      */
2 26 Feb 07 jari 70     public ISlideData getFeature(int index);
2 26 Feb 07 jari 71
2 26 Feb 07 jari 72     /**
2 26 Feb 07 jari 73      * Returns the indicated ISlideDataElement
2 26 Feb 07 jari 74      */
2 26 Feb 07 jari 75     public ISlideDataElement getSlideDataElement(int row, int col);
2 26 Feb 07 jari 76         
2 26 Feb 07 jari 77     /**
2 26 Feb 07 jari 78      * Returns the integer identifying the type of input data
2 26 Feb 07 jari 79      */
2 26 Feb 07 jari 80     public int getDataType();
2 26 Feb 07 jari 81     
2 26 Feb 07 jari 82     /**
2 26 Feb 07 jari 83      * Returns CY3 value.
2 26 Feb 07 jari 84      */
2 26 Feb 07 jari 85     public float getCY3(int column, int row);
2 26 Feb 07 jari 86     
2 26 Feb 07 jari 87     /**
2 26 Feb 07 jari 88      * Returns CY5 value.
2 26 Feb 07 jari 89      */
2 26 Feb 07 jari 90     public float getCY5(int column, int row);
2 26 Feb 07 jari 91     
2 26 Feb 07 jari 92     /**
2 26 Feb 07 jari 93      * Returns max CY3 value.
2 26 Feb 07 jari 94      */
2 26 Feb 07 jari 95     public float getMaxCY3();
2 26 Feb 07 jari 96     
2 26 Feb 07 jari 97     /**
2 26 Feb 07 jari 98      * Returns max CY5 value.
2 26 Feb 07 jari 99      */
2 26 Feb 07 jari 100     public float getMaxCY5();
2 26 Feb 07 jari 101     
2 26 Feb 07 jari 102     /**
2 26 Feb 07 jari 103      * Returns ratio value.
2 26 Feb 07 jari 104      */
2 26 Feb 07 jari 105     public float getRatio(int column, int row, int logState);
2 26 Feb 07 jari 106     
2 26 Feb 07 jari 107     /**
2 26 Feb 07 jari 108      * Returns min ratio value.
2 26 Feb 07 jari 109      */
2 26 Feb 07 jari 110     public float getMinRatio();
2 26 Feb 07 jari 111     
2 26 Feb 07 jari 112     /**
2 26 Feb 07 jari 113      * Returns max ratio value
2 26 Feb 07 jari 114      */
2 26 Feb 07 jari 115     public float getMaxRatio();
2 26 Feb 07 jari 116     
2 26 Feb 07 jari 117     /**
2 26 Feb 07 jari 118      * Returns feature name.
2 26 Feb 07 jari 119      */
2 26 Feb 07 jari 120     public String getSampleName(int column);
2 26 Feb 07 jari 121     
2 26 Feb 07 jari 122     /**
2 26 Feb 07 jari 123      * Returns the slected sample annotation
2 26 Feb 07 jari 124      */
2 26 Feb 07 jari 125     public String getSampleAnnotation(int column, String key);
2 26 Feb 07 jari 126     
2 26 Feb 07 jari 127     /**
2 26 Feb 07 jari 128      * Returns full feature name.
2 26 Feb 07 jari 129      */
2 26 Feb 07 jari 130     public String getFullSampleName(int column);
2 26 Feb 07 jari 131     
2 26 Feb 07 jari 132     /**
2 26 Feb 07 jari 133      * Sets the experiment label index for the collection of features
2 26 Feb 07 jari 134      */
2 26 Feb 07 jari 135     public void setSampleLabelKey(String key);
2 26 Feb 07 jari 136     
2 26 Feb 07 jari 137     /**
2 26 Feb 07 jari 138      * Returns an element attribute.
2 26 Feb 07 jari 139      */
2 26 Feb 07 jari 140     public String getElementAttribute(int row, int attr);
2 26 Feb 07 jari 141     
2 26 Feb 07 jari 142     /**
2 26 Feb 07 jari 143      * Returns a probe column in micro array.
2 26 Feb 07 jari 144      */
2 26 Feb 07 jari 145     public int getProbeColumn(int column, int row);
2 26 Feb 07 jari 146     
2 26 Feb 07 jari 147     /**
2 26 Feb 07 jari 148      * Returns a probe row in micro array.
2 26 Feb 07 jari 149      */
2 26 Feb 07 jari 150     public int getProbeRow(int column, int row);
2 26 Feb 07 jari 151     
2 26 Feb 07 jari 152     /**
2 26 Feb 07 jari 153      * Returns a gene unique id.
2 26 Feb 07 jari 154      */
2 26 Feb 07 jari 155     public String getUniqueId(int row);
2 26 Feb 07 jari 156     
2 26 Feb 07 jari 157     /**
2 26 Feb 07 jari 158      * Returns a gene name.
2 26 Feb 07 jari 159      */
2 26 Feb 07 jari 160     public String getGeneName(int row);
2 26 Feb 07 jari 161     
2 26 Feb 07 jari 162     /**
2 26 Feb 07 jari 163      *Returns all the annotation fields
2 26 Feb 07 jari 164      */
2 26 Feb 07 jari 165     
2 26 Feb 07 jari 166     public String[] getFieldNames();
2 26 Feb 07 jari 167     
2 26 Feb 07 jari 168     /**
2 26 Feb 07 jari 169      *Returns all annotation field names associated with the loaded samples
2 26 Feb 07 jari 170      */
2 26 Feb 07 jari 171     public Vector getSampleAnnotationFieldNames();    
2 26 Feb 07 jari 172    
2 26 Feb 07 jari 173     /**
2 26 Feb 07 jari 174      * Returns sorted indices for specified column.
2 26 Feb 07 jari 175      */
2 26 Feb 07 jari 176     public int[] getSortedIndices(int column);
2 26 Feb 07 jari 177     
2 26 Feb 07 jari 178     
2 26 Feb 07 jari 179     //////////////////////////////////////////
2 26 Feb 07 jari 180     //                                      //
2 26 Feb 07 jari 181     //        color coding methods          //
2 26 Feb 07 jari 182     //                                      //
2 26 Feb 07 jari 183     //////////////////////////////////////////
2 26 Feb 07 jari 184     
2 26 Feb 07 jari 185     /**
2 26 Feb 07 jari 186      * Returns array of published colors.
2 26 Feb 07 jari 187      */
2 26 Feb 07 jari 188     public Color[] getColors();
2 26 Feb 07 jari 189     
2 26 Feb 07 jari 190     /**
2 26 Feb 07 jari 191      * Delete all the published colors.
2 26 Feb 07 jari 192      */
2 26 Feb 07 jari 193     public void deleteColors();
2 26 Feb 07 jari 194     
2 26 Feb 07 jari 195     /**
2 26 Feb 07 jari 196      * Returns public color by specified row.
2 26 Feb 07 jari 197      */
2 26 Feb 07 jari 198     public Color getProbeColor(int row);
2 26 Feb 07 jari 199     
2 26 Feb 07 jari 200     /**
2 26 Feb 07 jari 201      * Sets public color for specified rows.
2 26 Feb 07 jari 202      */
2 26 Feb 07 jari 203     public void setProbesColor(int[] rows, Color color);
2 26 Feb 07 jari 204     
2 26 Feb 07 jari 205     /**
2 26 Feb 07 jari 206      * Returns index of the public color for specified row.
2 26 Feb 07 jari 207      */
2 26 Feb 07 jari 208     public int getProbeColorIndex(int row);
2 26 Feb 07 jari 209     
2 26 Feb 07 jari 210     /**
2 26 Feb 07 jari 211      * Returns probe color indices
2 26 Feb 07 jari 212      */
2 26 Feb 07 jari 213     public int[] getColorIndices();
2 26 Feb 07 jari 214     
2 26 Feb 07 jari 215     /**
2 26 Feb 07 jari 216      * Returns count of rows which have public color index equals to colorIndex.
2 26 Feb 07 jari 217      */
2 26 Feb 07 jari 218     public int getColoredProbesCount(int colorIndex);
2 26 Feb 07 jari 219     
2 26 Feb 07 jari 220     /**
2 26 Feb 07 jari 221      * Delete all the published experiment colors.
2 26 Feb 07 jari 222      */
2 26 Feb 07 jari 223     public void deleteExperimentColors();
2 26 Feb 07 jari 224     
2 26 Feb 07 jari 225     /**
2 26 Feb 07 jari 226      * Returns color for specified column data
2 26 Feb 07 jari 227      */
2 26 Feb 07 jari 228     public Color getExperimentColor(int col);
2 26 Feb 07 jari 229
2 26 Feb 07 jari 230     /**
2 26 Feb 07 jari 231      * Sets color for specified experiment indices 
2 26 Feb 07 jari 232      */
2 26 Feb 07 jari 233     public void setExperimentColor(int [] indices, Color color);
2 26 Feb 07 jari 234     
2 26 Feb 07 jari 235     /**
2 26 Feb 07 jari 236      * Returns index of the public experiment color for specified row.
2 26 Feb 07 jari 237      */
2 26 Feb 07 jari 238     public int getExperimentColorIndex(int row);
2 26 Feb 07 jari 239     
2 26 Feb 07 jari 240     /**
2 26 Feb 07 jari 241      * Returns experiment color indices
2 26 Feb 07 jari 242      */
2 26 Feb 07 jari 243     public int[] getExperimentColorIndices();
2 26 Feb 07 jari 244     
2 26 Feb 07 jari 245     /**
2 26 Feb 07 jari 246      * Returns count of rows which have public color index equals to colorIndex.
2 26 Feb 07 jari 247      */
2 26 Feb 07 jari 248     public int getColoredExperimentsCount(int colorIndex);
2 26 Feb 07 jari 249     
2 26 Feb 07 jari 250     /**
2 26 Feb 07 jari 251      * Returns array of published colors.
2 26 Feb 07 jari 252      */
2 26 Feb 07 jari 253     public Color[] getExperimentColors();
2 26 Feb 07 jari 254     
2 26 Feb 07 jari 255     /**
2 26 Feb 07 jari 256      * Returns an annotation array for the provided indices based on annotation key
2 26 Feb 07 jari 257      */
2 26 Feb 07 jari 258     public String [] getAnnotationList(String fieldName, int [] indices);
2 26 Feb 07 jari 259         
2 26 Feb 07 jari 260     /**
2 26 Feb 07 jari 261      * Returns true if loaded intensities are known to be median
2 26 Feb 07 jari 262      */
2 26 Feb 07 jari 263     public boolean areMedianIntensities();
2 26 Feb 07 jari 264     
2 26 Feb 07 jari 265     /**
2 26 Feb 07 jari 266      * Sets median intensity flag
2 26 Feb 07 jari 267      */
2 26 Feb 07 jari 268     public void setMedianIntensities(boolean areMedians);
2 26 Feb 07 jari 269
2 26 Feb 07 jari 270     /*******************************
2 26 Feb 07 jari 271    * CGH Specific Interface Defs
2 26 Feb 07 jari 272    * Raktim
2 26 Feb 07 jari 273    * Oct 3, 2005
2 26 Feb 07 jari 274    *******************************/
2 26 Feb 07 jari 275   /**
2 26 Feb 07 jari 276    * Returns size of features.
2 26 Feb 07 jari 277    */
2 26 Feb 07 jari 278   public int getFeaturesSize(int chromosome);
2 26 Feb 07 jari 279
2 26 Feb 07 jari 280   /**
2 26 Feb 07 jari 281    * Returns CY3 value.
2 26 Feb 07 jari 282    */
2 26 Feb 07 jari 283   public float getCY3(int column, int row, int chromosome);
2 26 Feb 07 jari 284
2 26 Feb 07 jari 285   /**
2 26 Feb 07 jari 286    * Returns CY5 value.
2 26 Feb 07 jari 287    */
2 26 Feb 07 jari 288   public float getCY5(int column, int row, int chromosome);
2 26 Feb 07 jari 289
2 26 Feb 07 jari 290   /**
2 26 Feb 07 jari 291    * Returns an element attribute.
2 26 Feb 07 jari 292    */
2 26 Feb 07 jari 293   public String getElementAttribute(int row, int attr, int chromosome);
2 26 Feb 07 jari 294
2 26 Feb 07 jari 295   /**
2 26 Feb 07 jari 296    *  Returns the number of chromosomes
2 26 Feb 07 jari 297    */
2 26 Feb 07 jari 298   public int getNumChromosomes();
2 26 Feb 07 jari 299
2 26 Feb 07 jari 300   /**
2 26 Feb 07 jari 301    * Returns the number of data points in a given chromosome
2 26 Feb 07 jari 302    */
2 26 Feb 07 jari 303   public int getNumDataPointsInChrom(int chromosome);
2 26 Feb 07 jari 304
2 26 Feb 07 jari 305   public int getCloneIndex(int relativeIndex, int chromosome);
2 26 Feb 07 jari 306
2 26 Feb 07 jari 307   public int getRelativeIndex(int cloneIndex, int chromosome);
2 26 Feb 07 jari 308
2 26 Feb 07 jari 309   public CGHClone getCloneAt(int index);
2 26 Feb 07 jari 310
2 26 Feb 07 jari 311   public CGHClone getCloneAt(int index, int chromosome);
2 26 Feb 07 jari 312
2 26 Feb 07 jari 313   public float getValue(int experiment, int clone, int chromosome);
2 26 Feb 07 jari 314
2 26 Feb 07 jari 315   /**
2 26 Feb 07 jari 316    * Getter for property clones.
2 26 Feb 07 jari 317    * @return Value of property clones.
2 26 Feb 07 jari 318    */
2 26 Feb 07 jari 319   public java.util.ArrayList getClones();
2 26 Feb 07 jari 320
2 26 Feb 07 jari 321   public ArrayList getFeaturesList();
2 26 Feb 07 jari 322
2 26 Feb 07 jari 323   public float getLogAverageInvertedValue(int experiment, int clone);
2 26 Feb 07 jari 324
2 26 Feb 07 jari 325   public int getCopyNumberDetermination(int experiment, int clone);
2 26 Feb 07 jari 326
2 26 Feb 07 jari 327   public float getPValueByLogCloneDistribution(int experiment, int clone);
2 26 Feb 07 jari 328
2 26 Feb 07 jari 329   public int[][] getChromosomeIndices();
2 26 Feb 07 jari 330
2 26 Feb 07 jari 331   public int[] getSamplesOrder();
2 26 Feb 07 jari 332
2 26 Feb 07 jari 333   /**
2 26 Feb 07 jari 334    * Getter for property annotations.
2 26 Feb 07 jari 335    * @return Value of property annotations.
2 26 Feb 07 jari 336    */
2 26 Feb 07 jari 337   public org.tigr.microarray.mev.cgh.CGHDataObj.ICGHDataRegion[][] getAnnotations();
2 26 Feb 07 jari 338
2 26 Feb 07 jari 339   /**
2 26 Feb 07 jari 340    * ICGHFeatureData adaptations
2 26 Feb 07 jari 341    */
2 26 Feb 07 jari 342   public boolean isMissingData(int cloneIndex);
2 26 Feb 07 jari 343
2 26 Feb 07 jari 344   public int getNumFlankingRegions(int experimentIndex, int chromosomeIndex);
2 26 Feb 07 jari 345
2 26 Feb 07 jari 346   public void setFlankingRegions(int experimentIndex, Vector[] flankingRegions);
2 26 Feb 07 jari 347
2 26 Feb 07 jari 348   /**
2 26 Feb 07 jari 349    * Added additionalinterface methods
2 26 Feb 07 jari 350    * Raktim
2 26 Feb 07 jari 351    */
2 26 Feb 07 jari 352   public boolean isLog2Data();
2 26 Feb 07 jari 353
2 26 Feb 07 jari 354   public boolean isHasDyeSwap();
2 26 Feb 07 jari 355
2 26 Feb 07 jari 356   public int getCGHSpecies();
2 26 Feb 07 jari 357
2 26 Feb 07 jari 358   public boolean hasCloneDistribution();
2 26 Feb 07 jari 359   /**
2 26 Feb 07 jari 360    * END
2 26 Feb 07 jari 361    * CGH Specific Interface Defs
2 26 Feb 07 jari 362      */
2 26 Feb 07 jari 363
2 26 Feb 07 jari 364   /**
2 26 Feb 07 jari 365    * @param annotationKeyType
2 26 Feb 07 jari 366    * @return
2 26 Feb 07 jari 367    */
2 26 Feb 07 jari 368   public String[] getAnnotationList(String annotationKeyType);
2 26 Feb 07 jari 369     
2 26 Feb 07 jari 370 }

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