JAL-2694 StructureSelectionManager.getMapping takes a list of Chain IDs per sequence...
[jalview.git] / src / jalview / structures / models / AAStructureBindingModel.java
index d9e8c95..b9dc58d 100644 (file)
@@ -25,7 +25,7 @@ import jalview.api.SequenceRenderer;
 import jalview.api.StructureSelectionManagerProvider;
 import jalview.api.structures.JalviewStructureDisplayI;
 import jalview.datamodel.AlignmentI;
-import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
 import jalview.io.DataSourceType;
@@ -53,9 +53,9 @@ import java.util.List;
  * @author gmcarstairs
  *
  */
-public abstract class AAStructureBindingModel extends
-        SequenceStructureBindingModel implements StructureListener,
-        StructureSelectionManagerProvider
+public abstract class AAStructureBindingModel
+        extends SequenceStructureBindingModel
+        implements StructureListener, StructureSelectionManagerProvider
 {
 
   private StructureSelectionManager ssm;
@@ -72,9 +72,9 @@ public abstract class AAStructureBindingModel extends
   private SequenceI[][] sequence;
 
   /*
-   * array of target chains for sequences - tied to pdbentry and sequence[]
+   * array of list of target chains for sequences - tied to pdbentry and sequence[]
    */
-  private String[][] chains;
+  private List<String>[][] chains;
 
   /*
    * datasource protocol for access to PDBEntrylatest
@@ -142,7 +142,6 @@ public abstract class AAStructureBindingModel extends
    * @param ssm
    * @param pdbentry
    * @param sequenceIs
-   * @param chains
    * @param protocol
    */
   public AAStructureBindingModel(StructureSelectionManager ssm,
@@ -154,8 +153,64 @@ public abstract class AAStructureBindingModel extends
     this.nucleotide = Comparison.isNucleotide(sequenceIs);
     this.pdbEntry = pdbentry;
     this.protocol = protocol;
+    resolveChains();
   }
 
+  private boolean resolveChains()
+  {
+    /**
+     * final count of chain mappings discovered
+     */
+    int chainmaps = 0;
+    // JBPNote: JAL-2693 - this should be a list of chain mappings per
+    // [pdbentry][sequence]
+    List<String>[][] newchains = new List[pdbEntry.length][];
+    int pe = 0;
+    for (PDBEntry pdb : pdbEntry)
+    {
+      SequenceI[] seqsForPdb = sequence[pe];
+      if (seqsForPdb != null)
+      {
+        newchains[pe] = new List[seqsForPdb.length];
+        int se = 0;
+        for (SequenceI asq : seqsForPdb)
+        {
+          List<String> chain = (chains != null && chains[pe] != null)
+                  ? chains[pe][se]
+                  : null;
+          if (chain == null)
+          {
+            chain = new ArrayList<>();
+          }
+          newchains[pe][se] = chain;
+
+          SequenceI sq = (asq.getDatasetSequence() == null) ? asq
+                  : asq.getDatasetSequence();
+          if (sq.getAllPDBEntries() != null)
+          {
+            for (PDBEntry pdbentry : sq.getAllPDBEntries())
+            {
+              if (pdb.getFile() != null && pdbentry.getFile() != null
+                      && pdb.getFile().equals(pdbentry.getFile()))
+              {
+                String chaincode = pdbentry.getChainCode();
+                if (chaincode != null && chaincode.length() > 0)
+                {
+                  newchains[pe][se].add(chaincode);
+                  chainmaps++;
+                }
+              }
+            }
+          }
+          se++;
+        }
+        pe++;
+      }
+    }
+
+    chains = newchains;
+    return chainmaps > 0;
+  }
   public StructureSelectionManager getSsm()
   {
     return ssm;
@@ -208,7 +263,7 @@ public abstract class AAStructureBindingModel extends
     return sequence;
   }
 
-  public String[][] getChains()
+  public List<String>[][] getChains()
   {
     return chains;
   }
@@ -229,7 +284,7 @@ public abstract class AAStructureBindingModel extends
     this.sequence = sequence;
   }
 
-  protected void setChains(String[][] chains)
+  protected void setChains(List<String>[][] chains)
   {
     this.chains = chains;
   }
@@ -300,14 +355,14 @@ public abstract class AAStructureBindingModel extends
     {
       throw new Error(MessageManager.formatMessage(
               "error.implementation_error_no_pdbentry_from_index",
-              new Object[] { Integer.valueOf(pe).toString() }));
+              new Object[]
+              { Integer.valueOf(pe).toString() }));
     }
