Merge branch 'features/JAL-2526sequenceCursor' into
[jalview.git] / src / jalview / datamodel / Sequence.java
index 6b460e2..8c53482 100755 (executable)
@@ -31,9 +31,11 @@ import jalview.util.StringUtils;
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.BitSet;
 import java.util.Collections;
 import java.util.Enumeration;
 import java.util.List;
+import java.util.ListIterator;
 import java.util.Vector;
 
 import com.stevesoft.pat.Regex;
@@ -543,6 +545,7 @@ public class Sequence extends ASequence implements SequenceI
   {
     this.sequence = seq.toCharArray();
     checkValidRange();
+    sequenceChanged();
   }
 
   @Override
@@ -663,19 +666,16 @@ public class Sequence extends ASequence implements SequenceI
     return this.description;
   }
 
-  /*
-   * (non-Javadoc)
-   * 
-   * @see jalview.datamodel.SequenceI#findIndex(int)
+  /**
+   * {@inheritDoc}
    */
   @Override
   public int findIndex(int pos)
   {
     /*
-     * use a valid nearby cursor if available
+     * use a valid, hopefully nearby, cursor if available
      */
-    if (cursor != null && cursor.sequence == this
-            && cursor.token == changeCount)
+    if (isValidCursor(cursor))
     {
       return findIndex(pos, cursor);
     }
@@ -692,20 +692,25 @@ public class Sequence extends ASequence implements SequenceI
       i++;
     }
 
-    if ((j == end) && (j < pos))
+    if (j == end && j < pos)
     {
       return end + 1;
     }
-    else
-    {
-      updateCursor(pos, i);
-      return i;
-    }
+
+    updateCursor(pos, i);
+    return i;
   }
 
+  /**
+   * Updates the cursor to the latest found residue and column position
+   * 
+   * @param residuePos
+   *          (start..)
+   * @param column
+   *          (1..)
+   */
   protected void updateCursor(int residuePos, int column)
   {
-    // TODO probably want to synchronize this on something
     cursor = new SequenceCursor(this, residuePos, column, this.changeCount);
   }
 
