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

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

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