JAL-2480 clarify that findOverlaps excludes spanning contact features
[jalview.git] / src / jalview / datamodel / Sequence.java
index 27a4163..cdfde5c 100755 (executable)
@@ -44,10 +44,7 @@ import fr.orsay.lri.varna.models.rna.RNA;
 
 /**
  * 
- * Implements the SequenceI interface for a char[] based sequence object.
- * 
- * @author $author$
- * @version $Revision$
+ * Implements the SequenceI interface for a char[] based sequence object
  */
 public class Sequence extends ASequence implements SequenceI
 {
@@ -260,9 +257,8 @@ public class Sequence extends ASequence implements SequenceI
   protected void initSeqFrom(SequenceI seq,
           AlignmentAnnotation[] alAnnotation)
   {
-    char[] oseq = seq.getSequence();
-    initSeqAndName(seq.getName(), Arrays.copyOf(oseq, oseq.length),
-            seq.getStart(), seq.getEnd());
+    char[] oseq = seq.getSequence(); // returns a copy of the array
+    initSeqAndName(seq.getName(), oseq, seq.getStart(), seq.getEnd());
 
     description = seq.getDescription();
     if (seq != datasetSequence)
@@ -563,7 +559,9 @@ public class Sequence extends ASequence implements SequenceI
   @Override
   public char[] getSequence()
   {
-    return sequence;
+    // return sequence;
+    return sequence == null ? null : Arrays.copyOf(sequence,
+            sequence.length);
   }
 
   /*
@@ -682,11 +680,20 @@ public class Sequence extends ASequence implements SequenceI
 
     int j = start;
     int i = 0;
-    // Rely on end being at least as long as the length of the sequence.
+    int startColumn = 0;
+
+    /*
+     * traverse sequence from the start counting gaps; make a note of
+     * the column of the first residue to save in the cursor
+     */
     while ((i < sequence.length) && (j <= end) && (j <= pos))
     {
       if (!Comparison.isGap(sequence[i]))
       {
+        if (j == start)
+        {
+          startColumn = i;
+        }
         j++;
       }
       i++;
@@ -697,7 +704,7 @@ public class Sequence extends ASequence implements SequenceI
       return end + 1;
     }
 
-    updateCursor(pos, i);
+    updateCursor(pos, i, startColumn);
     return i;
   }
 
@@ -708,10 +715,22 @@ public class Sequence extends ASequence implements SequenceI
    *          (start..)
    * @param column
    *          (1..)
+   * @param startColumn
+   *          column position of the first sequence residue
    */
-  protected void updateCursor(int residuePos, int column)
+  protected void updateCursor(int residuePos, int column, int startColumn)
   {
-    cursor = new SequenceCursor(this, residuePos, column, this.changeCount);
+    /*
+     * preserve end residue column provided cursor was valid
+     */
+    int endColumn = isValidCursor(cursor) ? cursor.lastResidueColumn : 0;
+    if (residuePos == this.end)
+    {
+      endColumn = column;
+    }
+
+    cursor = new SequenceCursor(this, residuePos, column, startColumn,
+            endColumn, this.changeCount);
   }
 
   /**
@@ -741,8 +760,7 @@ public class Sequence extends ASequence implements SequenceI
     /*
      * move left or right to find pos from hint.position
      */
-    int col = curs.columnPosition - 1; // convert from base 1 to 0-based array
-                                       // index
+    int col = curs.columnPosition - 1; // convert from base 1 to base 0
     int newPos = curs.residuePosition;
     int delta = newPos > pos ? -1 : 1;
 
@@ -760,7 +778,7 @@ public class Sequence extends ASequence implements SequenceI
     }
 
     col++; // convert back to base 1
-    updateCursor(pos, col);
+    updateCursor(pos, col, curs.firstResidueColumn);
 
     return col;
   }
@@ -769,6 +787,53 @@ public class Sequence extends ASequence implements SequenceI
    * {@inheritDoc}
    */
   @Override
