Merge branch 'develop' into trialMerge
[jalview.git] / src / jalview / datamodel / Sequence.java
index 80310c0..8c3e538 100755 (executable)
@@ -21,7 +21,6 @@
 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;
@@ -47,33 +46,57 @@ import fr.orsay.lri.varna.models.rna.RNA;
  */
 public class Sequence extends ASequence implements SequenceI
 {
-  SequenceI datasetSequence;
 
-  String name;
+       /**
+        * 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")
+  public class DBModList<T> extends ArrayList<DBRefEntry> {
+
+         protected int getModCount() {
+                 return modCount;
+         }
+         
+  }
+
+SequenceI datasetSequence;
+
+  private String name;
 
   private char[] sequence;
 
-  String description;
+  private String description;
 
-  int start;
+  private int start;
 
-  int end;
+  private int end;
 
-  Vector<PDBEntry> pdbIds;
+  private Vector<PDBEntry> pdbIds;
 
-  String vamsasId;
+  private String vamsasId;
 
-  DBRefEntry[] dbrefs;
+  private DBModList<DBRefEntry> dbrefs; // controlled access
 
-  RNA rna;
+  /**
+   * a flag to let us know that elements have changed in dbrefs
+   * 
+   * @author Bob Hanson
+   */
+  private int refModCount = 0;
 
+  private 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<AlignmentAnnotation> annotation;
+  private Vector<AlignmentAnnotation> annotation;
 
   private SequenceFeaturesI sequenceFeatureStore;
 
@@ -284,12 +307,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)));
         }
       }
 
@@ -682,7 +705,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)
@@ -700,6 +723,9 @@ public class Sequence extends ASequence implements SequenceI
             @Override
             public String getAssemblyId()
             {
+               // DEV NOTE: DBRefEntry is reused here to hold chromosomal locus of a gene sequence. 
+               // source=species, version=assemblyId, accession=chromosome, map = positions.
+               
               return ref.getVersion();
             }
 
@@ -1386,24 +1412,22 @@ public class Sequence extends ASequence implements SequenceI
     vamsasId = id;
   }
 
+  @Deprecated
   @Override
-  public void setDBRefs(DBRefEntry[] dbref)
+  public void setDBRefs(DBModList<DBRefEntry> newDBrefs)
   {
     if (dbrefs == null && datasetSequence != null
             && this != datasetSequence)
     {
-      datasetSequence.setDBRefs(dbref);
+      datasetSequence.setDBRefs(newDBrefs);
       return;
     }
-    dbrefs = dbref;
-    if (dbrefs != null)
-    {
-      DBRefUtils.ensurePrimaries(this);
-    }
+    dbrefs = newDBrefs;
+    refModCount = 0;
   }
 
   @Override
-  public DBRefEntry[] getDBRefs()
+  public DBModList<DBRefEntry> getDBRefs()
   {
     if (dbrefs == null && datasetSequence != null
             && this != datasetSequence)
@@ -1413,6 +1437,7 @@ public class Sequence extends ASequence implements SequenceI
     return dbrefs;
   }
 
+
   @Override
   public void addDBRef(DBRefEntry entry)
   {
@@ -1424,12 +1449,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
@@ -1439,18 +1464,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
@@ -1563,6 +1590,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
@@ -1694,13 +1723,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()))
       {
         /*
@@ -1759,12 +1789,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
@@ -1838,6 +1868,8 @@ public class Sequence extends ASequence implements SequenceI
     return null;
   }
 
+  private List<DBRefEntry> tmpList;
+  
   @Override
   public List<DBRefEntry> getPrimaryDBRefs()
   {
@@ -1845,16 +1877,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[] 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;
@@ -1869,8 +1909,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
@@ -1879,21 +1918,24 @@ 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);
       }
+      
+      // version must be not null, as otherwise it will not be a candidate, above
+      DBRefUtils.ensurePrimaries(this, primaries);
       return primaries;
     }
   }