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

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

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