+  public Range findPositions(int fromColumn, int toColumn)
+  {
+    if (toColumn < fromColumn || fromColumn < 1)
+    {
+      return null;
+    }
+
+    /*
+     * find the first non-gapped position, if any
+     */
+    int firstPosition = 0;
+    int col = fromColumn - 1;
+    int length = sequence.length;
+    while (col < length && col < toColumn)
+    {
+      if (!Comparison.isGap(sequence[col]))
+      {
+        firstPosition = findPosition(col++);
+        break;
+      }
+      col++;
+    }
+
+    if (firstPosition == 0)
+    {
+      return null;
+    }
+
+    /*
+     * find the last non-gapped position
+     */
+    int lastPosition = firstPosition;
+    while (col < length && col < toColumn)
+    {
+      if (!Comparison.isGap(sequence[col++]))
+      {
+        lastPosition++;
+      }
+    }
+
+    return new Range(firstPosition, lastPosition);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
   public int findPosition(final int column)
   {
     /*
@@ -778,13 +843,19 @@ public class Sequence extends ASequence implements SequenceI
     {
       return findPosition(column + 1, cursor);
     }
-
+    
     // TODO recode this more naturally i.e. count residues only
     // as they are found, not 'in anticipation'
 
+    /*
+     * traverse the sequence counting gaps; note the column position
+     * of the first residue, to save in the cursor
+     */
+    int firstResidueColumn = 0;
     int lastPosFound = 0;
     int lastPosFoundColumn = 0;
     int seqlen = sequence.length;
+
     if (seqlen > 0 && !Comparison.isGap(sequence[0]))
     {
       lastPosFound = start;
@@ -800,6 +871,10 @@ public class Sequence extends ASequence implements SequenceI
       {
         lastPosFound = pos;
         lastPosFoundColumn = j;
+        if (pos == this.start)
+        {
+          firstResidueColumn = j;
+        }
         pos++;
       }
       j++;
@@ -808,6 +883,10 @@ public class Sequence extends ASequence implements SequenceI
     {
       lastPosFound = pos;
       lastPosFoundColumn = j;
+      if (pos == this.start)
+      {
+        firstResidueColumn = j;
+      }
     }
 
     /*
@@ -816,7 +895,8 @@ public class Sequence extends ASequence implements SequenceI
      */
     if (lastPosFound != 0)
     {
-      updateCursor(lastPosFound, lastPosFoundColumn + 1);
+      updateCursor(lastPosFound, lastPosFoundColumn + 1,
+              firstResidueColumn + 1);
     }
 
     return pos;
@@ -876,9 +956,31 @@ public class Sequence extends ASequence implements SequenceI
       return curs.residuePosition; // easy case :-)
     }
 
+    if (curs.lastResidueColumn > 0 && curs.lastResidueColumn < col)
+    {
+      /*
+       * sequence lies entirely to the left of col
+       * - return last residue + 1
+       */
+      return end + 1;
+    }
+
+    if (curs.firstResidueColumn > 0 && curs.firstResidueColumn > col)
+    {
+      /*
+       * sequence lies entirely to the right of col
+       * - return first residue
+       */
+      return start;
+    }
+
+    // todo could choose closest to col out of column,
+    // firstColumnPosition, lastColumnPosition as a start point
+
     /*
      * move left or right to find pos from cursor position
      */
+    int firstResidueColumn = curs.firstResidueColumn;
     int column = curs.columnPosition - 1; // to base 0
     int newPos = curs.residuePosition;
     int delta = curs.columnPosition > col ? -1 : 1;
@@ -899,12 +1001,17 @@ public class Sequence extends ASequence implements SequenceI
         newPos += delta;
         lastFoundPosition = newPos;
         lastFoundPositionColumn = column + 1;
+        if (lastFoundPosition == this.start)
+        {
+          firstResidueColumn = column + 1;
+        }
       }
     }
 
     if (cursor == null || lastFoundPosition != cursor.residuePosition)
     {
-      updateCursor(lastFoundPosition, lastFoundPositionColumn);
+      updateCursor(lastFoundPosition, lastFoundPositionColumn,
+              firstResidueColumn);
     }
 
     /*
@@ -1051,9 +1158,9 @@ public class Sequence extends ASequence implements SequenceI
     // the very large sequence case
     int eindex = -1, sindex = -1;
     boolean ecalc = false, scalc = false;
-    for (int s = i; s < j; s++)
+    for (int s = i; s < j && s < sequence.length; s++)
     {
-      if (jalview.schemes.ResidueProperties.aaIndex[sequence[s]] != 23)
+      if (!Comparison.isGap(sequence[s]))
       {
         if (createNewDs)
         {
@@ -1335,7 +1442,7 @@ public class Sequence extends ASequence implements SequenceI
 
   private boolean _isNa;
 
-  private long _seqhash = 0;
+  private int _seqhash = 0;
 
   /**
    * Answers false if the sequence is more than 85% nucleotide (ACGTU), else
@@ -1719,7 +1826,7 @@ public class Sequence extends ASequence implements SequenceI
     /*
      * if the start or end column is gapped, startPos or endPos may be to the 
      * left or right, and we may have included adjacent or enclosing features;
-     * remove any that are not enclosing, non-contact features
+     * remove any that are not enclosing features
      */
     if (endPos > this.end || Comparison.isGap(sequence[fromColumn - 1])
             || Comparison.isGap(sequence[toColumn - 1]))
@@ -1730,18 +1837,8 @@ public class Sequence extends ASequence implements SequenceI
         SequenceFeature sf = it.next();
         int featureStartColumn = findIndex(sf.getBegin());
         int featureEndColumn = findIndex(sf.getEnd());
-        boolean noOverlap = featureStartColumn > toColumn
-                        || featureEndColumn < fromColumn;
-
-        /*
-         * reject an 'enclosing' feature if it is actually a contact feature
-         */
-        if (sf.isContactFeature() && featureStartColumn < fromColumn
-                && featureEndColumn > toColumn)
-        {
-          noOverlap = true;
-        }
-        if (noOverlap)
+        if (featureStartColumn > toColumn
+                        || featureEndColumn < fromColumn)
         {
           it.remove();
         }
@@ -1760,4 +1857,34 @@ public class Sequence extends ASequence implements SequenceI
   {
     changeCount++;
   }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public int replace(char c1, char c2)
+  {
+    if (c1 == c2)
+    {
+      return 0;
+    }
+    int count = 0;
+    synchronized (sequence)
+    {
+      for (int c = 0; c < sequence.length; c++)
+      {
+        if (sequence[c] == c1)
+        {
+          sequence[c] = c2;
+          count++;
+        }
+      }
+    }
+    if (count > 0)
+    {
+      sequenceChanged();
+    }
+
+    return count;
+  }
 }