src/jalview/ext/ensembl/EnsemblProtein.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.ext.ensembl;
  22
  23 import jalview.datamodel.AlignmentI;
  24 import jalview.datamodel.SequenceFeature;
  25 import jalview.datamodel.SequenceI;
  26
  27 import java.util.ArrayList;
  28 import java.util.List;
  29
  30 import com.stevesoft.pat.Regex;
  31
  32 /**
  33  * A client to fetch protein translated sequence for an Ensembl identifier
  34  *
  35  * @author gmcarstairs
  36  *
  37  */
  38 public class EnsemblProtein extends EnsemblSeqProxy
  39 {
  40   /*
  41    * accepts ENSP with 11 digits
  42    * or ENSMUSP or similar for other species
  43    * or CCDSnnnnn.nn with at least 3 digits
  44    */
  45   private static final Regex ACCESSION_REGEX = new Regex(
  46           "(ENS([A-Z]{3}|)P[0-9]{11}$)" + "|" + "(CCDS[0-9.]{3,}$)");
  47
  48   /**
  49    * Default constructor (to use rest.ensembl.org)
  50    */
  51   public EnsemblProtein()
  52   {
  53     super();
  54   }
  55
  56   @Override
  57   public String getDbName()
  58   {
  59     return "ENSEMBL (Protein)";
  60   }
  61
  62   @Override
  63   protected EnsemblSeqType getSourceEnsemblType()
  64   {
  65     return EnsemblSeqType.PROTEIN;
  66   }
  67
  68   /**
  69    * Returns false, as this fetcher does not retrieve DNA sequences.
  70    */
  71   @Override
  72   public boolean isDnaCoding()
  73   {
  74     return false;
  75   }
  76
  77   /**
  78    * Test query is to the protein translation of transcript ENST00000288602
  79    */
  80   @Override
  81   public String getTestQuery()
  82   {
  83     return "ENSP00000288602";
  84   }
  85
  86   /**
  87    * Overrides base class method to do nothing - genomic features are not
  88    * applicable to the protein product sequence
  89    */
  90   @Override
  91   protected void addFeaturesAndProduct(String accId, AlignmentI alignment)
  92   {
  93   }
  94
  95   @Override
  96   protected EnsemblFeatureType[] getFeaturesToFetch()
  97   {
  98     // not applicable - can't fetch genomic features for a protein sequence
  99     return null;
 100   }
 101
 102   @Override
 103   protected List<SequenceFeature> getIdentifyingFeatures(SequenceI seq,
 104           String accId)
 105   {
 106     return new ArrayList<>();
 107   }
 108
 109   @Override
 110   public Regex getAccessionValidator()
 111   {
 112     return ACCESSION_REGEX;
 113   }
 114
 115   /**
 116    * Returns an accession id for a query, including conversion of ENST* to
 117    * ENSP*. This supports querying for the protein sequence for a transcript
 118    * (ENST identifier) and returning the ENSP identifier.
 119    */
 120   @Override
 121   public String getAccessionIdFromQuery(String query)
 122   {
 123     String accId = super.getAccessionIdFromQuery(query);
 124
 125     /*
 126      * ensure last character before (11) digits is P
 127      * ENST00000288602 -> ENSP00000288602
 128      * ENSMUST00000288602 -> ENSMUSP00000288602
 129      */
 130     if (accId != null && accId.length() >= 12)
 131     {
 132       char[] chars = accId.toCharArray();
 133       chars[chars.length - 12] = 'P';
 134       accId = new String(chars);
 135     }
 136     return accId;
 137   }
 138
 139 }