src/jalview/datamodel/DBRefSource.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.datamodel;
  22
  23 /**
  24  * BH 2018 SwingJS note: If additional final static Strings are added to this
  25  * file, they should be added to public static final String[] allTypes.
  26  *
  27  * Defines internal constants for unambiguous annotation of DbRefEntry source
  28  * strings and describing the data retrieved from external database sources (see
  29  * jalview.ws.DbSourcProxy) <br/>
  30  * TODO: replace with ontology to allow recognition of particular attributes
  31  * (e.g. protein coding, alignment (ortholog db, paralog db, domain db),
  32  * genomic, transcriptomic, 3D structure providing (PDB, MODBASE, etc) ..).
  33  *
  34  *
  35  *
  36  * @author JimP
  37  *
  38  */
  39 public class DBRefSource
  40 {
  41
  42
  43
  44   public static final String UNIPROT = "UNIPROT";
  45
  46   public static final String UP_NAME = "UNIPROT_NAME";
  47   /**
  48    * Uniprot Knowledgebase/TrEMBL as served from EMBL protein products.
  49    */
  50   public static final String UNIPROTKB = "UniProtKB/TrEMBL".toUpperCase();
  51
  52   public static final String ENSEMBL        = "ENSEMBL";
  53   public static final String ENSEMBLGENOMES = "ENSEMBLGENOMES";
  54
  55   public static final String EMBL           = "EMBL";
  56   public static final String EMBLCDS        = "EMBLCDS";
  57   public static final String EMBLCDSProduct = "EMBLCDSProtein".toUpperCase();
  58
  59   public static final String PDB    = "PDB";
  60
  61   public static final String PFAM = "PFAM";
  62
  63   public static final String RFAM   = "RFAM";
  64   public static final String GENEDB = "GeneDB".toUpperCase();
  65
  66   public static final String PFAM_FULL = "PFAM (Full)";
  67
  68   public static final String PFAM_SEED = "PFAM (Seed)";
  69
  70   public static final String RFAM_SEED = "RFAM (Seed)";
  71
  72   public static final String PDB_CANONICAL_NAME = PDB;
  73
  74
  75   public static final String[] allSources = new String[] {
  76       UNIPROT,
  77       UP_NAME, UNIPROTKB,
  78       ENSEMBL, ENSEMBLGENOMES,
  79       EMBL, EMBLCDS, EMBLCDSProduct,
  80       PDB, PFAM, RFAM, GENEDB
  81       };
  82
  83         public static final int UNIPROT_MASK          = 1<<0;
  84         public static final int UP_NAME_MASK          = 1<<1;
  85         public static final int UNIPROT_KB_MASK       = 1<<2;
  86         public static final int ENSEMBL_MASK          = 1<<3;
  87         public static final int ENSEMBL_GENOMES_MASK  = 1<<4;
  88         public static final int EMBL_MASK             = 1<<5;
  89         public static final int EMBL_CDS_MASK         = 1<<6;
  90         public static final int EMBL_CDS_PRODUCT_MASK = 1<<7;
  91         public static final int PDB_MASK              = 1<<8;
  92         public static final int PFAM_MASK             = 1<<9;
  93         public static final int RFAM_MASK             = 1<<10;
  94         public static final int GENE_DB_MASK          = 1<<11;
  95
  96     public static final int MASK_COUNT = 12;
  97
  98     public static final int ALL_MASKS = (1 << MASK_COUNT) - 1;
  99
 100         public static int getSourceKey(String name) {
 101                   for (int i = 0; i < MASK_COUNT; i++) {
 102                           if (name.equals(allSources[i]))
 103         {
 104           return 1<<i;
 105         }
 106                   }
 107                   return 0;
 108           }
 109
 110         public static final int PRIMARY_MASK = UNIPROT_MASK | ENSEMBL_MASK;
 111
 112           /**
 113           * List of databases whose sequences might have coding regions annotated
 114           */
 115          public static final String[] DNACODINGDBS = {
 116                      ENSEMBL, ENSEMBLGENOMES,
 117                          EMBL, EMBLCDS, GENEDB
 118              };
 119
 120      public static final int DNA_CODING_MASK =
 121                  ENSEMBL_MASK | ENSEMBL_GENOMES_MASK
 122           | EMBL_MASK | EMBL_CDS_MASK | GENE_DB_MASK;
 123
 124
 125
 126     public static final String[] CODINGDBS = { EMBLCDS, GENEDB, ENSEMBL };
 127
 128     public static final int CODING_MASK = EMBL_CDS_MASK | GENE_DB_MASK | ENSEMBL_MASK;
 129
 130
 131
 132     public static final String[] PROTEINDBS = {
 133                 UNIPROT, UNIPROTKB,
 134                 ENSEMBL, EMBLCDSProduct }; // Ensembl ENSP* entries are protein
 135
 136     public static final int PROTEIN_MASK =
 137                   UNIPROT_MASK | UNIPROT_KB_MASK
 138                 | ENSEMBL_MASK | EMBL_CDS_PRODUCT_MASK ;
 139
 140
 141     // for SequenceAnnotationReport only
 142
 143 //    public static final String[][] PRIMARY_SOURCES = new String[][] {
 144 //        CODINGDBS, DNACODINGDBS, PROTEINDBS };
 145 //
 146         public static final int PRIMARY_SOURCES_MASK = CODING_MASK | DNA_CODING_MASK | PROTEIN_MASK;
 147
 148     public static boolean isPrimarySource(String source)
 149     {
 150         return ((PRIMARY_SOURCES_MASK & getSourceKey(source)) != 0);
 151     }
 152
 153   public static boolean isPrimaryCandidate(String ucversion) {
 154     // tricky - this test really needs to search the sequence's set of dbrefs to
 155     // see if there is a primary reference that derived this reference.
 156     for (int i = allSources.length; --i >= 0;)
 157     {
 158       if (ucversion.startsWith(allSources[i])) // BH 2019.01.25 .toUpperCase() unnecessary here for allSources
 159       {
 160         // by convention, many secondary references inherit the primary
 161         // reference's
 162         // source string as a prefix for any version information from the
 163         // secondary reference.
 164         return false;
 165       }
 166     }
 167     return true;
 168 }
 169
 170
 171
 172
 173 }