src/jalview/datamodel/DBRefSource.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)\r
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This file is part of Jalview.\r
   6  * \r
   7  * Jalview is free software: you can redistribute it and/or\r
   8  * modify it under the terms of the GNU General Public License \r
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
  10  * \r
  11  * Jalview is distributed in the hope that it will be useful, but \r
  12  * WITHOUT ANY WARRANTY; without even the implied warranty \r
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
  14  * PURPOSE.  See the GNU General Public License for more details.\r
  15  * \r
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  17  */\r
  18 package jalview.datamodel;\r
  19 \r
  20 /**\r
  21  * Defines internal constants for unambiguous annotation of DbRefEntry source\r
  22  * strings and describing the data retrieved from external database sources (see\r
  23  * jalview.ws.DbSourcProxy)\r
  24  * \r
  25  * @author JimP\r
  26  * \r
  27  */\r
  28 public class DBRefSource\r
  29 {\r
  30   /**\r
  31    * UNIPROT Accession Number\r
  32    */\r
  33   public static String UNIPROT = "UNIPROT";\r
  34 \r
  35   /**\r
  36    * UNIPROT Entry Name\r
  37    */\r
  38   public static String UP_NAME = "UNIPROT_NAME";\r
  39 \r
  40   /**\r
  41    * Uniprot Knowledgebase/TrEMBL as served from EMBL protein products.\r
  42    */\r
  43   public static final String UNIPROTKB = "UniProtKB/TrEMBL";\r
  44 \r
  45   /**\r
  46    * PDB Entry Code\r
  47    */\r
  48   public static String PDB = "PDB";\r
  49 \r
  50   /**\r
  51    * EMBL ID\r
  52    */\r
  53   public static String EMBL = "EMBL";\r
  54 \r
  55   /**\r
  56    * EMBLCDS ID\r
  57    */\r
  58   public static String EMBLCDS = "EMBLCDS";\r
  59 \r
  60   /**\r
  61    * PFAM ID\r
  62    */\r
  63   public static String PFAM = "PFAM";\r
  64 \r
  65   /**\r
  66    * GeneDB ID\r
  67    */\r
  68   public static final String GENEDB = "GeneDB";\r
  69 \r
  70   /**\r
  71    * List of databases whose sequences might have coding regions annotated\r
  72    */\r
  73   public static final String[] DNACODINGDBS =\r
  74   { EMBL, EMBLCDS, GENEDB };\r
  75 \r
  76   public static final String[] CODINGDBS =\r
  77   { EMBLCDS, GENEDB };\r
  78 \r
  79   public static final String[] PROTEINDBS =\r
  80   { UNIPROT, PDB, UNIPROTKB };\r
  81 \r
  82   public static final String[] PROTEINSEQ =\r
  83   { UNIPROT, UNIPROTKB };\r
  84 \r
  85   public static final String[] PROTEINSTR =\r
  86   { PDB };\r
  87 \r
  88   public static final String[] DOMAINDBS =\r
  89   { PFAM };\r
  90 \r
  91   /**\r
  92    * set of unique DBRefSource property constants. These could be used to\r
  93    * reconstruct the above groupings\r
  94    */\r
  95   public static final Object SEQDB = "SQ";\r
  96 \r
  97   /**\r
  98    * database of nucleic acid sequences\r
  99    */\r
 100   public static final Object DNASEQDB = "NASQ";\r
 101 \r
 102   /**\r
 103    * database of amino acid sequences\r
 104    */\r
 105   public static final Object PROTSEQDB = "PROTSQ";\r
 106 \r
 107   /**\r
 108    * database of cDNA sequences\r
 109    */\r
 110   public static final Object CODINGSEQDB = "CODING";\r
 111 \r
 112   /**\r
 113    * database of na sequences with exon annotation\r
 114    */\r
 115   public static final Object DNACODINGSEQDB = "XONCODING";\r
 116 \r
 117   /**\r
 118    * DB returns several sequences associated with a protein domain\r
 119    */\r
 120   public static final Object DOMAINDB = "DOMAIN";\r
 121 \r
 122   /**\r
 123    * DB query can take multiple accession codes concatenated by a separator.\r
 124    * Value of property indicates maximum number of accession codes to send at a\r
 125    * time.\r
 126    */\r
 127   public static final Object MULTIACC = "MULTIACC";\r
 128 \r
 129   /**\r
 130    * DB query returns an alignment for each accession provided.\r
 131    */\r
 132   public static final Object ALIGNMENTDB = "ALIGNMENTS";\r
 133 }\r