plugins/base2/uk.ac.ebi.tab2mage/trunk/AffyArrayDesignBatchImporter/src/uk/ac/ebi/nugo/common/Tab2MageConstants.java

Code
Comments
Other
Rev Date Author Line
441 30 Oct 07 dominic 1 /* $Id: Tab2MageConstants.java 2006-08-08 dominic $
441 30 Oct 07 dominic 2
441 30 Oct 07 dominic 3   This file is for NutriBASE - Nutrigenomics BioArray Software Environment.
441 30 Oct 07 dominic 4   A customisation of the BASE SOFTWARE.
441 30 Oct 07 dominic 5   Developed at the EBI , Cambridge.
441 30 Oct 07 dominic 6   Author: Dominic Oyeniran: oyeniran@ebi.ac.uk
441 30 Oct 07 dominic 7 */
394 15 Aug 07 dominic 8 package uk.ac.ebi.nugo.common;
394 15 Aug 07 dominic 9
394 15 Aug 07 dominic 10 import java.util.Collections;
394 15 Aug 07 dominic 11 import java.util.EnumSet;
394 15 Aug 07 dominic 12 import java.util.Set;
394 15 Aug 07 dominic 13
394 15 Aug 07 dominic 14
394 15 Aug 07 dominic 15 /**
394 15 Aug 07 dominic 16    Constants for the Tab2Mage export/import.
394 15 Aug 07 dominic 17   @author Dominic  Oyeniran
394 15 Aug 07 dominic 18   @version 1.0
394 15 Aug 07 dominic 19  */
394 15 Aug 07 dominic 20 public enum Tab2MageConstants 
394 15 Aug 07 dominic 21 {
394 15 Aug 07 dominic 22   //declare the constants
394 15 Aug 07 dominic 23   /**
394 15 Aug 07 dominic 24       the domain tag is information on the originator of the tab2mage export document
394 15 Aug 07 dominic 25    */
394 15 Aug 07 dominic 26   domain(1, "domain"),
394 15 Aug 07 dominic 27   /**
394 15 Aug 07 dominic 28      The experiment accession number.
394 15 Aug 07 dominic 29    */
394 15 Aug 07 dominic 30   accession(2,"accession\tE-BASE-"),
394 15 Aug 07 dominic 31   /**
394 15 Aug 07 dominic 32      This is a comma-separated list of terms taken from the MGED ontology.
394 15 Aug 07 dominic 33    */
394 15 Aug 07 dominic 34   quality_control(3,"quality_control"),
394 15 Aug 07 dominic 35   /**
394 15 Aug 07 dominic 36      the design type of the experiment.
394 15 Aug 07 dominic 37    */
394 15 Aug 07 dominic 38   experiment_design_type(4,"experiment_design_type"),
394 15 Aug 07 dominic 39   /**
394 15 Aug 07 dominic 40     the expriment name.
394 15 Aug 07 dominic 41    */
394 15 Aug 07 dominic 42   experiment_name(5,"name"),
394 15 Aug 07 dominic 43   /**
394 15 Aug 07 dominic 44     the expriment description.
394 15 Aug 07 dominic 45   */
394 15 Aug 07 dominic 46   description(6,"description"),
394 15 Aug 07 dominic 47   /**
394 15 Aug 07 dominic 48     the date of public release for the expriment. 
394 15 Aug 07 dominic 49    */
394 15 Aug 07 dominic 50   release_date(7,"release_date"),
394 15 Aug 07 dominic 51   /**
394 15 Aug 07 dominic 52     the experiment submission date.  
394 15 Aug 07 dominic 53    */
394 15 Aug 07 dominic 54   submission_date(8,"submission_date"),
394 15 Aug 07 dominic 55   /**
394 15 Aug 07 dominic 56     the experiment submitter.  
394 15 Aug 07 dominic 57    */
394 15 Aug 07 dominic 58   submitter(9,"submitter"),
394 15 Aug 07 dominic 59   /**
394 15 Aug 07 dominic 60     the experiment submitter's email.  
394 15 Aug 07 dominic 61    */
394 15 Aug 07 dominic 62   submitter_email(10,"submitter_email"),
394 15 Aug 07 dominic 63   /**
394 15 Aug 07 dominic 64     the organisation the experiment submitter is affliated  
394 15 Aug 07 dominic 65    */
394 15 Aug 07 dominic 66   organization(11,"organization"),
394 15 Aug 07 dominic 67   /**
394 15 Aug 07 dominic 68     the experiment publication title  
394 15 Aug 07 dominic 69    */
394 15 Aug 07 dominic 70   publication_title(12,"publication_title"),  
394 15 Aug 07 dominic 71   /**
394 15 Aug 07 dominic 72     the authors of the publication title  
394 15 Aug 07 dominic 73    */
394 15 Aug 07 dominic 74   authors(13,"authors"),
394 15 Aug 07 dominic 75   /**
394 15 Aug 07 dominic 76     the journal name  
394 15 Aug 07 dominic 77    */
394 15 Aug 07 dominic 78   journal(14,"journal"),  
394 15 Aug 07 dominic 79   /**
394 15 Aug 07 dominic 80     the journal volume  
394 15 Aug 07 dominic 81    */
394 15 Aug 07 dominic 82   volume(15,"volume"),
394 15 Aug 07 dominic 83   /**
394 15 Aug 07 dominic 84     the jouirnal issue  
394 15 Aug 07 dominic 85    */
394 15 Aug 07 dominic 86   issue(16,"issue"),
394 15 Aug 07 dominic 87   /**
394 15 Aug 07 dominic 88     the journal pages  
394 15 Aug 07 dominic 89    */
394 15 Aug 07 dominic 90   pages(17,"pages"),
394 15 Aug 07 dominic 91   /**
394 15 Aug 07 dominic 92     the year of publication  
394 15 Aug 07 dominic 93    */
394 15 Aug 07 dominic 94   year(18,"year"),
394 15 Aug 07 dominic 95   /**
394 15 Aug 07 dominic 96     the pub med id  
394 15 Aug 07 dominic 97    */
394 15 Aug 07 dominic 98   pubmed_id(19,"pubmed_id"),
394 15 Aug 07 dominic 99   
394 15 Aug 07 dominic 100   raw_file(20,"File[raw]"),
394 15 Aug 07 dominic 101   
394 15 Aug 07 dominic 102   cdf_file(21,"File[cdf]"),
394 15 Aug 07 dominic 103   
394 15 Aug 07 dominic 104   exp_file(22, "File[exp]"),
394 15 Aug 07 dominic 105   
394 15 Aug 07 dominic 106   normalised_file(23, "File[normalized]"),
394 15 Aug 07 dominic 107   
394 15 Aug 07 dominic 108   transformed_file(24, "File[transformed]"),
394 15 Aug 07 dominic 109   
394 15 Aug 07 dominic 110   array_accession(25,"Array[accession]"),
394 15 Aug 07 dominic 111   
394 15 Aug 07 dominic 112   array_serial(26,"Array[serial]"),
394 15 Aug 07 dominic 113   
394 15 Aug 07 dominic 114   hybridization(27, "Hybridization"),
394 15 Aug 07 dominic 115   
394 15 Aug 07 dominic 116   labeledextract(28, "LabeledExtract"),
394 15 Aug 07 dominic 117           
394 15 Aug 07 dominic 118   dye(29, "Dye"),
394 15 Aug 07 dominic 119   
394 15 Aug 07 dominic 120   extract(30,"Extract"),
394 15 Aug 07 dominic 121            
394 15 Aug 07 dominic 122   sample(31, "Sample"),
394 15 Aug 07 dominic 123   
394 15 Aug 07 dominic 124   biosource(32, "BioSource"),
394 15 Aug 07 dominic 125   
394 15 Aug 07 dominic 126   protocol_transformation(33,"Protocol[transformation]"),
394 15 Aug 07 dominic 127   /**
394 15 Aug 07 dominic 128      The procedure used to derive normalized data from the raw data.
394 15 Aug 07 dominic 129    */
394 15 Aug 07 dominic 130   protocol_normalisation(34,"Protocol[normalization]"),
394 15 Aug 07 dominic 131   /**
394 15 Aug 07 dominic 132      The protocol used in the feature extraction step in which 
394 15 Aug 07 dominic 133      the scanned image is converted into raw numerical data.
394 15 Aug 07 dominic 134    */
394 15 Aug 07 dominic 135   protocol_featureextraction(35,"Protocol[image_analysis]"),
394 15 Aug 07 dominic 136   /**
394 15 Aug 07 dominic 137      The protocol by which the hybridized array is imaged.
394 15 Aug 07 dominic 138    */
394 15 Aug 07 dominic 139   protocol_scanning(36,"Protocol[scanning]"),
394 15 Aug 07 dominic 140   /**
394 15 Aug 07 dominic 141      The protocol used to hybridize the labeled extract to the array.
394 15 Aug 07 dominic 142    */
394 15 Aug 07 dominic 143   protocol_hyb(37,  "Protocol[hybridization]"),
394 15 Aug 07 dominic 144   
394 15 Aug 07 dominic 145   protocol_immunoprecipitate(38,"Protocol[immunoprecipitate]"),
394 15 Aug 07 dominic 146   
394 15 Aug 07 dominic 147   /**
394 15 Aug 07 dominic 148      The protocol used to derive the labeled extract from the label.
394 15 Aug 07 dominic 149    */
394 15 Aug 07 dominic 150   protocol_labeling(39,"Protocol[labeling]"),
394 15 Aug 07 dominic 151   
394 15 Aug 07 dominic 152   protocol_pool(40, "Protocol[pool]"),
394 15 Aug 07 dominic 153   
394 15 Aug 07 dominic 154   /**
394 15 Aug 07 dominic 155      The method by which nucleic acid is extracted from the sample.
394 15 Aug 07 dominic 156    */
394 15 Aug 07 dominic 157   protocol_extraction(41,"Protocol[extraction]"),
394 15 Aug 07 dominic 158   
394 15 Aug 07 dominic 159   /**
394 15 Aug 07 dominic 160      This is a general-purpose protocol type describing any treatments of 
394 15 Aug 07 dominic 161      the sample prior to extraction (e.g., administration of drugs, tissue dissection etc.).
394 15 Aug 07 dominic 162    */  
394 15 Aug 07 dominic 163   protocol_treatment(42,"Protocol[treatment]"),
394 15 Aug 07 dominic 164   
394 15 Aug 07 dominic 165   /**
394 15 Aug 07 dominic 166      the protocol used to propagate the biosource
394 15 Aug 07 dominic 167    */
394 15 Aug 07 dominic 168   protocol_grow(43,"Protocol[grow]"),
394 15 Aug 07 dominic 169
394 15 Aug 07 dominic 170   /**
394 15 Aug 07 dominic 171      The hybridization row delimeter for affymetrics and two channel experimnet
394 15 Aug 07 dominic 172    */
394 15 Aug 07 dominic 173   
394 15 Aug 07 dominic 174   hybrow_delimeter(44,"-done-"),
394 15 Aug 07 dominic 175   /**
394 15 Aug 07 dominic 176      The hybridization row delimeter during pooling
394 15 Aug 07 dominic 177    */
394 15 Aug 07 dominic 178   
394 15 Aug 07 dominic 179   poolhybrow_delimeter(45,"--*poolend*--"),
394 15 Aug 07 dominic 180   
394 15 Aug 07 dominic 181   /**
394 15 Aug 07 dominic 182      The protocol parameters delimeter
394 15 Aug 07 dominic 183    */
394 15 Aug 07 dominic 184   protocol_parameter_delimeter(46,";"),
394 15 Aug 07 dominic 185   /**
394 15 Aug 07 dominic 186      The Biomaterialxteristics header
394 15 Aug 07 dominic 187    */
394 15 Aug 07 dominic 188   bio_mat_charact(47, "BioMaterialCharacteristics"),
394 15 Aug 07 dominic 189   
394 15 Aug 07 dominic 190   /**
394 15 Aug 07 dominic 191      The factor values header
394 15 Aug 07 dominic 192    */
394 15 Aug 07 dominic 193   factor_value(48, "FactorValue"),
394 15 Aug 07 dominic 194   
394 15 Aug 07 dominic 195   /**
394 15 Aug 07 dominic 196      The parameter header 
394 15 Aug 07 dominic 197    */
441 30 Oct 07 dominic 198   parameter(49, "Parameter"),
394 15 Aug 07 dominic 199   
394 15 Aug 07 dominic 200   /**
441 30 Oct 07 dominic 201      The protocol header
441 30 Oct 07 dominic 202    */
441 30 Oct 07 dominic 203   protocol(50, "Protocol"),
441 30 Oct 07 dominic 204   
441 30 Oct 07 dominic 205   /**
441 30 Oct 07 dominic 206      nucleic acid extraction
441 30 Oct 07 dominic 207    */
441 30 Oct 07 dominic 208   nucleicacidextraction(51, "Nucleic_Acid_Extraction");
441 30 Oct 07 dominic 209   ;
441 30 Oct 07 dominic 210   
441 30 Oct 07 dominic 211   /**
394 15 Aug 07 dominic 212       Tab2Mage Constant enum constructor
394 15 Aug 07 dominic 213       @param constId
394 15 Aug 07 dominic 214       @param constName
394 15 Aug 07 dominic 215    */
394 15 Aug 07 dominic 216   //enum constructor
394 15 Aug 07 dominic 217   Tab2MageConstants(int constId, String constName)
394 15 Aug 07 dominic 218   {
394 15 Aug 07 dominic 219     name= constName;
394 15 Aug 07 dominic 220     id= constId;
394 15 Aug 07 dominic 221   }
394 15 Aug 07 dominic 222   
394 15 Aug 07 dominic 223   //instance fields
394 15 Aug 07 dominic 224   private final String name;
394 15 Aug 07 dominic 225   private final int id;
394 15 Aug 07 dominic 226   
394 15 Aug 07 dominic 227   /**
394 15 Aug 07 dominic 228     get the name of this constant, that should be used as header.
394 15 Aug 07 dominic 229    */
394 15 Aug 07 dominic 230   public String getName() 
394 15 Aug 07 dominic 231   {
394 15 Aug 07 dominic 232     return name;
394 15 Aug 07 dominic 233   }
394 15 Aug 07 dominic 234   /**
394 15 Aug 07 dominic 235     get the id of this constants.
394 15 Aug 07 dominic 236    */
394 15 Aug 07 dominic 237   public int getId() 
394 15 Aug 07 dominic 238   {
394 15 Aug 07 dominic 239     return id;
394 15 Aug 07 dominic 240   }
394 15 Aug 07 dominic 241
394 15 Aug 07 dominic 242   /**
394 15 Aug 07 dominic 243       gets set of protocol constants. these are mostly protocols allowed in the tab2mage specification
394 15 Aug 07 dominic 244       @return Set<Tab2MageConstants> the protocol contants  
394 15 Aug 07 dominic 245    */
394 15 Aug 07 dominic 246   public static Set<Tab2MageConstants> protocolContants() throws UnsupportedOperationException
394 15 Aug 07 dominic 247   {
394 15 Aug 07 dominic 248     return Collections.unmodifiableSet(EnumSet.range(protocol_transformation, protocol_grow));
394 15 Aug 07 dominic 249     
394 15 Aug 07 dominic 250   }
394 15 Aug 07 dominic 251   /**
394 15 Aug 07 dominic 252     gets set of experiment constants
394 15 Aug 07 dominic 253     @return Set<Tab2MageConstants> the experiment constants 
394 15 Aug 07 dominic 254    */
394 15 Aug 07 dominic 255   
394 15 Aug 07 dominic 256   public static Set<Tab2MageConstants> experimentContants()throws UnsupportedOperationException
394 15 Aug 07 dominic 257   {
394 15 Aug 07 dominic 258     return Collections.unmodifiableSet(EnumSet.range(domain, pubmed_id));
394 15 Aug 07 dominic 259     
394 15 Aug 07 dominic 260   }
394 15 Aug 07 dominic 261   /**
394 15 Aug 07 dominic 262     gets set of data file and array information constants
394 15 Aug 07 dominic 263     @return Set<Tab2MageConstants> the data file and array constants 
394 15 Aug 07 dominic 264    */
394 15 Aug 07 dominic 265   public static Set<Tab2MageConstants> dataFileAndArrayContants()throws UnsupportedOperationException
394 15 Aug 07 dominic 266   {
394 15 Aug 07 dominic 267     return Collections.unmodifiableSet(EnumSet.range(raw_file, array_serial));
394 15 Aug 07 dominic 268     
394 15 Aug 07 dominic 269   }
394 15 Aug 07 dominic 270   /**
394 15 Aug 07 dominic 271     gets set of material and processes constants
394 15 Aug 07 dominic 272     @return Set<Tab2MageConstants> the set of material and processed constants 
394 15 Aug 07 dominic 273    */
394 15 Aug 07 dominic 274   
394 15 Aug 07 dominic 275   public static Set<Tab2MageConstants> materialAndProcessesContants()throws UnsupportedOperationException
394 15 Aug 07 dominic 276   {
394 15 Aug 07 dominic 277     return Collections.unmodifiableSet(EnumSet.range(hybridization, biosource));
394 15 Aug 07 dominic 278     
394 15 Aug 07 dominic 279   }
394 15 Aug 07 dominic 280 }

Generated on Tue Nov 21 03:44:07 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)