X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FStructureViewer.java;h=fb37b7739c892c4774c2ce8c17d3f5a0ad014882;hb=aa885913f06fc3885c818370544f43474a14f402;hp=8ff4c708657280acf375b3801d3308a6294bfb45;hpb=2d3bf89e4c4a93d78af9772a78e94d5be7d15402;p=jalview.git

diff --git a/src/jalview/gui/StructureViewer.java b/src/jalview/gui/StructureViewer.java
index 8ff4c70..fb37b77 100644
--- a/src/jalview/gui/StructureViewer.java
+++ b/src/jalview/gui/StructureViewer.java
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -28,18 +28,25 @@ import jalview.datamodel.StructureViewerModel;
 import jalview.structure.StructureSelectionManager;
 
 import java.awt.Rectangle;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
 
 /**
- * proxy for handling structure viewers.
- * 
- * this allows new views to be created with the currently configured viewer, the
- * preferred viewer to be set/read and existing views created previously with a
- * particular viewer to be recovered
+ * A proxy for handling structure viewers, that orchestrates adding selected
+ * structures, associated with sequences in Jalview, to an existing viewer, or
+ * opening a new one. Currently supports either Jmol or Chimera as the structure
+ * viewer.
  * 
  * @author jprocter
  */
 public class StructureViewer
 {
+  private static final String UNKNOWN_VIEWER_TYPE = "Unknown structure viewer type ";
+
   StructureSelectionManager ssm;
 
   public enum ViewerType
@@ -47,6 +54,16 @@ public class StructureViewer
     JMOL, CHIMERA
   };
 