-    final String nullChain = "TheNullChain";
-    List<SequenceI> s = new ArrayList<SequenceI>();
-    List<String> c = new ArrayList<String>();
+    List<SequenceI> s = new ArrayList<>();
+    List<List<String>> c = new ArrayList<>();
     if (getChains() == null)
     {
-      setChains(new String[getPdbCount()][]);
+      setChains(new List[getPdbCount()][]);
     }
     if (getSequence()[pe] != null)
     {
@@ -322,14 +377,14 @@ public abstract class AAStructureBindingModel extends
           }
           else
           {
-            c.add(nullChain);
+            c.add(new ArrayList());
           }
         }
         else
         {
           if (tchain != null && tchain.length > 0)
           {
-            c.add(nullChain);
+            c.add(new ArrayList());
           }
         }
       }
@@ -341,7 +396,12 @@ public abstract class AAStructureBindingModel extends
         s.add(seq[i]);
         if (tchain != null && i < tchain.length)
         {
-          c.add(tchain[i] == null ? nullChain : tchain[i]);
+          List<String> clist = new ArrayList();
+          c.add(clist);
+          if (tchain[i] != null)
+          {
+            clist.add(tchain[i]);
+          }
         }
       }
     }
@@ -349,14 +409,7 @@ public abstract class AAStructureBindingModel extends
     getSequence()[pe] = tmp;
     if (c.size() > 0)
     {
-      String[] tch = c.toArray(new String[c.size()]);
-      for (int i = 0; i < tch.length; i++)
-      {
-        if (tch[i] == nullChain)
-        {
-          tch[i] = null;
-        }
-      }
+      List<String>[] tch = c.toArray(new List[c.size()]);
       getChains()[pe] = tch;
     }
     else
@@ -373,8 +426,8 @@ public abstract class AAStructureBindingModel extends
   public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe,
           SequenceI[][] seq, String[][] chns)
   {
-    List<PDBEntry> v = new ArrayList<PDBEntry>();
-    List<int[]> rtn = new ArrayList<int[]>();
+    List<PDBEntry> v = new ArrayList<>();
+    List<int[]> rtn = new ArrayList<>();
     for (int i = 0; i < getPdbCount(); i++)
     {
       v.add(getPdbEntry(i));
@@ -399,7 +452,7 @@ public abstract class AAStructureBindingModel extends
     {
       // expand the tied sequence[] and string[] arrays
       SequenceI[][] sqs = new SequenceI[getPdbCount()][];
-      String[][] sch = new String[getPdbCount()][];
+      List<String>[][] sch = new List[getPdbCount()][];
       System.arraycopy(getSequence(), 0, sqs, 0, getSequence().length);
       System.arraycopy(getChains(), 0, sch, 0, this.getChains().length);
       setSequence(sqs);
@@ -638,8 +691,8 @@ public abstract class AAStructureBindingModel extends
 
     if (waiting)
     {
-      System.err
-              .println("Timed out waiting for structure viewer to load file "
+      System.err.println(
+              "Timed out waiting for structure viewer to load file "
                       + notLoaded);
       return false;
     }
@@ -657,10 +710,8 @@ public abstract class AAStructureBindingModel extends
         {
           for (SequenceI s : seqs)
           {
-            if (s == seq
-                    || (s.getDatasetSequence() != null && s
-                            .getDatasetSequence() == seq
-                            .getDatasetSequence()))
+            if (s == seq || (s.getDatasetSequence() != null
+                    && s.getDatasetSequence() == seq.getDatasetSequence()))
             {
               return true;
             }
@@ -716,8 +767,8 @@ public abstract class AAStructureBindingModel extends
    *          an array of corresponding hidden columns for each alignment
    * @return
    */
-  public abstract String superposeStructures(AlignmentI[] alignments, int[] structureIndices,
-          ColumnSelection[] hiddenCols);
+  public abstract String superposeStructures(AlignmentI[] alignments,
+          int[] structureIndices, HiddenColumns[] hiddenCols);
 
   public abstract void setBackgroundColour(Color col);
 
@@ -732,7 +783,8 @@ public abstract class AAStructureBindingModel extends
    * 
    * @return
    */
-  public abstract SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment);
+  public abstract SequenceRenderer getSequenceRenderer(
+          AlignmentViewPanel alignment);
 
   protected abstract void colourBySequence(
           StructureMappingcommandSet[] colourBySequenceCommands);
@@ -757,9 +809,9 @@ public abstract class AAStructureBindingModel extends
       return;
     }
     String[] files = getStructureFiles();
-  
+
     SequenceRenderer sr = getSequenceRenderer(alignmentv);
-  
+
     StructureMappingcommandSet[] colourBySequenceCommands = getColourBySequenceCommands(
             files, sr, alignmentv);
     colourBySequence(colourBySequenceCommands);