JAL-1705 refactoring etc for fetching Ensembl --> Uniprot
[jalview.git] / src / jalview / ext / ensembl / EnsemblCds.java
index 7d0b6fd..2086eba 100644 (file)
@@ -1,8 +1,23 @@
 package jalview.ext.ensembl;
 
 import jalview.datamodel.SequenceFeature;
-import jalview.io.gff.SequenceOntology;
+import jalview.datamodel.SequenceI;
+import jalview.io.gff.SequenceOntologyFactory;
+import jalview.io.gff.SequenceOntologyI;
 
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A client for direct fetching of CDS sequences from Ensembl (i.e. that part of
+ * the genomic sequence that is translated to protein)
+ * 
+ * TODO: not currently used as CDS sequences are computed from CDS features on
+ * transcripts - delete this class?
+ * 
+ * @author gmcarstairs
+ *
+ */
 public class EnsemblCds extends EnsemblSeqProxy
 {
   /*
@@ -14,13 +29,23 @@ public class EnsemblCds extends EnsemblSeqProxy
       EnsemblFeatureType.variation };
 
   /**
-   * Constructor
+   * Default constructor (to use rest.ensembl.org)
    */
   public EnsemblCds()
   {
     super();
   }
 
+  /**
+   * Constructor given the target domain to fetch data from
+   * 
+   * @param d
+   */
+  public EnsemblCds(String d)
+  {
+    super(d);
+  }
+
   @Override
   public String getDbName()
   {
@@ -48,8 +73,8 @@ public class EnsemblCds extends EnsemblSeqProxy
   @Override
   protected boolean retainFeature(SequenceFeature sf, String accessionId)
   {
-    if (SequenceOntology.getInstance().isA(sf.getType(),
-            SequenceOntology.CDS))
+    if (SequenceOntologyFactory.getInstance().isA(sf.getType(),
+            SequenceOntologyI.CDS))
     {
       return false;
     }
@@ -64,8 +89,8 @@ public class EnsemblCds extends EnsemblSeqProxy
   @Override
   protected boolean identifiesSequence(SequenceFeature sf, String accId)
   {
-    if (SequenceOntology.getInstance().isA(sf.getType(),
-            SequenceOntology.CDS))
+    if (SequenceOntologyFactory.getInstance().isA(sf.getType(),
+            SequenceOntologyI.CDS))
     {
       String parentFeature = (String) sf.getValue(PARENT);
       if (("transcript:" + accId).equals(parentFeature))
@@ -76,4 +101,18 @@ public class EnsemblCds extends EnsemblSeqProxy
     return false;
   }
 
+  /**
+   * Overrides this method to trivially return a range which is the whole of the
+   * nucleotide sequence. This is both faster than scanning for CDS features,
+   * and also means we don't need to keep CDS features on CDS sequence (where
+   * they are redundant information).
+   */
+  protected List<int[]> getCdsRanges(SequenceI dnaSeq)
+  {
+    int len = dnaSeq.getLength();
+    List<int[]> ranges = new ArrayList<int[]>();
+    ranges.add(new int[] { 1, len });
+    return ranges;
+  }
+
 }