+  /**
+   * Constructor
+   * 
+   * @param structureSelectionManager
+   */
+  public StructureViewer(StructureSelectionManager structureSelectionManager)
+  {
+    ssm = structureSelectionManager;
+  }
+
   public ViewerType getViewerType()
   {
     String viewType = Cache.getDefault(Preferences.STRUCTURE_DISPLAY,
@@ -59,63 +76,177 @@ public class StructureViewer
     Cache.setProperty(Preferences.STRUCTURE_DISPLAY, type.name());
   }
 
-  public StructureViewer(StructureSelectionManager structureSelectionManager)
+  /**
+   * View multiple PDB entries, each with associated sequences
+   * 
+   * @param pdbs
+   * @param seqs
+   * @param ap
+   * @return
+   */
+  public JalviewStructureDisplayI viewStructures(PDBEntry[] pdbs,
+          SequenceI[] seqs, AlignmentPanel ap)
   {
-    ssm = structureSelectionManager;
-  }
+    JalviewStructureDisplayI viewer = onlyOnePdb(pdbs, seqs, ap);
+    if (viewer != null)
+    {
+      /*
+       * user added structure to an existing viewer - all done
+       */
+      return viewer;
+    }
 
-  public JalviewStructureDisplayI viewStructures(AlignmentPanel ap,
-          PDBEntry[] pr, SequenceI[][] collateForPDB)
-  {
-    return viewStructures(getViewerType(), ap, pr, collateForPDB);
-  }
+    ViewerType viewerType = getViewerType();
 
-  public JalviewStructureDisplayI viewStructures(ViewerType viewerType,
-          AlignmentPanel ap, PDBEntry[] pr, SequenceI[][] collateForPDB)
-  {
+    Map<PDBEntry, SequenceI[]> seqsForPdbs = getSequencesForPdbs(pdbs,
+            seqs);
+    PDBEntry[] pdbsForFile = seqsForPdbs.keySet().toArray(
+            new PDBEntry[seqsForPdbs.size()]);
+    SequenceI[][] theSeqs = seqsForPdbs.values().toArray(
+            new SequenceI[seqsForPdbs.size()][]);
     JalviewStructureDisplayI sview = null;
     if (viewerType.equals(ViewerType.JMOL))
     {
-      sview = new AppJmol(ap, pr, ap.av.collateForPDB(pr));
+      sview = new AppJmol(ap, pdbsForFile, theSeqs);
     }
     else if (viewerType.equals(ViewerType.CHIMERA))
     {
-      sview = new ChimeraViewFrame(ap, pr, ap.av.collateForPDB(pr));
+      sview = new ChimeraViewFrame(pdbsForFile, theSeqs, ap);
     }
     else
     {
-      Cache.log.error("Unknown structure viewer type "
-              + getViewerType().toString());
+      Cache.log.error(UNKNOWN_VIEWER_TYPE + getViewerType().toString());
     }
     return sview;
   }
 
-  public JalviewStructureDisplayI viewStructures(ViewerType viewerType,
-          AlignmentPanel ap, PDBEntry pr, SequenceI[] collateForPDB)
+  /**
+   * Converts the list of selected PDB entries (possibly including duplicates
+   * for multiple chains), and corresponding sequences, into a map of sequences
+   * for each distinct PDB file. Returns null if either argument is null, or
+   * their lengths do not match.
+   * 
+   * @param pdbs
+   * @param seqs
+   * @return
+   */
+  Map<PDBEntry, SequenceI[]> getSequencesForPdbs(PDBEntry[] pdbs,
+          SequenceI[] seqs)
   {
+    if (pdbs == null || seqs == null || pdbs.length != seqs.length)
+    {
+      return null;
+    }
+
+    /*
+     * we want only one 'representative' PDBEntry per distinct file name
+     * (there may be entries for distinct chains)
+     */
+    Map<String, PDBEntry> pdbsSeen = new HashMap<>();
+
+    /*
+     * LinkedHashMap preserves order of PDB entries (significant if they
+     * will get superimposed to the first structure)
+     */
+    Map<PDBEntry, List<SequenceI>> pdbSeqs = new LinkedHashMap<>();
+    for (int i = 0; i < pdbs.length; i++)
+    {
+      PDBEntry pdb = pdbs[i];
+      SequenceI seq = seqs[i];
+      String pdbFile = pdb.getFile();
+      if (pdbFile == null || pdbFile.length() == 0)
+      {
+        pdbFile = pdb.getId();
+      }
+      if (!pdbsSeen.containsKey(pdbFile))
+      {
+        pdbsSeen.put(pdbFile, pdb);
+        pdbSeqs.put(pdb, new ArrayList<SequenceI>());
+      }
+      else
+      {
+        pdb = pdbsSeen.get(pdbFile);
+      }
+      List<SequenceI> seqsForPdb = pdbSeqs.get(pdb);
+      if (!seqsForPdb.contains(seq))
+      {
+        seqsForPdb.add(seq);
+      }
+    }
+
+    /*
+     * convert to Map<PDBEntry, SequenceI[]>
+     */
+    Map<PDBEntry, SequenceI[]> result = new LinkedHashMap<>();
+    for (Entry<PDBEntry, List<SequenceI>> entry : pdbSeqs.entrySet())
+    {
+      List<SequenceI> theSeqs = entry.getValue();
+      result.put(entry.getKey(),
+              theSeqs.toArray(new SequenceI[theSeqs.size()]));
+    }
+
+    return result;
+  }
+
+  /**
+   * A strictly temporary method pending JAL-1761 refactoring. Determines if all
+   * the passed PDB entries are the same (this is the case if selected sequences
+   * to view structure for are chains of the same structure). If so, calls the
+   * single-pdb version of viewStructures and returns the viewer, else returns
+   * null.
+   * 
+   * @param pdbs
+   * @param seqsForPdbs
+   * @param ap
+   * @return
+   */
+  private JalviewStructureDisplayI onlyOnePdb(PDBEntry[] pdbs,
+          SequenceI[] seqsForPdbs, AlignmentPanel ap)
+  {
+    List<SequenceI> seqs = new ArrayList<SequenceI>();
+    if (pdbs == null || pdbs.length == 0)
+    {
+      return null;
+    }
+    int i = 0;
+    String firstFile = pdbs[0].getFile();
+    for (PDBEntry pdb : pdbs)
+    {
+      String pdbFile = pdb.getFile();
+      if (pdbFile == null || !pdbFile.equals(firstFile))
+      {
+        return null;
+      }
+      SequenceI pdbseq = seqsForPdbs[i++];
+      if (pdbseq != null)
+      {
+        seqs.add(pdbseq);
+      }
+    }
+    return viewStructures(pdbs[0], seqs.toArray(new SequenceI[seqs.size()]),
+            ap);
+  }
+
+  public JalviewStructureDisplayI viewStructures(PDBEntry pdb,
+          SequenceI[] seqsForPdb, AlignmentPanel ap)
+  {
+    ViewerType viewerType = getViewerType();
     JalviewStructureDisplayI sview = null;
     if (viewerType.equals(ViewerType.JMOL))
     {
-      sview = new AppJmol(pr, collateForPDB, null, ap);
+      sview = new AppJmol(pdb, seqsForPdb, null, ap);
     }
     else if (viewerType.equals(ViewerType.CHIMERA))
     {
-      sview = new ChimeraViewFrame(pr, collateForPDB, null, ap);
+      sview = new ChimeraViewFrame(pdb, seqsForPdb, null, ap);
     }
     else
     {
-      Cache.log.error("Unknown structure viewer type "
-              + getViewerType().toString());
+      Cache.log.error(UNKNOWN_VIEWER_TYPE + getViewerType().toString());
     }
     return sview;
   }
 
-  public JalviewStructureDisplayI viewStructures(PDBEntry pdb,
-          SequenceI[] sequenceIs, Object object, AlignmentPanel ap)
-  {
-    return viewStructures(getViewerType(), ap, pdb, sequenceIs);
-  }
-
   /**
    * Create a new panel controlling a structure viewer.
    * 
@@ -130,10 +261,10 @@ public class StructureViewer
    * @param vid
    * @return
    */
-  public JalviewStructureDisplayI createView(ViewerType type,
-          String[] pdbf, String[] id, SequenceI[][] sq,
-          AlignmentPanel alignPanel, StructureViewerModel viewerData, String fileloc,
-          Rectangle rect, String vid)
+  public JalviewStructureDisplayI createView(ViewerType type, String[] pdbf,
+          String[] id, SequenceI[][] sq, AlignmentPanel alignPanel,
+          StructureViewerModel viewerData, String fileloc, Rectangle rect,
+          String vid)
   {
     final boolean useinViewerSuperpos = viewerData.isAlignWithPanel();
     final boolean usetoColourbyseq = viewerData.isColourWithAlignPanel();
@@ -147,11 +278,11 @@ public class StructureViewer
               useinViewerSuperpos, viewerColouring, fileloc, rect, vid);
       break;
     case CHIMERA:
-      Cache.log.error("Unsupported structure viewer type "
-              + type.toString());
+      Cache.log.error(
+              "Unsupported structure viewer type " + type.toString());
       break;
     default:
-      Cache.log.error("Unknown structure viewer type " + type.toString());
+      Cache.log.error(UNKNOWN_VIEWER_TYPE + type.toString());
     }
     return sview;
   }