src/jalview/ext/ensembl/Species.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ext.ensembl;
  22
  23 import java.util.HashSet;
  24 import java.util.Set;
  25
  26 /**
  27  * Selected species identifiers used by Ensembl
  28  *
  29  * @author gmcarstairs
  30  * @see http://rest.ensembl.org/info/species?content-type=text/xml
  31  */
  32 enum Species
  33 {
  34   /*
  35    * using any suitably readable alias as the enum name; these are all
  36    * valid species parameters to Ensembl REST services where applicable
  37    */
  38   human(true), mouse(true), s_cerevisiae(true), cow(false), pig(false),
  39   rattus_norvegicus(true), celegans(true), sheep(false), horse(false),
  40   gorilla(false), rabbit(false), gibbon(false), dog(false),
  41   orangutan(false), xenopus_tropicalis(true), chimpanzee(false), cat(false),
  42   zebrafish(true), chicken(true), drosophila_melanogaster(true);
  43
  44   static Set<Species> modelOrganisms = new HashSet<>();
  45
  46   static
  47   {
  48     for (Species s : values())
  49     {
  50       if (s.isModelOrganism())
  51       {
  52         modelOrganisms.add(s);
  53       }
  54     }
  55   }
  56
  57   boolean modelOrganism;
  58
  59   private Species(boolean model)
  60   {
  61     this.modelOrganism = model;
  62   }
  63
  64   boolean isModelOrganism()
  65   {
  66     return modelOrganism;
  67   }
  68
  69   public static Set<Species> getModelOrganisms()
  70   {
  71     return modelOrganisms;
  72   }
  73 }