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