src/jalview/datamodel/DBRefSource.java

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