JAL-1264 further refactoring and tests
[jalview.git] / src / jalview / datamodel / Sequence.java
index aa27d25..68bf8f2 100755 (executable)
@@ -1,27 +1,34 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 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.
- * 
+ * 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/>.
+ * 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.datamodel;
 
 import jalview.analysis.AlignSeq;
 
+import java.util.ArrayList;
 import java.util.Enumeration;
+import java.util.List;
 import java.util.Vector;
 
+import fr.orsay.lri.varna.models.rna.RNA;
+
 /**
  * 
  * Implements the SequenceI interface for a char[] based sequence object.
@@ -49,14 +56,18 @@ public class Sequence implements SequenceI
 
   DBRefEntry[] dbrefs;
 
+  RNA rna;
+
   /**
    * This annotation is displayed below the alignment but the positions are tied
    * to the residues of this sequence
+   *
+   * TODO: change to List<>
    */
-  Vector annotation;
-  
+  Vector<AlignmentAnnotation> annotation;
+
   /**
-   * The index of the sequence in a MSA 
+   * The index of the sequence in a MSA
    */
   int index = -1;
 
@@ -122,7 +133,8 @@ public class Sequence implements SequenceI
 
   void checkValidRange()
   {
-    // Note: JAL-774 : http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
+    // Note: JAL-774 :
+    // http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
     {
       int endRes = 0;
       for (int j = 0; j < sequence.length; j++)
@@ -137,7 +149,8 @@ public class Sequence implements SequenceI
         endRes += start - 1;
       }
 
-      if (end<endRes) { 
+      if (end < endRes)
+      {
         end = endRes;
       }
     }
@@ -480,7 +493,9 @@ public class Sequence implements SequenceI
   public char[] getSequence(int start, int end)
   {
     if (start < 0)
+    {
       start = 0;
+    }
     // JBPNote - left to user to pad the result here (TODO:Decide on this
     // policy)
     if (start >= sequence.length)
@@ -577,13 +592,10 @@ public class Sequence implements SequenceI
     return this.description;
   }
 
-  /**
-   * Return the alignment position for a sequence position
-   * 
-   * @param pos
-   *          lying from start to end
+  /*
+   * (non-Javadoc)
    * 
-   * @return aligned position of residue pos
+   * @see jalview.datamodel.SequenceI#findIndex(int)
    */
   public int findIndex(int pos)
   {
@@ -708,6 +720,7 @@ public class Sequence implements SequenceI
     {
       tmp = new char[i];
       System.arraycopy(sequence, 0, tmp, 0, i);
+      j = sequence.length;
     }
     else
     {
@@ -716,6 +729,9 @@ public class Sequence implements SequenceI
       System.arraycopy(sequence, j, tmp, i, sequence.length - j);
     }
     boolean createNewDs = false;
+    // TODO: take a look at the new dataset creation validation method below -
+    // this could become time comsuming for large sequences - consider making it
+    // more efficient
     for (int s = i; s < j; s++)
     {
       if (jalview.schemes.ResidueProperties.aaIndex[sequence[s]] != 23)
@@ -889,7 +905,7 @@ public class Sequence implements SequenceI
     AlignmentAnnotation[] ret = new AlignmentAnnotation[annotation.size()];
     for (int r = 0; r < ret.length; r++)
     {
-      ret[r] = (AlignmentAnnotation) annotation.elementAt(r);
+      ret[r] = annotation.elementAt(r);
     }
 
     return ret;
@@ -914,7 +930,9 @@ public class Sequence implements SequenceI
     {
       this.annotation.removeElement(annotation);
       if (this.annotation.size() == 0)
+      {
         this.annotation = null;
+      }
     }
   }
 
@@ -993,6 +1011,17 @@ public class Sequence implements SequenceI
       datasetSequence.setPDBId(getPDBId());
       setPDBId(null);
       datasetSequence.updatePDBIds();
+      if (annotation != null)
+      {
+        for (AlignmentAnnotation aa : annotation)
+        {
+          AlignmentAnnotation _aa = new AlignmentAnnotation(aa);
+          _aa.sequenceRef = datasetSequence;
+          _aa.adjustForAlignment(); // uses annotation's own record of
+                                   // sequence-column mapping
+          datasetSequence.addAlignmentAnnotation(_aa);
+        }
+      }
     }
     return datasetSequence;
   }
@@ -1015,7 +1044,9 @@ public class Sequence implements SequenceI
       for (int i = 0; i < annotations.length; i++)
       {
         if (annotations[i] != null)
+        {
           addAlignmentAnnotation(annotations[i]);
+        }
       }
     }
   }
@@ -1181,16 +1212,59 @@ public class Sequence implements SequenceI
   }
 
   /**
-   * @return The index (zero-based) on this sequence in the MSA. 
-   * It returns {@code -1} if this information is not available.
+   * @return The index (zero-based) on this sequence in the MSA. It returns
+   *         {@code -1} if this information is not available.
    */
-  public int getIndex() { return index; }
-  
+  public int getIndex()
+  {
+    return index;
+  }
+
+  /**
+   * Defines the position of this sequence in the MSA. Use the value {@code -1}
+   * if this information is undefined.
+   * 
+   * @param The
+   *          position for this sequence. This value is zero-based (zero for
+   *          this first sequence)
+   */
+  public void setIndex(int value)
+  {
+    index = value;
+  }
+
+  public void setRNA(RNA r)
+  {
+    rna = r;
+  }
+
+  public RNA getRNA()
+  {
+    return rna;
+  }
+
   /**
-   * Defines the position of this sequence in the MSA. 
-   * Use the value {@code -1} if this information is undefined.
+   * Returns a (possibly empty) list of any annotations that match on given
+   * calcId (source) and label (type). Null values do not match.
    * 
-   * @param The position for this sequence. This value is zero-based (zero for this first sequence)
+   * @param calcId
+   * @param label
    */
-  public void setIndex(int value) { index = value; }
+  @Override
+  public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
+          String label)
+  {
+    List<AlignmentAnnotation> result = new ArrayList<AlignmentAnnotation>();
+    if (this.annotation != null) {
+      for (AlignmentAnnotation ann : annotation) {
+        if (ann.calcId != null && ann.calcId.equals(calcId)
+                && ann.label != null && ann.label.equals(label))
+        {
+          result.add(ann);
+        }
+      }
+    }
+    return result;
+  }
+
 }