JAL-2446 merged to spike branch

[jalview.git] / src / jalview / ext / ensembl / EnsemblCdna.java

diff --git a/src/jalview/ext/ensembl/EnsemblCdna.java b/src/jalview/ext/ensembl/EnsemblCdna.java
index 139e44f..6d031b7 100644 (file)
--- a/src/jalview/ext/ensembl/EnsemblCdna.java
+++ b/src/jalview/ext/ensembl/EnsemblCdna.java
@@ -1,27 +1,85 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.ext.ensembl;
 
 import jalview.datamodel.SequenceFeature;
-import jalview.io.gff.SequenceOntology;
+import jalview.io.gff.SequenceOntologyFactory;
+import jalview.io.gff.SequenceOntologyI;
 
-import java.util.List;
+import java.util.HashMap;
+import java.util.Map;
 
 import com.stevesoft.pat.Regex;
 
+/**
+ * A client to fetch CDNA sequence from Ensembl (i.e. that part of the genomic
+ * sequence that is transcribed to RNA, but not necessarily translated to
+ * protein)
+ * 
+ * @author gmcarstairs
+ *
+ */
 public class EnsemblCdna extends EnsemblSeqProxy
 {
   /*
-   * fetch exon features on genomic sequence (to identify the cdnaregions)
+   * accepts ENST or ENSTG with 11 digits
+   * or ENSMUST or similar for other species
+   * or CCDSnnnnn.nn with at least 3 digits
+   */
+  private static final Regex ACCESSION_REGEX = new Regex(
+          "(ENS([A-Z]{3}|)[TG][0-9]{11}$)" + "|" + "(CCDS[0-9.]{3,}$)");
+
+  private static Map<String, String> params = new HashMap<String, String>();
+
+  static
+  {
+    params.put("object_type", "transcript");
+  }
+
+  /*
+   * fetch exon features on genomic sequence (to identify the cdna regions)
    * and cds and variation features (to retain)
    */
   private static final EnsemblFeatureType[] FEATURES_TO_FETCH = {
       EnsemblFeatureType.exon, EnsemblFeatureType.cds,
       EnsemblFeatureType.variation };
 
+  /**
+   * Default constructor (to use rest.ensembl.org)
+   */
   public EnsemblCdna()
   {
     super();
   }
 
+  /**
+   * Constructor given the target domain to fetch data from
+   * 
+   * @param d
+   */
+  public EnsemblCdna(String d)
+  {
+    super(d);
+  }
+
   @Override
   public String getDbName()
   {
@@ -37,7 +95,7 @@ public class EnsemblCdna extends EnsemblSeqProxy
   @Override
   public Regex getAccessionValidator()
   {
-    return new Regex("((ENST|ENSG|CCDS)[0-9.]{3,})");
+    return ACCESSION_REGEX;
   }
 
   @Override
@@ -68,8 +126,8 @@ public class EnsemblCdna extends EnsemblSeqProxy
   @Override
   protected boolean identifiesSequence(SequenceFeature sf, String accId)
   {
-    if (SequenceOntology.getInstance().isA(sf.getType(),
-            SequenceOntology.EXON))
+    if (SequenceOntologyFactory.getInstance().isA(sf.getType(),
+            SequenceOntologyI.EXON))
     {
       String parentFeature = (String) sf.getValue(PARENT);
       if (("transcript:" + accId).equals(parentFeature))
@@ -80,12 +138,14 @@ public class EnsemblCdna extends EnsemblSeqProxy
     return false;
   }
 
+  /**
+   * Parameter object_type=cdna added to ensure cdna and not peptide is returned
+   * (JAL-2529)
+   */
   @Override
-  protected List<String> getCrossReferenceDatabases()
+  protected Map<String, String> getAdditionalParameters()
   {
-    return super.getCrossReferenceDatabases();
-    // 30/01/16 also found Vega_transcript, OTTT, ENS_LRG_transcript, UCSC,
-    // HGNC_trans_name, RefSeq_mRNA, RefSeq_mRNA_predicted
+    return params;
   }
 
 }