applied copyright 2008
[jalview.git] / src / jalview / datamodel / DBRefSource.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)\r
3  * Copyright (C) 2008 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  * Defines internal constants for unambiguous annotation\r
22  * of DbRefEntry source strings and describing the data\r
23  * retrieved from external database sources (see jalview.ws.DbSourcProxy)\r
24  * @author JimP\r
25  *\r
26  */\r
27 public class DBRefSource\r
28 {\r
29   /**\r
30    * UNIPROT Accession Number\r
31    */\r
32   public static String UNIPROT = "UNIPROT";\r
33   /**\r
34    * UNIPROT Entry Name\r
35    */\r
36   public static String UP_NAME = "UNIPROT_NAME";\r
37   /**\r
38    * Uniprot Knowledgebase/TrEMBL\r
39    * as served from EMBL protein products.\r
40    */\r
41   public static final String UNIPROTKB = "UniProtKB/TrEMBL";\r
42   /**\r
43    * PDB Entry Code\r
44    */\r
45   public static String PDB = "PDB";\r
46   /**\r
47    * EMBL ID\r
48    */\r
49   public static String EMBL = "EMBL";\r
50   /**\r
51    * EMBLCDS ID\r
52    */\r
53   public static String EMBLCDS = "EMBLCDS";\r
54   /**\r
55    * PFAM ID\r
56    */\r
57   public static String PFAM = "PFAM";\r
58   /**\r
59    * GeneDB ID\r
60    */\r
61   public static final String GENEDB = "GeneDB";\r
62 \r
63   /**\r
64    * List of databases whose sequences might have coding regions annotated\r
65    */\r
66   public static final String[] DNACODINGDBS = { EMBL, EMBLCDS, GENEDB};\r
67   public static final String[] CODINGDBS = { EMBLCDS, GENEDB};\r
68   public static final String[] PROTEINDBS = { UNIPROT, PDB, UNIPROTKB};\r
69   public static final String[] PROTEINSEQ = { UNIPROT, UNIPROTKB};\r
70   public static final String[] PROTEINSTR = { PDB };\r
71   public static final String[] DOMAINDBS = { PFAM };\r
72   /**\r
73    * set of unique DBRefSource property constants.\r
74    * These could be used to reconstruct the above groupings\r
75    */\r
76   public static final Object SEQDB = "SQ";\r
77   /**\r
78    * database of nucleic acid sequences\r
79    */\r
80   public static final Object DNASEQDB = "NASQ";\r
81   /**\r
82    * database of amino acid sequences\r
83    */\r
84   public static final Object PROTSEQDB = "PROTSQ";\r
85   /**\r
86    * database of cDNA sequences\r
87    */\r
88   public static final Object CODINGSEQDB = "CODING";\r
89   /**\r
90    * database of na sequences with exon annotation\r
91    */\r
92   public static final Object DNACODINGSEQDB = "XONCODING";\r
93   /**\r
94    * DB returns several sequences associated with a protein domain\r
95    */\r
96   public static final Object DOMAINDB = "DOMAIN";\r
97   /**\r
98    * DB query can take multiple accession codes concatenated\r
99    * by a separator. Value of property indicates maximum number of accession codes to send at a time.\r
100    */\r
101   public static final Object MULTIACC = "MULTIACC";\r
102 }\r