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 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                   pdbe.setChainCode(String.valueOf(_lastChainId));
 184                   // JAL-1533
 185                   // Need to put the number of models for this polymer somewhere for Chimera/others to grab
 186                   //                  pdbe.getProperty().put("PDBMODELS", biopoly.)
 187                   seqs.add(sq);
 188                   if (!isNa)
 189                   {
 190                     String mt = model.getModelTitle() == null ? getDataName()
 191                             : model.getModelTitle();
 192                     if (_lastChainId >= ' ')
 193                     {
 194                       mt += _lastChainId;
 195                     }
 196                     AlignmentAnnotation ann = new AlignmentAnnotation(
 197                             "Secondary Structure",
 198                             "Secondary Structure for " + mt, asecstr);
 199                     ann.belowAlignment=true;
 200                     ann.visible=true;
 201                     ann.autoCalculated=false;
 202                     ann.setCalcId(getClass().getName());
 203                     sq.addAlignmentAnnotation(ann);
 204                     ann.adjustForAlignment();
 205                     ann.validateRangeAndDisplay();
 206                     annotations.add(ann);
 207                   }
 208                 }
 209                 len = 0;
 210                 firstrnum = 1;
 211                 lastrnum = 0;
 212               }
 213               if (groupc < groups.length)
 214               {
 215                 if (len == 0)
 216                 {
 217                   firstrnum = bpgrp[groupc].getResno();
 218                   _lastChainId = bpgrp[groupc].getChainID();
 219                 }
 220                 else
 221                 {
 222                   lastrnum = bpgrp[groupc].getResno();
 223                 }
 224                 seq[len] = bpgrp[groupc].getGroup1();
 225                 switch (bpgrp[groupc].getProteinStructureSubType())
 226                 {
 227                 case HELIX_310:
 228                   if (secstr[len] == 0)
 229                   {
 230                     secstr[len] = '3';
 231                   }
 232                 case HELIX_ALPHA:
 233                   if (secstr[len] == 0)
 234                   {
 235                     secstr[len] = 'H';
 236                   }
 237                 case HELIX_PI:
 238                   if (secstr[len] == 0)
 239                   {
 240                     secstr[len] = 'P';
 241                   }
 242                 case HELIX:
 243                   if (secstr[len] == 0)
 244                   {
 245                     secstr[len] = 'H';
 246                   }
 247                   secstrcode[len] = 'H';
 248                   break;
 249                 case SHEET:
 250                   secstr[len] = 'E';
 251                   secstrcode[len] = 'E';
 252                   break;
 253                 default:
 254                   secstr[len] = 0;
 255                   secstrcode[len] = 0;
 256                 }
 257                 len++;
 258               }
 259             } while (groupc++ < groups.length);
 260
 261           }
 262         }
 263       }
 264
 265       /*
 266        * lastScriptTermination = -9465; String dsspOut =
 267        * jmd.evalString("calculate STRUCTURE"); if (dsspOut.equals("pending")) {
 268        * while (lastScriptTermination == -9465) { try { Thread.sleep(50); }
 269        * catch (Exception x) { } ; } } System.out.println(lastConsoleEcho);
 270        */
 271     }
 272   }
 273
 274   /*
 275    * (non-Javadoc)
 276    *
 277    * @see jalview.io.AlignFile#print()
 278    */
 279   @Override
 280   public String print()
 281   {
 282     // TODO Auto-generated method stub
 283     return null;
 284   }
 285
 286   @Override
 287   public void setCallbackFunction(String callbackType,
 288           String callbackFunction)
 289   {
 290     // TODO Auto-generated method stub
 291
 292   }
 293
 294   /*
 295    * @Override public void notifyCallback(EnumCallback type, Object[] data) {
 296    * try { switch (type) { case ERROR: case SCRIPT:
 297    * notifyScriptTermination((String) data[2], ((Integer) data[3]).intValue());
 298    * break; case MESSAGE: sendConsoleMessage((data == null) ? ((String) null) :
 299    * (String) data[1]); break; case LOADSTRUCT: notifyFileLoaded((String)
 300    * data[1], (String) data[2], (String) data[3], (String) data[4], ((Integer)
 301    * data[5]).intValue());
 302    *
 303    * break; default: // System.err.println("Unhandled callback " + type + " " //
 304    * + data[1].toString()); break; } } catch (Exception e) {
 305    * System.err.println("Squashed Jmol callback handler error:");
 306    * e.printStackTrace(); } }
 307    */
 308   public void notifyCallback(EnumCallback type, Object[] data)
 309   {
 310     String strInfo = (data == null || data[1] == null ? null : data[1]
 311             .toString());
 312     switch (type)
 313     {
 314     case ECHO:
 315       sendConsoleEcho(strInfo);
 316       break;
 317     case SCRIPT:
 318       notifyScriptTermination((String) data[2],
 319               ((Integer) data[3]).intValue());
 320       break;
 321     case MEASURE:
 322       String mystatus = (String) data[3];
 323       if (mystatus.indexOf("Picked") >= 0
 324               || mystatus.indexOf("Sequence") >= 0)
 325       {
 326         // Picking mode
 327         sendConsoleMessage(strInfo);
 328       }
 329       else if (mystatus.indexOf("Completed") >= 0)
 330       {
 331         sendConsoleEcho(strInfo.substring(strInfo.lastIndexOf(",") + 2,
 332                 strInfo.length() - 1));
 333       }
 334       break;
 335     case MESSAGE:
 336       sendConsoleMessage(data == null ? null : strInfo);
 337       break;
 338     case PICK:
 339       sendConsoleMessage(strInfo);
 340       break;
 341     default:
 342       break;
 343     }
 344   }
 345
 346   private void notifyFileLoaded(String string, String string2,
 347           String string3, String string4, int intValue)
 348   {
 349     // TODO Auto-generated method stub
 350
 351   }
 352
 353   String lastConsoleEcho = "";
 354
 355   private void sendConsoleEcho(String string)
 356   {
 357     lastConsoleEcho += string;
 358     lastConsoleEcho += "\n";
 359   }
 360
 361   String lastConsoleMessage = "";
 362
 363   private void sendConsoleMessage(String string)
 364   {
 365     lastConsoleMessage += string;
 366     lastConsoleMessage += "\n";
 367   }
 368
 369   int lastScriptTermination = -1;
 370
 371   String lastScriptMessage = "";
 372
 373   private void notifyScriptTermination(String string, int intValue)
 374   {
 375     lastScriptMessage += string;
 376     lastScriptMessage += "\n";
 377     lastScriptTermination = intValue;
 378   }
 379
 380   @Override
 381   public boolean notifyEnabled(EnumCallback callbackPick)
 382   {
 383     switch (callbackPick)
 384     {
 385     case MESSAGE:
 386     case SCRIPT:
 387     case ECHO:
 388     case LOADSTRUCT:
 389     case ERROR:
 390       return true;
 391     case MEASURE:
 392     case PICK:
 393     case HOVER:
 394     case RESIZE:
 395     case SYNC:
 396     case CLICK:
 397     case ANIMFRAME:
 398     case MINIMIZATION:
 399     }
 400     return false;
 401   }
 402
 403   @Override
 404   public String eval(String strEval)
 405   {
 406     // TODO Auto-generated method stub
 407     return null;
 408   }
 409
 410   @Override
 411   public float[][] functionXY(String functionName, int x, int y)
 412   {
 413     // TODO Auto-generated method stub
 414     return null;
 415   }
 416
 417   @Override
 418   public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
 419   {
 420     // TODO Auto-generated method stub
 421     return null;
 422   }
 423
 424   @Override
 425   public String createImage(String fileName, String type,
 426           Object text_or_bytes, int quality)
 427   {
 428     // TODO Auto-generated method stub
 429     return null;
 430   }
 431
 432   @Override
 433   public Map<String, Object> getRegistryInfo()
 434   {
 435     // TODO Auto-generated method stub
 436     return null;
 437   }
 438
 439   @Override
 440   public void showUrl(String url)
 441   {
 442     // TODO Auto-generated method stub
 443
 444   }
 445
 446   @Override
 447   public void resizeInnerPanel(String data)
 448   {
 449     // TODO Auto-generated method stub
 450
 451   }
 452
 453 }