removing cyclic call
[jalview.git] / src / jalview / datamodel / Sequence.java
index 441d8d0..6e9e1cd 100755 (executable)
 package jalview.datamodel;
 
 import jalview.analysis.AlignSeq;
-import jalview.api.DBRefEntryI;
 import jalview.datamodel.features.SequenceFeatures;
 import jalview.datamodel.features.SequenceFeaturesI;
 import jalview.util.Comparison;
 import jalview.util.DBRefUtils;
 import jalview.util.MapList;
 import jalview.util.StringUtils;
+import jalview.ws.params.InvalidArgumentException;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.BitSet;
 import java.util.Collections;
 import java.util.Enumeration;
+import java.util.Iterator;
 import java.util.List;
 import java.util.ListIterator;
 import java.util.Vector;
@@ -42,14 +43,28 @@ 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
 {
-  SequenceI datasetSequence;
+
+       /**
+        * A subclass that gives us access to modCount, which tracks 
+        * whether there have been any changes. We use this to update 
+        * @author hansonr
+        *
+        * @param <T>
+        */
+  @SuppressWarnings("serial")
+  protected class DBModList<T> extends ArrayList<DBRefEntry> {
+
+         protected int getModCount() {
+                 return modCount;
+         }
+         
+  }
+
+SequenceI datasetSequence;
 
   String name;
 
@@ -65,10 +80,17 @@ public class Sequence extends ASequence implements SequenceI
 
   String vamsasId;
 
-  DBRefEntry[] dbrefs;
+  private DBModList<DBRefEntry> dbrefs; // controlled acces
 
-  RNA rna;
+  /**
+   * a flag to let us know that elements have changed in dbrefs
+   * 
+   * @author Bob Hanson
+   */
+  private int refModCount = 0;
 
+  RNA rna;
+  
   /**
    * This annotation is displayed below the alignment but the positions are tied
    * to the residues of this sequence
@@ -286,12 +308,12 @@ public class Sequence extends ASequence implements SequenceI
      */
     if (datasetSequence == null)
     {
-      if (seq.getDBRefs() != null)
+      List<DBRefEntry> dbr = seq.getDBRefs();
+      if (dbr != null)
       {
-        DBRefEntry[] dbr = seq.getDBRefs();
-        for (int i = 0; i < dbr.length; i++)
+        for (int i = 0, n = dbr.size(); i < n; i++)
         {
-          addDBRef(new DBRefEntry(dbr[i]));
+          addDBRef(new DBRefEntry(dbr.get(i)));
         }
       }
 
@@ -408,7 +430,7 @@ public class Sequence extends ASequence implements SequenceI
   {
     if (pdbIds == null)
     {
-      pdbIds = new Vector<PDBEntry>();
+      pdbIds = new Vector<>();
       pdbIds.add(entry);
       return true;
     }
@@ -444,7 +466,7 @@ public class Sequence extends ASequence implements SequenceI
   @Override
   public Vector<PDBEntry> getAllPDBEntries()
   {
-    return pdbIds == null ? new Vector<PDBEntry>() : pdbIds;
+    return pdbIds == null ? new Vector<>() : pdbIds;
   }
 
   /**
@@ -684,7 +706,7 @@ public class Sequence extends ASequence implements SequenceI
   @Override
   public GeneLociI getGeneLoci()
   {
-    DBRefEntry[] refs = getDBRefs();
+    List<DBRefEntry> refs = getDBRefs();
     if (refs != null)
     {
       for (final DBRefEntry ref : refs)
@@ -796,6 +818,7 @@ public class Sequence extends ASequence implements SequenceI
      * preserve end residue column provided cursor was valid
      */
     int endColumn = isValidCursor(cursor) ? cursor.lastColumnPosition : 0;
+
     if (residuePos == this.end)
     {
       endColumn = column;
@@ -814,7 +837,7 @@ public class Sequence extends ASequence implements SequenceI
    * @param curs
    * @return
    */
-  protected int findIndex(int pos, SequenceCursor curs)
+  protected int findIndex(final int pos, SequenceCursor curs)
   {
     if (!isValidCursor(curs))
     {
@@ -832,16 +855,20 @@ 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;
 
     while (newPos != pos)
     {
       col += delta; // shift one column left or right
-      if (col < 0 || col == sequence.length)
+      if (col < 0)
+      {
+        break;
+      }
+      if (col == sequence.length)
       {
+        col--; // return last column if we failed to reach pos
         break;
       }
       if (!Comparison.isGap(sequence[col]))
@@ -851,7 +878,14 @@ public class Sequence extends ASequence implements SequenceI
     }
 
     col++; // convert back to base 1
-    updateCursor(pos, col, curs.firstColumnPosition);
+
+    /*
+     * only update cursor if we found the target position
+     */
+    if (newPos == pos)
+    {
+      updateCursor(pos, col, curs.firstColumnPosition);
+    }
 
     return col;
   }
@@ -1128,6 +1162,27 @@ public class Sequence extends ASequence implements SequenceI
     return map;
   }
 
+  /**
+   * Build a bitset corresponding to sequence gaps
+   * 
+   * @return a BitSet where set values correspond to gaps in the sequence
+   */
+  @Override
+  public BitSet gapBitset()
+  {
+    BitSet gaps = new BitSet(sequence.length);
+    int j = 0;
+    while (j < sequence.length)
+    {
+      if (jalview.util.Comparison.isGap(sequence[j]))
+      {
+        gaps.set(j);
+      }
+      j++;
+    }
+    return gaps;
+  }
+
   @Override
   public int[] findPositionMap()
   {
@@ -1151,7 +1206,7 @@ public class Sequence extends ASequence implements SequenceI
   @Override
   public List<int[]> getInsertions()
   {
-    ArrayList<int[]> map = new ArrayList<int[]>();
+    ArrayList<int[]> map = new ArrayList<>();
     int lastj = -1, j = 0;
     int pos = start;
     int seqlen = sequence.length;
@@ -1229,12 +1284,13 @@ public class Sequence extends ASequence implements SequenceI
     boolean createNewDs = false;
     // TODO: take a (second look) at the dataset creation validation method for
     // the very large sequence case
+
     int startIndex = findIndex(start) - 1;
     int endIndex = findIndex(end) - 1;
     int startDeleteColumn = -1; // for dataset sequence deletions
     int deleteCount = 0;
 
-    for (int s = i; s < j; s++)
+    for (int s = i; s < j && s < sequence.length; s++)
     {
       if (Comparison.isGap(sequence[s]))
       {
@@ -1354,24 +1410,35 @@ public class Sequence extends ASequence implements SequenceI
     vamsasId = id;
   }
 
-  @Override
-  public void setDBRefs(DBRefEntry[] dbref)
+  @SuppressWarnings("deprecation")
+@Override
+  public void setDBRefs(List<DBRefEntry> newDBrefs) throws InvalidArgumentException
   {
     if (dbrefs == null && datasetSequence != null
             && this != datasetSequence)
     {
-      datasetSequence.setDBRefs(dbref);
+      datasetSequence.setDBRefs((DBModList<DBRefEntry>)newDBrefs);
       return;
     }
-    dbrefs = dbref;
-    if (dbrefs != null)
-    {
-      DBRefUtils.ensurePrimaries(this);
-    }
+    if (newDBrefs != null && !(newDBrefs instanceof DBModList<?>))
+       throw new InvalidArgumentException("DBrefs must have DBModList class");
+
+    dbrefs = (DBModList<DBRefEntry>)newDBrefs;
+    refModCount = 0;
+  }
+
+  @Override
+  public void getDBRefsFrom(SequenceI seq) {
+         try {
+               setDBRefs(seq.getDBRefs());
+       } catch (InvalidArgumentException e) {
+               // TODO Auto-generated catch block
+               e.printStackTrace();
+       }
   }
 
   @Override
-  public DBRefEntry[] getDBRefs()
+  public List<DBRefEntry> getDBRefs()
   {
     if (dbrefs == null && datasetSequence != null
             && this != datasetSequence)
@@ -1381,6 +1448,7 @@ public class Sequence extends ASequence implements SequenceI
     return dbrefs;
   }
 
+
   @Override
   public void addDBRef(DBRefEntry entry)
   {
@@ -1392,12 +1460,12 @@ public class Sequence extends ASequence implements SequenceI
 
     if (dbrefs == null)
     {
-      dbrefs = new DBRefEntry[0];
+      dbrefs = new DBModList<DBRefEntry>();    
     }
 
-    for (DBRefEntryI dbr : dbrefs)
+    for (int ib = 0, nb= dbrefs.size(); ib < nb; ib++)
     {
-      if (dbr.updateFrom(entry))
+      if (dbrefs.get(ib).updateFrom(entry))
       {
         /*
          * found a dbref that either matched, or could be
@@ -1407,18 +1475,20 @@ public class Sequence extends ASequence implements SequenceI
       }
     }
 
-    /*
-     * extend the array to make room for one more
-     */
-    // TODO use an ArrayList instead
-    int j = dbrefs.length;
-    DBRefEntry[] temp = new DBRefEntry[j + 1];
-    System.arraycopy(dbrefs, 0, temp, 0, j);
-    temp[temp.length - 1] = entry;
-
-    dbrefs = temp;
 
-    DBRefUtils.ensurePrimaries(this);
+//    ///  BH OUCH!
+//    /*
+//     * extend the array to make room for one more
+//     */
+//    // TODO use an ArrayList instead
+//    int j = dbrefs.length;
+//    List<DBRefEntry> temp = new DBRefEntry[j + 1];
+//    System.arraycopy(dbrefs, 0, temp, 0, j);
+//    temp[temp.length - 1] = entry;
+//
+//    dbrefs = temp;
+    
+    dbrefs.add(entry);
   }
 
   @Override
@@ -1462,7 +1532,7 @@ public class Sequence extends ASequence implements SequenceI
   {
     if (this.annotation == null)
     {
-      this.annotation = new Vector<AlignmentAnnotation>();
+      this.annotation = new Vector<>();
     }
     if (!this.annotation.contains(annotation))
     {
@@ -1531,6 +1601,8 @@ public class Sequence extends ASequence implements SequenceI
 
   private int _seqhash = 0;
 
+private List<DBRefEntry> primaryRefs;
+
   /**
    * Answers false if the sequence is more than 85% nucleotide (ACGTU), else
    * true
@@ -1629,7 +1701,7 @@ public class Sequence extends ASequence implements SequenceI
       return null;
     }
 
-    Vector<AlignmentAnnotation> subset = new Vector<AlignmentAnnotation>();
+    Vector<AlignmentAnnotation> subset = new Vector<>();
     Enumeration<AlignmentAnnotation> e = annotation.elements();
     while (e.hasMoreElements())
     {
@@ -1662,13 +1734,14 @@ public class Sequence extends ASequence implements SequenceI
       // TODO: could merge DBRefs
       return datasetSequence.updatePDBIds();
     }
-    if (dbrefs == null || dbrefs.length == 0)
+    if (dbrefs == null || dbrefs.size() == 0)
     {
       return false;
     }
     boolean added = false;
-    for (DBRefEntry dbr : dbrefs)
+    for (int ib = 0, nb = dbrefs.size(); ib < nb; ib++)
     {
+      DBRefEntry dbr = dbrefs.get(ib);
       if (DBRefSource.PDB.equals(dbr.getSource()))
       {
         /*
@@ -1727,12 +1800,12 @@ public class Sequence extends ASequence implements SequenceI
       }
     }
     // transfer database references
-    DBRefEntry[] entryRefs = entry.getDBRefs();
+    List<DBRefEntry> entryRefs = entry.getDBRefs();
     if (entryRefs != null)
     {
-      for (int r = 0; r < entryRefs.length; r++)
+      for (int r = 0, n = entryRefs.size(); r < n; r++)
       {
-        DBRefEntry newref = new DBRefEntry(entryRefs[r]);
+        DBRefEntry newref = new DBRefEntry(entryRefs.get(r));
         if (newref.getMap() != null && mp != null)
         {
           // remap ref using our local mapping
@@ -1763,7 +1836,7 @@ public class Sequence extends ASequence implements SequenceI
   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
           String label)
   {
-    List<AlignmentAnnotation> result = new ArrayList<AlignmentAnnotation>();
+    List<AlignmentAnnotation> result = new ArrayList<>();
     if (this.annotation != null)
     {
       for (AlignmentAnnotation ann : annotation)
@@ -1806,6 +1879,8 @@ public class Sequence extends ASequence implements SequenceI
     return null;
   }
 
+  private List<DBRefEntry> tmpList;
+  
   @Override
   public List<DBRefEntry> getPrimaryDBRefs()
   {
@@ -1813,16 +1888,24 @@ public class Sequence extends ASequence implements SequenceI
     {
       return datasetSequence.getPrimaryDBRefs();
     }
-    if (dbrefs == null || dbrefs.length == 0)
+    if (dbrefs == null || dbrefs.size() == 0)
     {
       return Collections.emptyList();
     }
     synchronized (dbrefs)
     {
-      List<DBRefEntry> primaries = new ArrayList<DBRefEntry>();
-      DBRefEntry[] tmp = new DBRefEntry[1];
-      for (DBRefEntry ref : dbrefs)
+      if (refModCount == dbrefs.getModCount() && primaryRefs != null)
+         return primaryRefs; // no changes
+      refModCount = dbrefs.getModCount(); 
+      List<DBRefEntry> primaries = (primaryRefs == null ? (primaryRefs = new ArrayList<>()) : primaryRefs);
+      primaries.clear();
+      if (tmpList == null) {
+         tmpList = new ArrayList<>();
+         tmpList.add(null); // for replacement 
+      }
+      for (int i = 0, n = dbrefs.size(); i < n; i++)
       {
+       DBRefEntry ref = dbrefs.get(i);
         if (!ref.isPrimaryCandidate())
         {
           continue;
@@ -1837,8 +1920,7 @@ public class Sequence extends ASequence implements SequenceI
           }
         }
         // whilst it looks like it is a primary ref, we also sanity check type
-        if (DBRefUtils.getCanonicalName(DBRefSource.PDB)
-                .equals(DBRefUtils.getCanonicalName(ref.getSource())))
+        if (DBRefSource.PDB_CANONICAL_NAME.equals(ref.getCanonicalSourceName()))
         {
           // PDB dbrefs imply there should be a PDBEntry associated
           // TODO: tighten PDB dbrefs
@@ -1847,21 +1929,23 @@ public class Sequence extends ASequence implements SequenceI
           // handle on the PDBEntry, and a real mapping between sequence and
           // extracted sequence from PDB file
           PDBEntry pdbentry = getPDBEntry(ref.getAccessionId());
-          if (pdbentry != null && pdbentry.getFile() != null)
+          if (pdbentry == null || pdbentry.getFile() == null)
           {
-            primaries.add(ref);
+            continue;
           }
-          continue;
-        }
-        // check standard protein or dna sources
-        tmp[0] = ref;
-        DBRefEntry[] res = DBRefUtils.selectDbRefs(!isProtein(), tmp);
-        if (res != null && res[0] == tmp[0])
-        {
-          primaries.add(ref);
-          continue;
-        }
+        } else {
+             // check standard protein or dna sources
+             tmpList.set(0, ref);
+             List<DBRefEntry> res = DBRefUtils.selectDbRefs(!isProtein(), tmpList);
+             if (res == null || res.get(0) != tmpList.get(0))
+             {
+               continue;
+             }
+           }
+        primaries.add(ref);
       }
+      
+      DBRefUtils.ensurePrimaries(this, primaries);
       return primaries;
     }
   }
@@ -1879,6 +1963,15 @@ public class Sequence extends ASequence implements SequenceI
 
     List<SequenceFeature> result = getFeatures().findFeatures(startPos,
             endPos, types);
+    if (datasetSequence != null)
+    {
+      result = datasetSequence.getFeatures().findFeatures(startPos, endPos,
+              types);
+    }
+    else
+    {
+      result = sequenceFeatureStore.findFeatures(startPos, endPos, types);
+    }
 
     /*
      * if end column is gapped, endPos may be to the right, 
@@ -1961,4 +2054,73 @@ public class Sequence extends ASequence implements SequenceI
 
     return count;
   }
+
+  @Override
+  public String getSequenceStringFromIterator(Iterator<int[]> it)
+  {
+    StringBuilder newSequence = new StringBuilder();
+    while (it.hasNext())
+    {
+      int[] block = it.next();
+      if (it.hasNext())
+      {
+        newSequence.append(getSequence(block[0], block[1] + 1));
+      }
+      else
+      {
+        newSequence.append(getSequence(block[0], block[1]));
+      }
+    }
+
+    return newSequence.toString();
+  }
+
+  @Override
+  public int firstResidueOutsideIterator(Iterator<int[]> regions)
+  {
+    int start = 0;
+
+    if (!regions.hasNext())
+    {
+      return findIndex(getStart()) - 1;
+    }
+
+    // Simply walk along the sequence whilst watching for region
+    // boundaries
+    int hideStart = getLength();
+    int hideEnd = -1;
+    boolean foundStart = false;
+
+    // step through the non-gapped positions of the sequence
+    for (int i = getStart(); i <= getEnd() && (!foundStart); i++)
+    {
+      // get alignment position of this residue in the sequence
+      int p = findIndex(i) - 1;
+
+      // update region start/end
+      while (hideEnd < p && regions.hasNext())
+      {
+        int[] region = regions.next();
+        hideStart = region[0];
+        hideEnd = region[1];
+      }
+      if (hideEnd < p)
+      {
+        hideStart = getLength();
+      }
+      // update boundary for sequence
+      if (p < hideStart)
+      {
+        start = p;
+        foundStart = true;
+      }
+    }
+
+    if (foundStart)
+    {
+      return start;
+    }
+    // otherwise, sequence was completely hidden
+    return 0;
+  }
 }