src/jalview/gui/StructureViewer.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.api.structures.JalviewStructureDisplayI;
  24 import jalview.bin.Cache;
  25 import jalview.datamodel.PDBEntry;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.datamodel.StructureViewerModel;
  28 import jalview.structure.StructureSelectionManager;
  29
  30 import java.awt.Rectangle;
  31 import java.util.ArrayList;
  32 import java.util.HashMap;
  33 import java.util.LinkedHashMap;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.Map.Entry;
  37
  38 /**
  39  * A proxy for handling structure viewers, that orchestrates adding selected
  40  * structures, associated with sequences in Jalview, to an existing viewer, or
  41  * opening a new one. Currently supports either Jmol or Chimera as the structure
  42  * viewer.
  43  *
  44  * @author jprocter
  45  */
  46 public class StructureViewer
  47 {
  48   private static final String UNKNOWN_VIEWER_TYPE = "Unknown structure viewer type ";
  49
  50   StructureSelectionManager ssm;
  51
  52   /**
  53    * decide if new structures are aligned to existing ones
  54    */
  55   private boolean superposeAdded = true;
  56
  57   public enum ViewerType
  58   {
  59     JMOL, CHIMERA, CHIMERAX
  60   };
  61
  62   /**
  63    * Constructor
  64    *
  65    * @param structureSelectionManager
  66    */
  67   public StructureViewer(StructureSelectionManager structureSelectionManager)
  68   {
  69     ssm = structureSelectionManager;
  70   }
  71
  72   /**
  73    * Factory to create a proxy for modifying existing structure viewer
  74    *
  75    */
  76   public static StructureViewer reconfigure(
  77           JalviewStructureDisplayI display)
  78   {
  79     StructureViewer sv = new StructureViewer(display.getBinding().getSsm());
  80     sv.sview = display;
  81     return sv;
  82   }
  83
  84   @Override
  85   public String toString()
  86   {
  87     if (sview != null)
  88     {
  89       return sview.toString();
  90     }
  91     return "New View";
  92   }
  93   public ViewerType getViewerType()
  94   {
  95     String viewType = Cache.getDefault(Preferences.STRUCTURE_DISPLAY,
  96             ViewerType.JMOL.name());
  97     return ViewerType.valueOf(viewType);
  98   }
  99
 100   public void setViewerType(ViewerType type)
 101   {
 102     Cache.setProperty(Preferences.STRUCTURE_DISPLAY, type.name());
 103   }
 104
 105   /**
 106    * View multiple PDB entries, each with associated sequences
 107    *
 108    * @param pdbs
 109    * @param seqs
 110    * @param ap
 111    * @return
 112    */
 113   public JalviewStructureDisplayI viewStructures(PDBEntry[] pdbs,
 114           SequenceI[] seqs, AlignmentPanel ap)
 115   {
 116     JalviewStructureDisplayI viewer = onlyOnePdb(pdbs, seqs, ap);
 117     if (viewer != null)
 118     {
 119       /*
 120        * user added structure to an existing viewer - all done
 121        */
 122       return viewer;
 123     }
 124
 125     ViewerType viewerType = getViewerType();
 126
 127     Map<PDBEntry, SequenceI[]> seqsForPdbs = getSequencesForPdbs(pdbs,
 128             seqs);
 129     PDBEntry[] pdbsForFile = seqsForPdbs.keySet().toArray(
 130             new PDBEntry[seqsForPdbs.size()]);
 131     SequenceI[][] theSeqs = seqsForPdbs.values().toArray(
 132             new SequenceI[seqsForPdbs.size()][]);
 133     if (sview != null)
 134     {
 135       sview.setAlignAddedStructures(superposeAdded);
 136       new Thread(new Runnable()
 137       {
 138         @Override
 139         public void run()
 140         {
 141
 142           for (int pdbep = 0; pdbep < pdbsForFile.length; pdbep++)
 143           {
 144             PDBEntry pdb = pdbsForFile[pdbep];
 145             if (!sview.addAlreadyLoadedFile(theSeqs[pdbep], null, ap,
 146                     pdb.getId()))
 147             {
 148               sview.addToExistingViewer(pdb, theSeqs[pdbep], null, ap,
 149                       pdb.getId());
 150             }
 151           }
 152
 153           sview.updateTitleAndMenus();
 154         }
 155       }).start();
 156       return sview;
 157     }
 158
 159     if (viewerType.equals(ViewerType.JMOL))
 160     {
 161       sview = new AppJmol(ap, superposeAdded, pdbsForFile, theSeqs);
 162     }
 163     else if (viewerType.equals(ViewerType.CHIMERA)
 164             || viewerType.equals(ViewerType.CHIMERAX))
 165     {
 166       sview = new ChimeraViewFrame(pdbsForFile, superposeAdded, theSeqs,
 167               ap);
 168     }
 169     else
 170     {
 171       Cache.log.error(UNKNOWN_VIEWER_TYPE + getViewerType().toString());
 172     }
 173     return sview;
 174   }
 175
 176   /**
 177    * Converts the list of selected PDB entries (possibly including duplicates
 178    * for multiple chains), and corresponding sequences, into a map of sequences
 179    * for each distinct PDB file. Returns null if either argument is null, or
 180    * their lengths do not match.
 181    *
 182    * @param pdbs
 183    * @param seqs
 184    * @return
 185    */
 186   Map<PDBEntry, SequenceI[]> getSequencesForPdbs(PDBEntry[] pdbs,
 187           SequenceI[] seqs)
 188   {
 189     if (pdbs == null || seqs == null || pdbs.length != seqs.length)
 190     {
 191       return null;
 192     }
 193
 194     /*
 195      * we want only one 'representative' PDBEntry per distinct file name
 196      * (there may be entries for distinct chains)
 197      */
 198     Map<String, PDBEntry> pdbsSeen = new HashMap<>();
 199
 200     /*
 201      * LinkedHashMap preserves order of PDB entries (significant if they
 202      * will get superimposed to the first structure)
 203      */
 204     Map<PDBEntry, List<SequenceI>> pdbSeqs = new LinkedHashMap<>();
 205     for (int i = 0; i < pdbs.length; i++)
 206     {
 207       PDBEntry pdb = pdbs[i];
 208       SequenceI seq = seqs[i];
 209       String pdbFile = pdb.getFile();
 210       if (pdbFile == null || pdbFile.length() == 0)
 211       {
 212         pdbFile = pdb.getId();
 213       }
 214       if (!pdbsSeen.containsKey(pdbFile))
 215       {
 216         pdbsSeen.put(pdbFile, pdb);
 217         pdbSeqs.put(pdb, new ArrayList<SequenceI>());
 218       }
 219       else
 220       {
 221         pdb = pdbsSeen.get(pdbFile);
 222       }
 223       List<SequenceI> seqsForPdb = pdbSeqs.get(pdb);
 224       if (!seqsForPdb.contains(seq))
 225       {
 226         seqsForPdb.add(seq);
 227       }
 228     }
 229
 230     /*
 231      * convert to Map<PDBEntry, SequenceI[]>
 232      */
 233     Map<PDBEntry, SequenceI[]> result = new LinkedHashMap<>();
 234     for (Entry<PDBEntry, List<SequenceI>> entry : pdbSeqs.entrySet())
 235     {
 236       List<SequenceI> theSeqs = entry.getValue();
 237       result.put(entry.getKey(),
 238               theSeqs.toArray(new SequenceI[theSeqs.size()]));
 239     }
 240
 241     return result;
 242   }
 243
 244   /**
 245    * A strictly temporary method pending JAL-1761 refactoring. Determines if all
 246    * the passed PDB entries are the same (this is the case if selected sequences
 247    * to view structure for are chains of the same structure). If so, calls the
 248    * single-pdb version of viewStructures and returns the viewer, else returns
 249    * null.
 250    *
 251    * @param pdbs
 252    * @param seqsForPdbs
 253    * @param ap
 254    * @return
 255    */
 256   private JalviewStructureDisplayI onlyOnePdb(PDBEntry[] pdbs,
 257           SequenceI[] seqsForPdbs, AlignmentPanel ap)
 258   {
 259     List<SequenceI> seqs = new ArrayList<>();
 260     if (pdbs == null || pdbs.length == 0)
 261     {
 262       return null;
 263     }
 264     int i = 0;
 265     String firstFile = pdbs[0].getFile();
 266     for (PDBEntry pdb : pdbs)
 267     {
 268       String pdbFile = pdb.getFile();
 269       if (pdbFile == null || !pdbFile.equals(firstFile))
 270       {
 271         return null;
 272       }
 273       SequenceI pdbseq = seqsForPdbs[i++];
 274       if (pdbseq != null)
 275       {
 276         seqs.add(pdbseq);
 277       }
 278     }
 279     return viewStructures(pdbs[0], seqs.toArray(new SequenceI[seqs.size()]),
 280             ap);
 281   }
 282
 283   JalviewStructureDisplayI sview = null;
 284
 285   public JalviewStructureDisplayI viewStructures(PDBEntry pdb,
 286           SequenceI[] seqsForPdb, AlignmentPanel ap)
 287   {
 288     if (sview != null)
 289     {
 290       sview.setAlignAddedStructures(superposeAdded);
 291       String pdbId = pdb.getId();
 292       if (!sview.addAlreadyLoadedFile(seqsForPdb, null, ap, pdbId))
 293       {
 294         sview.addToExistingViewer(pdb, seqsForPdb, null, ap, pdbId);
 295       }
 296       sview.updateTitleAndMenus();
 297       sview.raiseViewer();
 298       return sview;
 299     }
 300     ViewerType viewerType = getViewerType();
 301     if (viewerType.equals(ViewerType.JMOL))
 302     {
 303       sview = new AppJmol(pdb, seqsForPdb, null, ap);
 304     }
 305     else if (viewerType.equals(ViewerType.CHIMERA)
 306             || viewerType.equals(ViewerType.CHIMERAX))
 307     {
 308       sview = new ChimeraViewFrame(pdb, seqsForPdb, null, ap);
 309     }
 310     else
 311     {
 312       Cache.log.error(UNKNOWN_VIEWER_TYPE + getViewerType().toString());
 313     }
 314     return sview;
 315   }
 316
 317   /**
 318    * Create a new panel controlling a structure viewer.
 319    *
 320    * @param type
 321    * @param pdbf
 322    * @param id
 323    * @param sq
 324    * @param alignPanel
 325    * @param viewerData
 326    * @param fileloc
 327    * @param rect
 328    * @param vid
 329    * @return
 330    */
 331   public JalviewStructureDisplayI createView(ViewerType type, String[] pdbf,
 332           String[] id, SequenceI[][] sq, AlignmentPanel alignPanel,
 333           StructureViewerModel viewerData, String fileloc, Rectangle rect,
 334           String vid)
 335   {
 336     final boolean useinViewerSuperpos = viewerData.isAlignWithPanel();
 337     final boolean usetoColourbyseq = viewerData.isColourWithAlignPanel();
 338     final boolean viewerColouring = viewerData.isColourByViewer();
 339
 340     switch (type)
 341     {
 342     case JMOL:
 343       sview = new AppJmol(pdbf, id, sq, alignPanel, usetoColourbyseq,
 344               useinViewerSuperpos, viewerColouring, fileloc, rect, vid);
 345       break;
 346     case CHIMERA:
 347       Cache.log.error(
 348               "Unsupported structure viewer type " + type.toString());
 349       break;
 350     default:
 351       Cache.log.error(UNKNOWN_VIEWER_TYPE + type.toString());
 352     }
 353     return sview;
 354   }
 355
 356   public boolean isBusy()
 357   {
 358     if (sview != null)
 359     {
 360       if (!sview.hasMapping())
 361       {
 362         return true;
 363       }
 364     }
 365     return false;
 366   }
 367
 368   /**
 369    *
 370    * @param pDBid
 371    * @return true if view is already showing PDBid
 372    */
 373   public boolean hasPdbId(String pDBid)
 374   {
 375     if (sview == null)
 376     {
 377       return false;
 378     }
 379
 380     return sview.getBinding().hasPdbId(pDBid);
 381   }
 382
 383   public boolean isVisible()
 384   {
 385     return sview != null && sview.isVisible();
 386   }
 387
 388   public void setSuperpose(boolean alignAddedStructures)
 389   {
 390     superposeAdded = alignAddedStructures;
 391   }
 392
 393 }