src/jalview/ext/jmol/PDBFileWithJmol.java

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