@@ -720,7 +725,7 @@ public class Sequence extends ASequence implements SequenceI
    */
   protected int findIndex(int pos, SequenceCursor curs)
   {
-    if (curs.sequence != this || curs.token != changeCount)
+    if (!isValidCursor(curs))
     {
       /*
        * wrong or invalidated cursor, compute de novo
@@ -760,40 +765,93 @@ public class Sequence extends ASequence implements SequenceI
     return col;
   }
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
-  public int findPosition(final int i)
+  public int findPosition(final int column)
   {
     /*
-     * use a valid nearby cursor if available
+     * use a valid, hopefully nearby, cursor if available
      */
-    if (cursor != null && cursor.sequence == this
-            && cursor.token == changeCount)
+    if (isValidCursor(cursor))
+    {
+      return findPosition(column + 1, cursor);
+    }
+
+    // TODO recode this more naturally i.e. count residues only
+    // as they are found, not 'in anticipation'
+
+    int lastPosFound = 0;
+    int lastPosFoundColumn = 0;
+    int seqlen = sequence.length;
+    if (seqlen > 0 && !Comparison.isGap(sequence[0]))
     {
-      return findPosition(i + 1, cursor);
+      lastPosFound = start;
+      lastPosFoundColumn = 0;
     }
 
     int j = 0;
     int pos = start;
-    int seqlen = sequence.length;
-    while ((j < i) && (j < seqlen))
+
+    while (j < column && j < seqlen)
     {
       if (!Comparison.isGap(sequence[j]))
       {
+        lastPosFound = pos;
+        lastPosFoundColumn = j;
         pos++;
       }
-
       j++;
     }
+    if (j < seqlen && !Comparison.isGap(sequence[j]))
+    {
+      lastPosFound = pos;
+      lastPosFoundColumn = j;
+    }
 
-    if (j == i && !Comparison.isGap(sequence[i]))
+    /*
+     * update the cursor to the last residue position found (if any)
+     * (converting column position to base 1)
+     */
+    if (lastPosFound != 0)
     {
-      updateCursor(pos, i + 1);
+      updateCursor(lastPosFound, lastPosFoundColumn + 1);
     }
 
     return pos;
   }
 
   /**
+   * Answers true if the given cursor is not null, is for this sequence object,
+   * and has a token value that matches this object's changeCount, else false.
+   * This allows us to ignore a cursor as 'stale' if the sequence has been
+   * modified since the cursor was created.
+   * 
+   * @param curs
+   * @return
+   */
+  protected boolean isValidCursor(SequenceCursor curs)
+  {
+    if (curs == null || curs.sequence != this || curs.token != changeCount)
+    {
+      return false;
+    }
+    /*
+     * sanity check against range
+     */
+    if (curs.columnPosition < 0 || curs.columnPosition >= sequence.length)
+    {
+      return false;
+    }
+    if (curs.residuePosition < start || curs.residuePosition > end)
+    {
+      return false;
+    }
+    return true;
+  }
+
+  /**
    * Answers the sequence position (start..) for the given aligned column
    * position (1..), given a hint of a cursor in the neighbourhood. The cursor
    * may lie left of, at, or to the right of the column position.
@@ -804,7 +862,7 @@ public class Sequence extends ASequence implements SequenceI
    */
   protected int findPosition(final int col, SequenceCursor curs)
   {
-    if (curs.sequence != this || curs.token != changeCount)
+    if (!isValidCursor(curs))
     {
       /*
        * wrong or invalidated cursor, compute de novo
@@ -814,6 +872,7 @@ public class Sequence extends ASequence implements SequenceI
 
     if (curs.columnPosition == col)
     {
+      cursor = curs; // in case this method becomes public
       return curs.residuePosition; // easy case :-)
     }
 
@@ -824,6 +883,8 @@ public class Sequence extends ASequence implements SequenceI
     int newPos = curs.residuePosition;
     int delta = curs.columnPosition > col ? -1 : 1;
     boolean gapped = false;
+    int lastFoundPosition = curs.residuePosition;
+    int lastFoundPositionColumn = curs.columnPosition;
 
     while (column != col - 1)
     {
@@ -836,183 +897,26 @@ public class Sequence extends ASequence implements SequenceI
       if (!gapped)
       {
         newPos += delta;
+        lastFoundPosition = newPos;
+        lastFoundPositionColumn = column + 1;
       }
     }
 
-    /*
-     * hack to give position to the right if on a gap
-     * pending resolution of JAL-2562
-     */
-    if (delta > 0 && gapped)
-    {
-      newPos++;
-    }
-
-    return newPos;
-  }
-
-  /**
-   * {@inheritDoc}
-   */
-  @Override
-  public Range findPositions(int fromCol, int toCol)
-  {
-    if (cursor != null && cursor.sequence == this
-            && cursor.token == changeCount)
-    {
-      return findPositions(fromCol, toCol, cursor);
-    }
-
-    /*
-     * count residues before fromCol
-     */
-    int j = 0;
-    int count = 0;
-    int seqlen = sequence.length;
-    while (j < fromCol && j < seqlen)
-    {
-      if (!Comparison.isGap(sequence[j]))
-      {
-        count++;
-      }
-      j++;
-    }
-
-    /*
-     * find first and last residues between fromCol and toCol
-     */
-    int firstPos = 0;
-    int lastPos = 0;
-    boolean foundFirst = false;
-    
-    while (j <= toCol && j < seqlen)
-    {
-      if (!Comparison.isGap(sequence[j]))
-      {
-        count++;
-        if (!foundFirst)
-        {
-          firstPos = count;
-          foundFirst = true;
-        }
-        lastPos = count;
-      }
-      j++;
-    }
-
-    if (firstPos == 0)
+    if (cursor == null || lastFoundPosition != cursor.residuePosition)
     {
-      /*
-       * no residues in this range
-       */
-      return null;
+      updateCursor(lastFoundPosition, lastFoundPositionColumn);
     }
 
     /*
-     * adjust for sequence start coordinate
-     */
-    firstPos += start - 1;
-    lastPos += start - 1;
-
-    return new Range(firstPos, lastPos);
-  }
-
-  /**
-   * Returns the range of sequence positions included in the given alignment
-   * position range. If no positions are included (the range is entirely gaps),
-   * then returns null. The cursor parameter may provide a starting position in
-   * the neighbourhood of the search (which may be left of, right of, or
-   * overlapping the search region).
-   * 
-   * @param fromCol
-   *          start column of region (0..)
-   * @param toCol
-   *          end column of region (0..)
-   * @param curs
-   * @return
-   */
-  protected Range findPositions(int fromCol, int toCol, SequenceCursor curs)
-  {
-    if (curs.sequence != this || curs.token != changeCount)
-    {
-      /*
-       * wrong or invalidated cursor, compute de novo
-       */
-      return findPositions(fromCol, toCol);
-    }
-
-    /*
-     * keep this simple...first step from cursor to fromCol...
-     */
-    final int seqlen = sequence.length;
-    int resNo = curs.residuePosition;
-    int col = curs.columnPosition - 1; // from base 1 to base 0
-    if (col != fromCol)
-    {
-      int delta = col > fromCol ? -1 : 1;
-      while (col != fromCol && col >= 0 && col < seqlen)
-      {
-        if (!Comparison.isGap(sequence[col]))
-        {
-          resNo += delta;
-        }
-        col += delta;
-      }
-    }
-
-    if (col < fromCol || col == seqlen)
-    {
-      /*
-       * sequence lies to the left of the target region
-       */
-      return null;
-    }
-
-    /*
-     * resNo is now the residue at fromCol (if not gapped), else the one
-     * before it (if delta == 1), else the one after (if delta == -1);
-     * we want the residue before fromCol
-     */
-    if (!Comparison.isGap(sequence[fromCol]))
-    {
-      resNo--;
-    }
-    else if (curs.columnPosition > fromCol)
-    {
-      resNo -= 2;
-    }
-
-    /*
-     * now first and last residues between fromCol and toCol
+     * hack to give position to the right if on a gap
+     * or beyond the length of the sequence (see JAL-2562)
      */
-    int firstPos = 0;
-    int lastPos = 0;
-    boolean foundFirst = false;
-
-    while (col <= toCol && col < seqlen)
-    {
-      if (!Comparison.isGap(sequence[col]))
-      {
-        resNo++;
-        if (!foundFirst)
-        {
-          firstPos = resNo;
-          foundFirst = true;
-        }
-        lastPos = resNo;
-      }
-      col++;
-    }
-
-    if (firstPos == 0)
+    if (delta > 0 && (gapped || column >= sequence.length))
     {
-      /*
-       * no residues in this range
-       */
-      return null;
+      newPos++;
     }
 
-    return new Range(firstPos, lastPos);
+    return newPos;
   }
 
   /**
@@ -1099,6 +1003,40 @@ public class Sequence extends ASequence implements SequenceI
   }
 
   @Override
+  public BitSet getInsertionsAsBits()
+  {
+    BitSet map = new BitSet();
+    int lastj = -1, j = 0;
+    int pos = start;
+    int seqlen = sequence.length;
+    while ((j < seqlen))
+    {
+      if (jalview.util.Comparison.isGap(sequence[j]))
+      {
+        if (lastj == -1)
+        {
+          lastj = j;
+        }
+      }
+      else
+      {
+        if (lastj != -1)
+        {
+          map.set(lastj, j);
+          lastj = -1;
+        }
+      }
+      j++;
+    }
+    if (lastj != -1)
+    {
+      map.set(lastj, j);
+      lastj = -1;
+    }
+    return map;
+  }
+
+  @Override
   public void deleteChars(int i, int j)
   {
     int newstart = start, newend = end;
@@ -1171,6 +1109,7 @@ public class Sequence extends ASequence implements SequenceI
     start = newstart;
     end = newend;
     sequence = tmp;
+    sequenceChanged();
   }
 
   @Override
@@ -1201,6 +1140,7 @@ public class Sequence extends ASequence implements SequenceI
     }
 
     sequence = tmp;
+    sequenceChanged();
   }
 
   @Override
@@ -1759,14 +1699,56 @@ public class Sequence extends ASequence implements SequenceI
    * {@inheritDoc}
    */
   @Override
-  public List<SequenceFeature> findFeatures(int from, int to,
+  public List<SequenceFeature> findFeatures(int fromColumn, int toColumn,
           String... types)
   {
+    int startPos = findPosition(fromColumn - 1); // convert base 1 to base 0
+    int endPos = findPosition(toColumn - 1);
+
+    List<SequenceFeature> result = new ArrayList<>();
     if (datasetSequence != null)
     {
-      return datasetSequence.findFeatures(from, to, types);
+      result = datasetSequence.getFeatures().findFeatures(startPos, endPos,
+              types);
+    }
+    else
+    {
+      result = sequenceFeatureStore.findFeatures(startPos, endPos, types);
+    }
+
+    /*
+     * 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
+     */
+    if (endPos > this.end || Comparison.isGap(sequence[fromColumn - 1])
+            || Comparison.isGap(sequence[toColumn - 1]))
+    {
+      ListIterator<SequenceFeature> it = result.listIterator();
+      while (it.hasNext())
+      {
+        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)
+        {
+          it.remove();
+        }
+      }
     }
-    return sequenceFeatureStore.findFeatures(from, to, types);
+
+    return result;
   }
 
   /**