src/jalview/ext/jmol/PDBFileWithJmol.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.ext.jmol;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.Annotation;
  25 import jalview.datamodel.PDBEntry;
  26 import jalview.datamodel.Sequence;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.io.AlignFile;
  29 import jalview.io.FileParse;
  30 import jalview.schemes.ResidueProperties;
  31 import jalview.util.MessageManager;
  32
  33 import java.io.IOException;
  34 import java.util.Hashtable;
  35 import java.util.Map;
  36
  37 import javajs.awt.Dimension;
  38
  39 import org.jmol.api.JmolStatusListener;
  40 import org.jmol.api.JmolViewer;
  41 import org.jmol.c.CBK;
  42 import org.jmol.modelset.Group;
  43 import org.jmol.modelset.Model;
  44 import org.jmol.modelset.ModelSet;
  45 import org.jmol.modelsetbio.BioModel;
  46 import org.jmol.modelsetbio.BioPolymer;
  47 import org.jmol.viewer.Viewer;
  48 import org.openscience.jmol.app.JmolApp;
  49
  50 /**
  51  * Import and process PDB files with Jmol
  52  *
  53  * @author jprocter
  54  *
  55  */
  56 public class PDBFileWithJmol extends AlignFile implements
  57         JmolStatusListener
  58 {
  59
  60   JmolApp jmolApp = null;
  61
  62   Viewer viewer = null;
  63
  64   public PDBFileWithJmol(String inFile, String type) throws IOException
  65   {
  66     super(inFile, type);
  67   }
  68
  69   public PDBFileWithJmol(FileParse fp) throws IOException
  70   {
  71     super(fp);
  72   }
  73
  74   public PDBFileWithJmol()
  75   {
  76     // TODO Auto-generated constructor stub
  77   }
  78
  79   /**
  80    * create a headless jmol instance for dataprocessing
  81    *
  82    * @return
  83    */
  84   private Viewer getJmolData()
  85   {
  86     if (viewer == null)
  87     { // note that -o -n -x are all implied // TODO check for Jmol 14.2
  88       jmolApp = new JmolApp();
  89       jmolApp.isDataOnly = true;
  90       jmolApp.haveConsole = false;
  91       jmolApp.haveDisplay = false;
  92       try
  93       {
  94         viewer = (Viewer) JmolViewer.allocateViewer(null, null, null, null,
  95                 null, "-x -o -n", this);
  96         viewer.setScreenDimension(jmolApp.startupWidth,
  97                 jmolApp.startupHeight);
  98         jmolApp.startViewer(viewer, null, false);
  99       } catch (ClassCastException x)
 100       {
 101         throw new Error(MessageManager.formatMessage("error.jmol_version_not_compatible_with_jalview_version", new String[]{JmolViewer.getJmolVersion()}),
 102                 x);
 103       }
 104     }
 105     return viewer;
 106   }
 107
 108   private void waitForScript(Viewer jmd)
 109   {
 110     while (jmd.isScriptExecuting())
 111     {
 112       try
 113       {
 114         Thread.sleep(50);
 115
 116       } catch (InterruptedException x)
 117       {
 118       }
 119     }
 120   }
 121
 122   /*
 123    * (non-Javadoc)
 124    *
 125    * @see jalview.io.AlignFile#parse()
 126    */
 127   @Override
 128   public void parse() throws IOException
 129   {
 130     Viewer jmd = getJmolData();
 131     jmd.openReader(getDataName(), getDataName(), getReader());
 132     waitForScript(jmd);
 133
 134     if (jmd.ms.mc > 0)
 135     {
 136       ModelSet ms = jmd.ms;
 137       // Jmol 14.2 added third argument doReport = false
 138       ms.calculateStructures(null, true, false, false, true);
 139       // System.out.println("Structs\n"+structs);
 140       Group group = null;
 141       int modelIndex = -1;
 142       for (Model model : ms.am)
 143       {
 144         modelIndex++;
 145         for (BioPolymer bp : ((BioModel) model).bioPolymers)
 146         {
 147           int lastChainId = 0; // int value of character e.g. 65 for A
 148           String lastChainIdAlpha = "";
 149
 150           int[] groups = bp.getLeadAtomIndices();
 151           char seq[] = new char[groups.length], secstr[] = new char[groups.length], secstrcode[] = new char[groups.length];
 152           int groupc = 0, len = 0, firstrnum = 1, lastrnum = 0;
 153
 154           do
 155           {
 156             if (groupc >= groups.length
 157                     || ms.at[groups[groupc]].group.chain.chainID != lastChainId)
 158             {
 159               /*
 160                * on change of chain (or at end), construct the sequence and
 161                * secondary structure annotation for the last chain
 162                */
 163               if (len > 0)
 164               {
 165                 boolean isNa = bp.isNucleic();
 166                 // normalise sequence from Jmol to jalview
 167                 int[] cinds = isNa ? ResidueProperties.nucleotideIndex
 168                         : ResidueProperties.aaIndex;
 169                 int nonGap = isNa ? ResidueProperties.maxNucleotideIndex
 170                         : ResidueProperties.maxProteinIndex;
 171                 char ngc = 'X';
 172                 char newseq[] = new char[len];
 173                 Annotation asecstr[] = new Annotation[len + firstrnum - 1];
 174                 for (int p = 0; p < len; p++)
 175                 {
 176                   newseq[p] = cinds[seq[p]] == nonGap ? ngc : seq[p];
 177                   if (secstr[p] >= 'A' && secstr[p] <= 'z')
 178                   {
 179                     asecstr[p] = new Annotation("" + secstr[p], null,
 180                             secstrcode[p], Float.NaN);
 181                   }
 182                 }
 183                 String modelTitle = (String) ms
 184                         .getInfo(modelIndex, "title");
 185                 SequenceI sq = new Sequence("" + getDataName() + "|"
 186                         + modelTitle + "|" + lastChainIdAlpha, newseq,
 187                         firstrnum, lastrnum);
 188                 PDBEntry pdbe = new PDBEntry();
 189                 pdbe.setFile(getDataName());
 190                 pdbe.setId(getDataName());
 191                 pdbe.setProperty(new Hashtable());
 192                 // pdbe.getProperty().put("CHAIN", "" + _lastChainId);
 193                 pdbe.setChainCode(lastChainIdAlpha);
 194                 sq.addPDBId(pdbe);
 195                 // JAL-1533
 196                 // Need to put the number of models for this polymer somewhere
 197                 // for Chimera/others to grab
 198                 // pdbe.getProperty().put("PDBMODELS", biopoly.)
 199                 seqs.add(sq);
 200                 if (!isNa)
 201                 {
 202                   String mt = modelTitle == null ? getDataName()
 203                           : modelTitle;
 204                   if (lastChainId >= ' ')
 205                   {
 206                     mt += lastChainIdAlpha;
 207                   }
 208                   AlignmentAnnotation ann = new AlignmentAnnotation(
 209                           "Secondary Structure", "Secondary Structure for "
 210                                   + mt, asecstr);
 211                   ann.belowAlignment = true;
 212                   ann.visible = true;
 213                   ann.autoCalculated = false;
 214                   ann.setCalcId(getClass().getName());
 215                   sq.addAlignmentAnnotation(ann);
 216                   ann.adjustForAlignment();
 217                   ann.validateRangeAndDisplay();
 218                   annotations.add(ann);
 219                 }
 220               }
 221               len = 0;
 222               firstrnum = 1;
 223               lastrnum = 0;
 224             }
 225             if (groupc < groups.length)
 226             {
 227               group = ms.at[groups[groupc]].group;
 228               if (len == 0)
 229               {
 230                 firstrnum = group.getResno();
 231                 lastChainId = group.chain.chainID;
 232                 lastChainIdAlpha = group.chain.getIDStr();
 233               }
 234               else
 235               {
 236                 lastrnum = group.getResno();
 237               }
 238               seq[len] = group.getGroup1();
 239               switch (group.getProteinStructureSubType())
 240               {
 241               case HELIX310:
 242                 if (secstr[len] == 0)
 243                 {
 244                   secstr[len] = '3';
 245                 }
 246               case HELIXALPHA:
 247                 if (secstr[len] == 0)
 248                 {
 249                   secstr[len] = 'H';
 250                 }
 251               case HELIXPI:
 252                 if (secstr[len] == 0)
 253                 {
 254                   secstr[len] = 'P';
 255                 }
 256               case HELIX:
 257                 if (secstr[len] == 0)
 258                 {
 259                   secstr[len] = 'H';
 260                 }
 261                 secstrcode[len] = 'H';
 262                 break;
 263               case SHEET:
 264                 secstr[len] = 'E';
 265                 secstrcode[len] = 'E';
 266                 break;
 267               default:
 268                 secstr[len] = 0;
 269                 secstrcode[len] = 0;
 270               }
 271               len++;
 272             }
 273           } while (groupc++ < groups.length);
 274         }
 275       }
 276
 277       /*
 278        * lastScriptTermination = -9465; String dsspOut =
 279        * jmd.evalString("calculate STRUCTURE"); if (dsspOut.equals("pending")) {
 280        * while (lastScriptTermination == -9465) { try { Thread.sleep(50); }
 281        * catch (Exception x) { } ; } } System.out.println(lastConsoleEcho);
 282        */
 283     }
 284   }
 285
 286   /*
 287    * (non-Javadoc)
 288    *
 289    * @see jalview.io.AlignFile#print()
 290    */
 291   @Override
 292   public String print()
 293   {
 294     // TODO Auto-generated method stub
 295     return null;
 296   }
 297
 298   @Override
 299   public void setCallbackFunction(String callbackType,
 300           String callbackFunction)
 301   {
 302     // TODO Auto-generated method stub
 303
 304   }
 305
 306   /*
 307    * @Override public void notifyCallback(EnumCallback type, Object[] data) {
 308    * try { switch (type) { case ERROR: case SCRIPT:
 309    * notifyScriptTermination((String) data[2], ((Integer) data[3]).intValue());
 310    * break; case MESSAGE: sendConsoleMessage((data == null) ? ((String) null) :
 311    * (String) data[1]); break; case LOADSTRUCT: notifyFileLoaded((String)
 312    * data[1], (String) data[2], (String) data[3], (String) data[4], ((Integer)
 313    * data[5]).intValue());
 314    *
 315    * break; default: // System.err.println("Unhandled callback " + type + " " //
 316    * + data[1].toString()); break; } } catch (Exception e) {
 317    * System.err.println("Squashed Jmol callback handler error:");
 318    * e.printStackTrace(); } }
 319    */
 320   public void notifyCallback(CBK type, Object[] data)
 321   {
 322     String strInfo = (data == null || data[1] == null ? null : data[1]
 323             .toString());
 324     switch (type)
 325     {
 326     case ECHO:
 327       sendConsoleEcho(strInfo);
 328       break;
 329     case SCRIPT:
 330       notifyScriptTermination((String) data[2],
 331               ((Integer) data[3]).intValue());
 332       break;
 333     case MEASURE:
 334       String mystatus = (String) data[3];
 335       if (mystatus.indexOf("Picked") >= 0
 336               || mystatus.indexOf("Sequence") >= 0)
 337       {
 338         // Picking mode
 339         sendConsoleMessage(strInfo);
 340       }
 341       else if (mystatus.indexOf("Completed") >= 0)
 342       {
 343         sendConsoleEcho(strInfo.substring(strInfo.lastIndexOf(",") + 2,
 344                 strInfo.length() - 1));
 345       }
 346       break;
 347     case MESSAGE:
 348       sendConsoleMessage(data == null ? null : strInfo);
 349       break;
 350     case PICK:
 351       sendConsoleMessage(strInfo);
 352       break;
 353     default:
 354       break;
 355     }
 356   }
 357
 358   String lastConsoleEcho = "";
 359
 360   private void sendConsoleEcho(String string)
 361   {
 362     lastConsoleEcho += string;
 363     lastConsoleEcho += "\n";
 364   }
 365
 366   String lastConsoleMessage = "";
 367
 368   private void sendConsoleMessage(String string)
 369   {
 370     lastConsoleMessage += string;
 371     lastConsoleMessage += "\n";
 372   }
 373
 374   int lastScriptTermination = -1;
 375
 376   String lastScriptMessage = "";
 377
 378   private void notifyScriptTermination(String string, int intValue)
 379   {
 380     lastScriptMessage += string;
 381     lastScriptMessage += "\n";
 382     lastScriptTermination = intValue;
 383   }
 384
 385   @Override
 386   public boolean notifyEnabled(CBK callbackPick)
 387   {
 388     switch (callbackPick)
 389     {
 390     case MESSAGE:
 391     case SCRIPT:
 392     case ECHO:
 393     case LOADSTRUCT:
 394     case ERROR:
 395       return true;
 396     default:
 397       return false;
 398     }
 399   }
 400
 401   @Override
 402   public String eval(String strEval)
 403   {
 404     // TODO Auto-generated method stub
 405     return null;
 406   }
 407
 408   @Override
 409   public float[][] functionXY(String functionName, int x, int y)
 410   {
 411     // TODO Auto-generated method stub
 412     return null;
 413   }
 414
 415   @Override
 416   public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
 417   {
 418     // TODO Auto-generated method stub
 419     return null;
 420   }
 421
 422   @Override
 423   public String createImage(String fileName, String type,
 424           Object text_or_bytes, int quality)
 425   {
 426     // TODO Auto-generated method stub
 427     return null;
 428   }
 429
 430   @Override
 431   public Map<String, Object> getRegistryInfo()
 432   {
 433     // TODO Auto-generated method stub
 434     return null;
 435   }
 436
 437   @Override
 438   public void showUrl(String url)
 439   {
 440     // TODO Auto-generated method stub
 441
 442   }
 443
 444   @Override
 445   public Dimension resizeInnerPanel(String data)
 446   {
 447     return null;
 448   }
 449
 450   @Override
 451   public Map<String, Object> getJSpecViewProperty(String arg0)
 452   {
 453     return null;
 454   }
 455
 456 }