JAL-2189 apply license

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

diff --git a/src/jalview/ext/ensembl/EnsemblCds.java b/src/jalview/ext/ensembl/EnsemblCds.java
index 22c0a06..8b2550d 100644 (file)
--- a/src/jalview/ext/ensembl/EnsemblCds.java
+++ b/src/jalview/ext/ensembl/EnsemblCds.java
@@ -1,11 +1,43 @@
+/*
+ * 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.datamodel.SequenceI;
-import jalview.io.gff.SequenceOntology;
+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
 {
   /*
@@ -17,13 +49,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()
   {
@@ -51,8 +93,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;
     }
@@ -67,8 +109,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))
@@ -85,12 +127,12 @@ public class EnsemblCds extends EnsemblSeqProxy
    * and also means we don't need to keep CDS features on CDS sequence (where
    * they are redundant information).
    */
-  @Override
-  protected int getCdsRanges(SequenceI dnaSeq, List<int[]> ranges)
+  protected List<int[]> getCdsRanges(SequenceI dnaSeq)
   {
     int len = dnaSeq.getLength();
+    List<int[]> ranges = new ArrayList<int[]>();
     ranges.add(new int[] { 1, len });
-    return len;
+    return ranges;
   }
 
 }