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 java.awt.Rectangle;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26
  27 import jalview.api.structures.JalviewStructureDisplayI;
  28 import jalview.bin.Cache;
  29 import jalview.datamodel.PDBEntry;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.datamodel.StructureViewerModel;
  32 import jalview.structure.StructureSelectionManager;
  33
  34 /**
  35  * proxy for handling structure viewers.
  36  *
  37  * this allows new views to be created with the currently configured viewer, the
  38  * preferred viewer to be set/read and existing views created previously with a
  39  * particular viewer to be recovered
  40  *
  41  * @author jprocter
  42  */
  43 public class StructureViewer
  44 {
  45   StructureSelectionManager ssm;
  46
  47   public enum ViewerType
  48   {
  49     JMOL, CHIMERA
  50   };
  51
  52   public ViewerType getViewerType()
  53   {
  54     String viewType = Cache.getDefault(Preferences.STRUCTURE_DISPLAY,
  55             ViewerType.JMOL.name());
  56     return ViewerType.valueOf(viewType);
  57   }
  58
  59   public void setViewerType(ViewerType type)
  60   {
  61     Cache.setProperty(Preferences.STRUCTURE_DISPLAY, type.name());
  62   }
  63
  64   public StructureViewer(StructureSelectionManager structureSelectionManager)
  65   {
  66     ssm = structureSelectionManager;
  67   }
  68
  69   /**
  70    * View multiple PDB entries, each with associated sequences
  71    *
  72    * @param pdbs
  73    * @param seqsForPdbs
  74    * @param ap
  75    * @return
  76    */
  77   public JalviewStructureDisplayI viewStructures(PDBEntry[] pdbs,
  78           SequenceI[][] seqsForPdbs, AlignmentPanel ap)
  79   {
  80     JalviewStructureDisplayI viewer = onlyOnePdb(pdbs, seqsForPdbs, ap);
  81     if (viewer != null)
  82     {
  83       return viewer;
  84     }
  85     return viewStructures(getViewerType(), pdbs, seqsForPdbs, ap);
  86   }
  87
  88   /**
  89    * A strictly temporary method pending JAL-1761 refactoring. Determines if all
  90    * the passed PDB entries are the same (this is the case if selected sequences
  91    * to view structure for are chains of the same structure). If so, calls the
  92    * single-pdb version of viewStructures and returns the viewer, else returns
  93    * null.
  94    *
  95    * @param pdbs
  96    * @param seqsForPdbs
  97    * @param ap
  98    * @return
  99    */
 100   private JalviewStructureDisplayI onlyOnePdb(PDBEntry[] pdbs,
 101           SequenceI[][] seqsForPdbs,
 102           AlignmentPanel ap)
 103   {
 104     List<SequenceI> seqs = new ArrayList<SequenceI>();
 105     if (pdbs == null || pdbs.length == 0)
 106     {
 107       return null;
 108     }
 109     int i = 0;
 110     String firstFile = pdbs[0].getFile();
 111     for (PDBEntry pdb : pdbs)
 112     {
 113       String pdbFile = pdb.getFile();
 114       if (pdbFile == null || !pdbFile.equals(firstFile))
 115       {
 116         return null;
 117       }
 118       SequenceI[] pdbseqs = seqsForPdbs[i++];
 119       if (pdbseqs != null)
 120       {
 121         for (SequenceI sq : pdbseqs)
 122         {
 123           seqs.add(sq);
 124         }
 125       }
 126     }
 127     return viewStructures(pdbs[0],
 128             seqs.toArray(new SequenceI[seqs.size()]), ap);
 129   }
 130
 131   public JalviewStructureDisplayI viewStructures(PDBEntry pdb,
 132           SequenceI[] seqsForPdb, AlignmentPanel ap)
 133   {
 134     return viewStructures(getViewerType(), pdb, seqsForPdb, ap);
 135   }
 136
 137   protected JalviewStructureDisplayI viewStructures(ViewerType viewerType,
 138           PDBEntry[] pdbs, SequenceI[][] seqsForPdbs, AlignmentPanel ap)
 139   {
 140     JalviewStructureDisplayI sview = null;
 141     if (viewerType.equals(ViewerType.JMOL))
 142     {
 143       sview = new AppJmol(ap, pdbs, ap.av.collateForPDB(pdbs));
 144     }
 145     else if (viewerType.equals(ViewerType.CHIMERA))
 146     {
 147       sview = new ChimeraViewFrame(pdbs, ap.av.collateForPDB(pdbs), ap);
 148     }
 149     else
 150     {
 151       Cache.log.error("Unknown structure viewer type "
 152               + getViewerType().toString());
 153     }
 154     return sview;
 155   }
 156
 157   protected JalviewStructureDisplayI viewStructures(ViewerType viewerType,
 158           PDBEntry pdb, SequenceI[] seqsForPdb, AlignmentPanel ap)
 159   {
 160     JalviewStructureDisplayI sview = null;
 161     if (viewerType.equals(ViewerType.JMOL))
 162     {
 163       sview = new AppJmol(pdb, seqsForPdb, null, ap);
 164     }
 165     else if (viewerType.equals(ViewerType.CHIMERA))
 166     {
 167       sview = new ChimeraViewFrame(pdb, seqsForPdb, null, ap);
 168     }
 169     else
 170     {
 171       Cache.log.error("Unknown structure viewer type "
 172               + getViewerType().toString());
 173     }
 174     return sview;
 175   }
 176
 177   /**
 178    * Create a new panel controlling a structure viewer.
 179    *
 180    * @param type
 181    * @param pdbf
 182    * @param id
 183    * @param sq
 184    * @param alignPanel
 185    * @param viewerData
 186    * @param fileloc
 187    * @param rect
 188    * @param vid
 189    * @return
 190    */
 191   public JalviewStructureDisplayI createView(ViewerType type,
 192           String[] pdbf, String[] id, SequenceI[][] sq,
 193           AlignmentPanel alignPanel, StructureViewerModel viewerData, String fileloc,
 194           Rectangle rect, String vid)
 195   {
 196     final boolean useinViewerSuperpos = viewerData.isAlignWithPanel();
 197     final boolean usetoColourbyseq = viewerData.isColourWithAlignPanel();
 198     final boolean viewerColouring = viewerData.isColourByViewer();
 199
 200     JalviewStructureDisplayI sview = null;
 201     switch (type)
 202     {
 203     case JMOL:
 204       sview = new AppJmol(pdbf, id, sq, alignPanel, usetoColourbyseq,
 205               useinViewerSuperpos, viewerColouring, fileloc, rect, vid);
 206       break;
 207     case CHIMERA:
 208       Cache.log.error("Unsupported structure viewer type "
 209               + type.toString());
 210       break;
 211     default:
 212       Cache.log.error("Unknown structure viewer type " + type.toString());
 213     }
 214     return sview;
 215   }
 216
 217 }