JAL-1757 match only first altloc CA in PDB structure for superposition
[jalview.git] / src / jalview / ext / jmol / JalviewJmolBinding.java
index 67327c1..50e156f 100644 (file)
@@ -1,78 +1,73 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.ext.jmol;
 
+import java.awt.Color;
+import java.awt.Container;
+import java.awt.event.ComponentEvent;
+import java.awt.event.ComponentListener;
 import java.io.File;
 import java.net.URL;
-import java.util.*;
-import java.applet.Applet;
-import java.awt.*;
-import java.awt.event.*;
+import java.security.AccessControlException;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Map;
+import java.util.Vector;
 
-import javax.swing.JPanel;
+import org.jmol.adapter.smarter.SmarterJmolAdapter;
+import org.jmol.api.JmolAppConsoleInterface;
+import org.jmol.api.JmolSelectionListener;
+import org.jmol.api.JmolStatusListener;
+import org.jmol.api.JmolViewer;
+import org.jmol.constant.EnumCallback;
+import org.jmol.popup.JmolPopup;
 
 import jalview.api.AlignmentViewPanel;
 import jalview.api.FeatureRenderer;
 import jalview.api.SequenceRenderer;
-import jalview.api.SequenceStructureBinding;
-import jalview.datamodel.*;
-import jalview.structure.*;
-import jalview.io.*;
-
-import org.jmol.api.*;
-import org.jmol.adapter.smarter.SmarterJmolAdapter;
-
-import org.jmol.popup.*;
-import org.jmol.viewer.JmolConstants;
-import org.jmol.viewer.Viewer;
-
-import jalview.schemes.*;
-
-public abstract class JalviewJmolBinding implements StructureListener,
-        JmolStatusListener, SequenceStructureBinding,
-        JmolSelectionListener, ComponentListener
-
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.PDBEntry;
+import jalview.datamodel.SequenceI;
+import jalview.io.AppletFormatAdapter;
+import jalview.schemes.ColourSchemeI;
+import jalview.schemes.ResidueProperties;
+import jalview.structure.StructureMapping;
+import jalview.structure.StructureMappingcommandSet;
+import jalview.structure.StructureSelectionManager;
+import jalview.structures.models.AAStructureBindingModel;
+import jalview.util.MessageManager;
+
+public abstract class JalviewJmolBinding extends AAStructureBindingModel
+        implements JmolStatusListener, JmolSelectionListener,
+        ComponentListener
 {
-  /**
-   * set if Jmol state is being restored from some source - instructs binding
-   * not to apply default display style when structure set is updated for first
-   * time.
-   */
-  private boolean loadingFromArchive = false;
-
-  /**
+  /*
    * state flag used to check if the Jmol viewer's paint method can be called
    */
   private boolean finishedInit = false;
 
-  public boolean isFinishedInit()
-  {
-    return finishedInit;
-  }
-
-  public void setFinishedInit(boolean finishedInit)
-  {
-    this.finishedInit = finishedInit;
-  }
-
   boolean allChainsSelected = false;
 
-  /**
+  /*
    * when true, try to search the associated datamodel for sequences that are
    * associated with any unknown structures in the Jmol view.
    */
@@ -84,18 +79,11 @@ public abstract class JalviewJmolBinding implements StructureListener,
 
   Hashtable chainFile;
 
-  /**
-   * array of target chains for seuqences - tied to pdbentry and sequence[]
-   */
-  protected String[][] chains;
-
-  boolean colourBySequence = true;
-
   StringBuffer eval = new StringBuffer();
 
   public String fileLoadingError;
 
-  /**
+  /*
    * the default or current model displayed if the model cannot be identified
    * from the selection message
    */
@@ -114,35 +102,15 @@ public abstract class JalviewJmolBinding implements StructureListener,
    */
   String[] modelFileNames = null;
 
-  public PDBEntry[] pdbentry;
-
-  /**
-   * datasource protocol for access to PDBEntrylatest
-   */
-  String protocol = null;
-
   StringBuffer resetLastRes = new StringBuffer();
 
-  /**
-   * sequences mapped to each pdbentry
-   */
-  public SequenceI[][] sequence;
-
-  StructureSelectionManager ssm;
-
   public JmolViewer viewer;
 
-  public JalviewJmolBinding(PDBEntry[] pdbentry, SequenceI[][] sequenceIs,
-          String[][] chains, String protocol)
+  public JalviewJmolBinding(StructureSelectionManager ssm,
+          PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String[][] chains,
+          String protocol)
   {
-    this.sequence = sequenceIs;
-    this.chains = chains;
-    this.pdbentry = pdbentry;
-    this.protocol = protocol;
-    if (chains == null)
-    {
-      this.chains = new String[pdbentry.length][];
-    }
+    super(ssm, pdbentry, sequenceIs, chains, protocol);
     /*
      * viewer = JmolViewer.allocateViewer(renderPanel, new SmarterJmolAdapter(),
      * "jalviewJmol", ap.av.applet .getDocumentBase(),
@@ -152,9 +120,12 @@ public abstract class JalviewJmolBinding implements StructureListener,
      */
   }
 
-  public JalviewJmolBinding(JmolViewer viewer2)
+  public JalviewJmolBinding(StructureSelectionManager ssm,
+          SequenceI[][] seqs, JmolViewer theViewer)
   {
-    viewer = viewer2;
+    super(ssm, seqs);
+
+    viewer = theViewer;
     viewer.setJmolStatusListener(this);
     viewer.addSelectionListener(this);
   }
@@ -167,30 +138,7 @@ public abstract class JalviewJmolBinding implements StructureListener,
    */
   public String getViewerTitle()
   {
-    if (sequence == null || pdbentry == null || sequence.length < 1
-            || pdbentry.length < 1 || sequence[0].length < 1)
-    {
-      return ("Jalview Jmol Window");
-    }
-    // TODO: give a more informative title when multiple structures are
-    // displayed.
-    StringBuffer title = new StringBuffer(sequence[0][0].getName() + ":"
-            + pdbentry[0].getId());
-
-    if (pdbentry[0].getProperty() != null)
-    {
-      if (pdbentry[0].getProperty().get("method") != null)
-      {
-        title.append(" Method: ");
-        title.append(pdbentry[0].getProperty().get("method"));
-      }
-      if (pdbentry[0].getProperty().get("chains") != null)
-      {
-        title.append(" Chain:");
-        title.append(pdbentry[0].getProperty().get("chains"));
-      }
-    }
-    return title.toString();
+    return getViewerTitle("JMol", true);
   }
 
   /**
@@ -219,7 +167,9 @@ public abstract class JalviewJmolBinding implements StructureListener,
               + (1 + getModelNum((String) chainFile.get(lbl))) + " or ");
     }
     if (cmd.length() > 0)
+    {
       cmd.setLength(cmd.length() - 4);
+    }
     evalStateCommand("select *;restrict " + cmd + ";cartoon;center " + cmd);
   }
 
@@ -227,8 +177,7 @@ public abstract class JalviewJmolBinding implements StructureListener,
   {
     viewer.setModeMouse(org.jmol.viewer.JmolConstants.MOUSE_NONE);
     // remove listeners for all structures in viewer
-    StructureSelectionManager.getStructureSelectionManager()
-            .removeStructureViewerListener(this, this.getPdbFile());
+    getSsm().removeStructureViewerListener(this, this.getPdbFile());
     // and shut down jmol
     viewer.evalStringQuiet("zap");
     viewer.setJmolStatusListener(null);
@@ -237,12 +186,6 @@ public abstract class JalviewJmolBinding implements StructureListener,
     releaseUIResources();
   }
 
-  /**
-   * called by JalviewJmolbinding after closeViewer is called - release any
-   * resources and references so they can be garbage collected.
-   */
-  protected abstract void releaseUIResources();
-
   public void colourByChain()
   {
     colourBySequence = false;
@@ -303,9 +246,59 @@ public abstract class JalviewJmolBinding implements StructureListener,
   public void superposeStructures(AlignmentI[] _alignment,
           int[] _refStructure, ColumnSelection[] _hiddenCols)
   {
+    assert (_alignment.length == _refStructure.length && _alignment.length != _hiddenCols.length);
+
     String[] files = getPdbFile();
+    // check to see if we are still waiting for Jmol files
+    long starttime = System.currentTimeMillis();
+    boolean waiting = true;
+    do
+    {
+      waiting = false;
+      for (String file : files)
+      {
+        try
+        {
+          // HACK - in Jalview 2.8 this call may not be threadsafe so we catch
+          // every possible exception
+          StructureMapping[] sm = getSsm().getMapping(file);
+          if (sm == null || sm.length == 0)
+          {
+            waiting = true;
+          }
+        } catch (Exception x)
+        {
+          waiting = true;
+        } catch (Error q)
+        {
+          waiting = true;
+        }
+      }
+      // we wait around for a reasonable time before we give up
+    } while (waiting
+            && System.currentTimeMillis() < (10000 + 1000 * files.length + starttime));
+    if (waiting)
+    {
+      System.err
+              .println("RUNTIME PROBLEM: Jmol seems to be taking a long time to process all the structures.");
+      return;
+    }
     StringBuffer selectioncom = new StringBuffer();
-    assert (_alignment.length == _refStructure.length && _alignment.length != _hiddenCols.length);
+    // In principle - nSeconds specifies the speed of animation for each
+    // superposition - but is seems to behave weirdly, so we don't specify it.
+    String nSeconds = " ";
+    if (files.length > 10)
+    {
+      nSeconds = " 0.00001 ";
+    }
+    else
+    {
+      nSeconds = " " + (2.0 / files.length) + " ";
+      // if (nSeconds).substring(0,5)+" ";
+    }
+    // see JAL-1345 - should really automatically turn off the animation for
+    // large numbers of structures, but Jmol doesn't seem to allow that.
+    nSeconds = " ";
     // union of all aligned positions are collected together.
     for (int a = 0; a < _alignment.length; a++)
     {
@@ -346,18 +339,21 @@ public abstract class JalviewJmolBinding implements StructureListener,
       String[] chainNames = new String[files.length];
       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
       {
-        StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
-
+        StructureMapping[] mapping = getSsm().getMapping(files[pdbfnum]);
+        // RACE CONDITION - getMapping only returns Jmol loaded filenames once
+        // Jmol callback has completed.
         if (mapping == null || mapping.length < 1)
-          continue;
-
+        {
+          throw new Error(MessageManager.getString("error.implementation_error_jmol_getting_data"));
+        }
         int lastPos = -1;
-        for (int s = 0; s < sequence[pdbfnum].length; s++)
+        final int sequenceCountForPdbFile = getSequence()[pdbfnum].length;
+        for (int s = 0; s < sequenceCountForPdbFile; s++)
         {
           for (int sp, m = 0; m < mapping.length; m++)
           {
-            if (mapping[m].getSequence() == sequence[pdbfnum][s]
-                    && (sp = alignment.findIndex(sequence[pdbfnum][s])) > -1)
+            if (mapping[m].getSequence() == getSequence()[pdbfnum][s]
+                    && (sp = alignment.findIndex(getSequence()[pdbfnum][s])) > -1)
             {
               if (refStructure == -1)
               {
@@ -409,12 +405,19 @@ public abstract class JalviewJmolBinding implements StructureListener,
               chainNames[pdbfnum] = mapping[m].getPdbId()
                       + targetC[pdbfnum];
               // move on to next pdb file
-              s = sequence[pdbfnum].length;
+              s = getSequence()[pdbfnum].length;
               break;
             }
           }
         }
       }
+
+      // TODO: consider bailing if nmatched less than 4 because superposition
+      // not
+      // well defined.
+      // TODO: refactor superposable position search (above) from jmol selection
+      // construction (below)
+
       String[] selcom = new String[files.length];
       int nmatched = 0;
       // generate select statements to select regions to superimpose structures
@@ -467,27 +470,30 @@ public abstract class JalviewJmolBinding implements StructureListener,
             molsel.append(chainCd);
             molsel.append("}");
           }
-          selcom[pdbfnum] = molsel.toString();
-          selectioncom.append("((");
-          selectioncom.append(selcom[pdbfnum].substring(1,
-                  selcom[pdbfnum].length() - 1));
-          selectioncom.append(" )& ");
-          selectioncom.append(pdbfnum + 1);
-          selectioncom.append(".1)");
-          if (pdbfnum < files.length - 1)
+          if (molsel.length() > 1)
+          {
+            selcom[pdbfnum] = molsel.toString();
+            selectioncom.append("((");
+            selectioncom.append(selcom[pdbfnum].substring(1,
+                    selcom[pdbfnum].length() - 1));
+            selectioncom.append(" )& ");
+            selectioncom.append(pdbfnum + 1);
+            selectioncom.append(".1)");
+            if (pdbfnum < files.length - 1)
+            {
+              selectioncom.append("|");
+            }
+          }
+          else
           {
-            selectioncom.append("|");
+            selcom[pdbfnum] = null;
           }
         }
       }
-      // TODO: consider bailing if nmatched less than 4 because superposition
-      // not
-      // well defined.
-      // TODO: refactor superposable position search (above) from jmol selection
-      // construction (below)
       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
       {
-        if (pdbfnum == refStructure)
+        if (pdbfnum == refStructure || selcom[pdbfnum] == null
+                || selcom[refStructure] == null)
         {
           continue;
         }
@@ -496,12 +502,13 @@ public abstract class JalviewJmolBinding implements StructureListener,
         command.append(chainNames[pdbfnum]);
         command.append(") against reference (");
         command.append(chainNames[refStructure]);
-        command.append(")\";\ncompare ");
+        command.append(")\";\ncompare " + nSeconds);
         command.append("{");
         command.append(1 + pdbfnum);
         command.append(".1} {");
         command.append(1 + refStructure);
-        command.append(".1} SUBSET {*.CA | *.P} ATOMS ");
+        // conformation=1 excludes alternate locations for CA (JAL-1757)
+        command.append(".1} SUBSET {(*.CA | *.P) and conformation=1} ATOMS ");
 
         // form the matched pair strings
         String sep = "";
@@ -511,13 +518,17 @@ public abstract class JalviewJmolBinding implements StructureListener,
         }
         command.append(" ROTATE TRANSLATE;\n");
       }
-      System.out.println("Select regions:\n" + selectioncom.toString());
-      evalStateCommand("select *; cartoons off; backbone; select ("
-              + selectioncom.toString() + "); cartoons; ");
-      // selcom.append("; ribbons; ");
-      System.out.println("Superimpose command(s):\n" + command.toString());
-
-      evalStateCommand(command.toString());
+      if (selectioncom.length() > 0)
+      {
+        System.out.println("Select regions:\n" + selectioncom.toString());
+        evalStateCommand("select *; cartoons off; backbone; select ("
+                + selectioncom.toString() + "); cartoons; ");
+        // selcom.append("; ribbons; ");
+        System.out
+                .println("Superimpose command(s):\n" + command.toString());
+
+        evalStateCommand(command.toString());
+      }
     }
     if (selectioncom.length() > 0)
     {// finally, mark all regions that were superposed.
@@ -551,9 +562,11 @@ public abstract class JalviewJmolBinding implements StructureListener,
   public void colourBySequence(boolean showFeatures,
           jalview.api.AlignmentViewPanel alignmentv)
   {
-    if (!colourBySequence)
+    if (!colourBySequence || !isLoadingFinished())
+    {
       return;
-    if (ssm == null)
+    }
+    if (getSsm() == null)
     {
       return;
     }
@@ -567,104 +580,39 @@ public abstract class JalviewJmolBinding implements StructureListener,
       fr = getFeatureRenderer(alignmentv);
     }
     AlignmentI alignment = alignmentv.getAlignment();
-    StringBuffer command = new StringBuffer();
 
-    for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
+    for (jalview.structure.StructureMappingcommandSet cpdbbyseq : getColourBySequenceCommands(files, sr, fr, alignment))
     {
-      StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
-
-      if (mapping == null || mapping.length < 1)
-        continue;
-
-      int lastPos = -1;
-      for (int s = 0; s < sequence[pdbfnum].length; s++)
+      for (String cbyseq : cpdbbyseq.commands)
       {
-        for (int sp, m = 0; m < mapping.length; m++)
-        {
-          if (mapping[m].getSequence() == sequence[pdbfnum][s]
-                  && (sp = alignment.findIndex(sequence[pdbfnum][s])) > -1)
-          {
-            SequenceI asp = alignment.getSequenceAt(sp);
-            for (int r = 0; r < asp.getLength(); r++)
-            {
-              // no mapping to gaps in sequence
-              if (jalview.util.Comparison.isGap(asp.getCharAt(r)))
-              {
-                continue;
-              }
-              int pos = mapping[m].getPDBResNum(asp.findPosition(r));
-
-              if (pos < 1 || pos == lastPos)
-                continue;
-
-              lastPos = pos;
-
-              Color col = sr.getResidueBoxColour(sequence[pdbfnum][s], r);
-
-              if (showFeatures && fr != null)
-                col = fr.findFeatureColour(col, sequence[pdbfnum][s], r);
-              String newSelcom = (mapping[m].getChain() != " " ? ":"
-                      + mapping[m].getChain() : "")
-                      + "/"
-                      + (pdbfnum + 1)
-                      + ".1"
-                      + ";color["
-                      + col.getRed()
-                      + ","
-                      + col.getGreen()
-                      + ","
-                      + col.getBlue() + "]";
-              if (command.toString().endsWith(newSelcom))
-              {
-                command = condenseCommand(command.toString(), pos);
-                continue;
-              }
-              // TODO: deal with case when buffer is too large for Jmol to parse
-              // - execute command and flush
-
-              command.append(";select " + pos);
-              command.append(newSelcom);
-            }
-            break;
-          }
-        }
+        executeWhenReady(cbyseq);
       }
     }
-    evalStateCommand(command.toString());
   }
 
-  public boolean isColourBySequence()
-  {
-    return colourBySequence;
-  }
-
-  public void setColourBySequence(boolean colourBySequence)
+  /**
+   * @param files
+   * @param sr
+   * @param fr
+   * @param alignment
+   * @return
+   */
+  protected StructureMappingcommandSet[] getColourBySequenceCommands(
+          String[] files, SequenceRenderer sr, FeatureRenderer fr,
+          AlignmentI alignment)
   {
-    this.colourBySequence = colourBySequence;
+    return JmolCommands
+            .getColourBySequenceCommand(getSsm(), files, getSequence(), sr,
+                    fr,
+                    alignment);
   }
 
-  StringBuffer condenseCommand(String command, int pos)
+  /**
+   * @param command
+   */
+  protected void executeWhenReady(String command)
   {
-
-    StringBuffer sb = new StringBuffer(command.substring(0,
-            command.lastIndexOf("select") + 7));
-
-    command = command.substring(sb.length());
-
-    String start;
-
-    if (command.indexOf("-") > -1)
-    {
-      start = command.substring(0, command.indexOf("-"));
-    }
-    else
-    {
-      start = command.substring(0, command.indexOf(":"));
-    }
-
-    sb.append(start + "-" + pos + command.substring(command.indexOf(":")));
-
-    return sb;
+    evalStateCommand(command);
   }
 
   public void createImage(String file, String type, int quality)
@@ -704,7 +652,9 @@ public abstract class JalviewJmolBinding implements StructureListener,
           String pdbfile)
   {
     if (getModelNum(pdbfile) < 0)
+    {
       return null;
+    }
     // TODO: verify atomIndex is selecting correct model.
     return new Color(viewer.getAtomArgb(atomIndex));
   }
@@ -737,7 +687,9 @@ public abstract class JalviewJmolBinding implements StructureListener,
     for (int i = 0; i < mfn.length; i++)
     {
       if (mfn[i].equalsIgnoreCase(modelFileName))
+      {
         return i;
+      }
     }
     return -1;
   }
@@ -763,10 +715,34 @@ public abstract class JalviewJmolBinding implements StructureListener,
       String mset[] = new String[viewer.getModelCount()];
       _modelFileNameMap = new int[mset.length];
       int j = 1;
-      mset[0] = viewer.getModelFileName(0);
+      String m = viewer.getModelFileName(0);
+      if (m != null)
+      {
+        try
+        {
+          mset[0] = new File(m).getAbsolutePath();
+        } catch (AccessControlException x)
+        {
+          // usually not allowed to do this in applet, so keep raw handle
+          mset[0] = m;
+          // System.err.println("jmolBinding: Using local file string from Jmol: "+m);
+        }
+      }
       for (int i = 1; i < mset.length; i++)
       {
-        mset[j] = viewer.getModelFileName(i);
+        m = viewer.getModelFileName(i);
+        if (m != null)
+        {
+          try
+          {
+            mset[j] = new File(m).getAbsolutePath();
+          } catch (AccessControlException x)
+          {
+            // usually not allowed to do this in applet, so keep raw handle
+            mset[j] = m;
+            // System.err.println("jmolBinding: Using local file string from Jmol: "+m);
+          }
+        }
         _modelFileNameMap[j] = i; // record the model index for the filename
         // skip any additional models in the same file (NMR structures)
         if ((mset[j] == null ? mset[j] != mset[j - 1]
@@ -784,7 +760,8 @@ public abstract class JalviewJmolBinding implements StructureListener,
   /**
    * map from string to applet
    */
-  public Map getRegistryInfo()
+  @Override
+  public Map<String, Object> getRegistryInfo()
   {
     // TODO Auto-generated method stub
     return null;
@@ -922,8 +899,10 @@ public abstract class JalviewJmolBinding implements StructureListener,
     String chainId;
 
     if (strInfo.indexOf(":") > -1)
+    {
       chainId = strInfo.substring(strInfo.indexOf(":") + 1,
               strInfo.indexOf("."));
+    }
     else
     {
       chainId = " ";
@@ -942,15 +921,28 @@ public abstract class JalviewJmolBinding implements StructureListener,
       try
       {
         // recover PDB filename for the model hovered over.
-        pdbfilename = viewer
-                .getModelFileName(new Integer(mdlId).intValue() - 1);
+        int _mp = _modelFileNameMap.length - 1, mnumber = new Integer(mdlId)
+                .intValue() - 1;
+        while (mnumber < _modelFileNameMap[_mp])
+        {
+          _mp--;
+        }
+        pdbfilename = modelFileNames[_mp];
+        if (pdbfilename == null)
+        {
+          pdbfilename = new File(viewer.getModelFileName(mnumber))
+                  .getAbsolutePath();
+        }
+
       } catch (Exception e)
       {
       }
       ;
     }
     if (lastMessage == null || !lastMessage.equals(strInfo))
-      ssm.mouseOverStructure(pdbResNum, chainId, pdbfilename);
+    {
+      getSsm().mouseOverStructure(pdbResNum, chainId, pdbfilename);
+    }
 
     lastMessage = strInfo;
   }
@@ -984,13 +976,17 @@ public abstract class JalviewJmolBinding implements StructureListener,
     int chainSeparator = strInfo.indexOf(":");
     int p = 0;
     if (chainSeparator == -1)
+    {
       chainSeparator = strInfo.indexOf(".");
+    }
 
     String picked = strInfo.substring(strInfo.indexOf("]") + 1,
             chainSeparator);
     String mdlString = "";
     if ((p = strInfo.indexOf(":")) > -1)
+    {
       picked += strInfo.substring(p + 1, strInfo.indexOf("."));
+    }
 
     if ((p = strInfo.indexOf("/")) > -1)
     {
@@ -1021,47 +1017,48 @@ public abstract class JalviewJmolBinding implements StructureListener,
 
   }
 
-  public void notifyCallback(int type, Object[] data)
+  @Override
+  public void notifyCallback(EnumCallback type, Object[] data)
   {
     try
     {
       switch (type)
       {
-      case JmolConstants.CALLBACK_LOADSTRUCT:
+      case LOADSTRUCT:
         notifyFileLoaded((String) data[1], (String) data[2],
                 (String) data[3], (String) data[4],
                 ((Integer) data[5]).intValue());
 
         break;
-      case JmolConstants.CALLBACK_PICK:
+      case PICK:
         notifyAtomPicked(((Integer) data[2]).intValue(), (String) data[1],
                 (String) data[0]);
         // also highlight in alignment
-      case JmolConstants.CALLBACK_HOVER:
+      case HOVER:
         notifyAtomHovered(((Integer) data[2]).intValue(), (String) data[1],
                 (String) data[0]);
         break;
-      case JmolConstants.CALLBACK_SCRIPT:
+      case SCRIPT:
         notifyScriptTermination((String) data[2],
                 ((Integer) data[3]).intValue());
         break;
-      case JmolConstants.CALLBACK_ECHO:
+      case ECHO:
         sendConsoleEcho((String) data[1]);
         break;
-      case JmolConstants.CALLBACK_MESSAGE:
+      case MESSAGE:
         sendConsoleMessage((data == null) ? ((String) null)
                 : (String) data[1]);
         break;
-      case JmolConstants.CALLBACK_ERROR:
+      case ERROR:
         // System.err.println("Ignoring error callback.");
         break;
-      case JmolConstants.CALLBACK_SYNC:
-      case JmolConstants.CALLBACK_RESIZE:
+      case SYNC:
+      case RESIZE:
         refreshGUI();
         break;
-      case JmolConstants.CALLBACK_MEASURE:
+      case MEASURE:
 
-      case JmolConstants.CALLBACK_CLICK:
+      case CLICK:
       default:
         System.err.println("Unhandled callback " + type + " "
                 + data[1].toString());
@@ -1074,24 +1071,25 @@ public abstract class JalviewJmolBinding implements StructureListener,
     }
   }
 
-  public boolean notifyEnabled(int callbackPick)
+  @Override
+  public boolean notifyEnabled(EnumCallback callbackPick)
   {
     switch (callbackPick)
     {
-    case JmolConstants.CALLBACK_ECHO:
-    case JmolConstants.CALLBACK_LOADSTRUCT:
-    case JmolConstants.CALLBACK_MEASURE:
-    case JmolConstants.CALLBACK_MESSAGE:
-    case JmolConstants.CALLBACK_PICK:
-    case JmolConstants.CALLBACK_SCRIPT:
-    case JmolConstants.CALLBACK_HOVER:
-    case JmolConstants.CALLBACK_ERROR:
+    case ECHO:
+    case LOADSTRUCT:
+    case MEASURE:
+    case MESSAGE:
+    case PICK:
+    case SCRIPT:
+    case HOVER:
+    case ERROR:
       return true;
-    case JmolConstants.CALLBACK_RESIZE:
-    case JmolConstants.CALLBACK_SYNC:
-    case JmolConstants.CALLBACK_CLICK:
-    case JmolConstants.CALLBACK_ANIMFRAME:
-    case JmolConstants.CALLBACK_MINIMIZATION:
+    case RESIZE:
+    case SYNC:
+    case CLICK:
+    case ANIMFRAME:
+    case MINIMIZATION:
     }
     return false;
   }
@@ -1128,7 +1126,6 @@ public abstract class JalviewJmolBinding implements StructureListener,
     chainFile = new Hashtable();
     boolean notifyLoaded = false;
     String[] modelfilenames = getPdbFile();
-    ssm = StructureSelectionManager.getStructureSelectionManager();
     // first check if we've lost any structures
     if (oldmodels != null && oldmodels.length > 0)
     {
@@ -1161,7 +1158,7 @@ public abstract class JalviewJmolBinding implements StructureListener,
         }
         // deregister the Jmol instance for these structures - we'll add
         // ourselves again at the end for the current structure set.
-        ssm.removeStructureViewerListener(this, oldmfn);
+        getSsm().removeStructureViewerListener(this, oldmfn);
       }
     }
     refreshPdbEntries();
@@ -1181,69 +1178,68 @@ public abstract class JalviewJmolBinding implements StructureListener,
                 + ".0", "PDB");
         pdbfhash = "" + pdbfile.hashCode();
       }
-      if (pdbentry != null)
-      {
         // search pdbentries and sequences to find correct pdbentry for this
         // model
-        for (int pe = 0; pe < pdbentry.length; pe++)
+      for (int pe = 0; pe < getPdbCount(); pe++)
+      {
+        boolean matches = false;
+        if (fileName == null)
         {
-          boolean matches = false;
-          if (fileName == null)
+          if (false)
+          // see JAL-623 - need method of matching pasted data up
           {
-            if (false)
-            // see JAL-623 - need method of matching pasted data up
-            {
-              pdb = ssm.setMapping(sequence[pe], chains[pe], pdbfile,
-                      AppletFormatAdapter.PASTE);
-              pdbentry[modelnum].setFile("INLINE" + pdb.id);
-              matches = true;
-              foundEntry = true;
-            }
+            pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
+                    pdbfile, AppletFormatAdapter.PASTE);
+            getPdbEntry(modelnum).setFile("INLINE" + pdb.id);
+            matches = true;
+            foundEntry = true;
           }
-          else
+        }
+        else
+        {
+          File fl;
+          if (matches = (fl = new File(getPdbEntry(pe).getFile()))
+                  .equals(new File(fileName)))
           {
-            if (matches = pdbentry[pe].getFile().equals(fileName))
+            foundEntry = true;
+            // TODO: Jmol can in principle retrieve from CLASSLOADER but
+            // this
+            // needs
+            // to be tested. See mantis bug
+            // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
+            String protocol = AppletFormatAdapter.URL;
+            try
             {
-              foundEntry = true;
-              // TODO: Jmol can in principle retrieve from CLASSLOADER but
-              // this
-              // needs
-              // to be tested. See mantis bug
-              // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
-              String protocol = AppletFormatAdapter.URL;
-              try
-              {
-                File fl = new java.io.File(pdbentry[pe].getFile());
-                if (fl.exists())
-                {
-                  protocol = AppletFormatAdapter.FILE;
-                }
-              } catch (Exception e)
-              {
-              } catch (Error e)
+              if (fl.exists())
               {
+                protocol = AppletFormatAdapter.FILE;
               }
-              ;
-              pdb = ssm.setMapping(sequence[pe], chains[pe],
-                      pdbentry[pe].getFile(), protocol);
-
+            } catch (Exception e)
+            {
+            } catch (Error e)
+            {
             }
+            // Explicitly map to the filename used by Jmol ;
+            pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
+                    fileName, protocol);
+            // pdbentry[pe].getFile(), protocol);
+
           }
-          if (matches)
+        }
+        if (matches)
+        {
+          // add an entry for every chain in the model
+          for (int i = 0; i < pdb.chains.size(); i++)
           {
-            pdbentry[pe].setId(pdb.id);
-            // add an entry for every chain in the model
-            for (int i = 0; i < pdb.chains.size(); i++)
-            {
-              String chid = new String(pdb.id + ":"
-                      + ((MCview.PDBChain) pdb.chains.elementAt(i)).id);
-              chainFile.put(chid, pdbentry[pe].getFile());
-              chainNames.addElement(chid);
-            }
-            notifyLoaded = true;
+            String chid = new String(pdb.id + ":"
+                    + pdb.chains.elementAt(i).id);
+            chainFile.put(chid, fileName);
+            chainNames.addElement(chid);
           }
+          notifyLoaded = true;
         }
       }
+
       if (!foundEntry && associateNewStructs)
       {
         // this is a foreign pdb file that jalview doesn't know about - add
@@ -1270,10 +1266,9 @@ public abstract class JalviewJmolBinding implements StructureListener,
     {
       viewer.evalStringQuiet("model 0; select backbone;restrict;cartoon;wireframe off;spacefill off");
     }
-    setLoadingFromArchive(false);
     // register ourselves as a listener and notify the gui that it needs to
     // update itself.
-    ssm.addStructureViewerListener(this);
+    getSsm().addStructureViewerListener(this);
     if (notifyLoaded)
     {
       FeatureRenderer fr = getFeatureRenderer(null);
@@ -1284,6 +1279,7 @@ public abstract class JalviewJmolBinding implements StructureListener,
       refreshGUI();
       loadNotifiesHandled++;
     }
+    setLoadingFromArchive(false);
   }
 
   public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
@@ -1329,24 +1325,18 @@ public abstract class JalviewJmolBinding implements StructureListener,
     colourBySequence = false;
 
     if (cs == null)
+    {
       return;
+    }
 
-    String res;
-    int index;
-    Color col;
     jmolHistory(false);
-    // TODO: Switch between nucleotide or aa selection expressions
-    Enumeration en = ResidueProperties.aa3Hash.keys();
-    StringBuffer command = new StringBuffer("select *;color white;");
-    while (en.hasMoreElements())
+    StringBuilder command = new StringBuilder(128);
+    command.append("select *;color white;");
+    List<String> residueSet = ResidueProperties.getResidues(isNucleotide(),
+            false);
+    for (String res : residueSet)
     {
-      res = en.nextElement().toString();
-      index = ((Integer) ResidueProperties.aa3Hash.get(res)).intValue();
-      if (index > 20)
-        continue;
-
-      col = cs.findColour(ResidueProperties.aa[index].charAt(0));
-
+      Color col = cs.findColour(res.charAt(0));
       command.append("select " + res + ";color[" + col.getRed() + ","
               + col.getGreen() + "," + col.getBlue() + "];");
     }
@@ -1419,6 +1409,10 @@ public abstract class JalviewJmolBinding implements StructureListener,
           String commandOptions, final Container consolePanel,
           String buttonsToShow)
   {
+    if (commandOptions == null)
+    {
+      commandOptions = "";
+    }
     viewer = JmolViewer.allocateViewer(renderPanel,
             (jmolfileio ? new SmarterJmolAdapter() : null), htmlName
                     + ((Object) this).toString(), documentBase, codeBase,
@@ -1438,179 +1432,93 @@ public abstract class JalviewJmolBinding implements StructureListener,
 
   protected org.jmol.api.JmolAppConsoleInterface console = null;
 
-  public void componentResized(ComponentEvent e)
-  {
-
-  }
-
-  public void componentMoved(ComponentEvent e)
+  public void setBackgroundColour(java.awt.Color col)
   {
-
+    jmolHistory(false);
+    viewer.evalStringQuiet("background [" + col.getRed() + ","
+            + col.getGreen() + "," + col.getBlue() + "];");
+    jmolHistory(true);
   }
 
-  public void componentShown(ComponentEvent e)
+  /**
+   * 
+   * @param pdbfile
+   * @return text report of alignment between pdbfile and any associated
+   *         alignment sequences
+   */
+  public String printMapping(String pdbfile)
   {
-    showConsole(true);
+    return getSsm().printMapping(pdbfile);
   }
 
-  public void componentHidden(ComponentEvent e)
+  @Override
+  public void resizeInnerPanel(String data)
   {
-    showConsole(false);
-  }
+    // Jalview doesn't honour resize panel requests
 
-  public void setLoadingFromArchive(boolean loadingFromArchive)
-  {
-    this.loadingFromArchive = loadingFromArchive;
   }
 
-  public boolean isLoadingFromArchive()
+  public boolean isFinishedInit()
   {
-    return loadingFromArchive;
+    return finishedInit;
   }
 
-  public void setBackgroundColour(java.awt.Color col)
+  public void setFinishedInit(boolean finishedInit)
   {
-    jmolHistory(false);
-    viewer.evalStringQuiet("background [" + col.getRed() + ","
-            + col.getGreen() + "," + col.getBlue() + "];");
-    jmolHistory(true);
+    this.finishedInit = finishedInit;
   }
 
   /**
-   * add structures and any known sequence associations
    * 
-   * @returns the pdb entries added to the current set.
    */
-  public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe,
-          SequenceI[][] seq, String[][] chns)
+  protected void closeConsole()
   {
-    int pe = -1;
-    Vector v = new Vector();
-    Vector rtn = new Vector();
-    for (int i = 0; i < pdbentry.length; i++)
+    if (console != null)
     {
-      v.addElement(pdbentry[i]);
-    }
-    for (int i = 0; i < pdbe.length; i++)
-    {
-      int r = v.indexOf(pdbe[i]);
-      if (r == -1 || r >= pdbentry.length)
+      try
       {
-        rtn.addElement(new int[]
-        { v.size(), i });
-        v.addElement(pdbe[i]);
-      }
-      else
+        console.setVisible(false);
+      } catch (Error e)
       {
-        // just make sure the sequence/chain entries are all up to date
-        addSequenceAndChain(r, seq[i], chns[i]);
-      }
-    }
-    pdbe = new PDBEntry[v.size()];
-    v.copyInto(pdbe);
-    pdbentry = pdbe;
-    if (rtn.size() > 0)
-    {
-      // expand the tied seuqence[] and string[] arrays
-      SequenceI[][] sqs = new SequenceI[pdbentry.length][];
-      String[][] sch = new String[pdbentry.length][];
-      System.arraycopy(sequence, 0, sqs, 0, sequence.length);
-      System.arraycopy(chains, 0, sch, 0, this.chains.length);
-      sequence = sqs;
-      chains = sch;
-      pdbe = new PDBEntry[rtn.size()];
-      for (int r = 0; r < pdbe.length; r++)
+      } catch (Exception x)
       {
-        int[] stri = ((int[]) rtn.elementAt(r));
-        // record the pdb file as a new addition
-        pdbe[r] = pdbentry[stri[0]];
-        // and add the new sequence/chain entries
-        addSequenceAndChain(stri[0], seq[stri[1]], chns[stri[1]]);
       }
+      ;
+      console = null;
     }
-    else
-    {
-      pdbe = null;
-    }
-    return pdbe;
   }
 
-  public void addSequence(int pe, SequenceI[] seq)
+  /**
+   * ComponentListener method
+   */
+  @Override
+  public void componentMoved(ComponentEvent e)
   {
-    // add sequences to the pe'th pdbentry's seuqence set.
-    addSequenceAndChain(pe, seq, null);
   }
 
-  private void addSequenceAndChain(int pe, SequenceI[] seq, String[] tchain)
+  /**
+   * ComponentListener method
+   */
+  @Override
+  public void componentResized(ComponentEvent e)
   {
-    if (pe < 0 || pe >= pdbentry.length)
-    {
-      throw new Error(
-              "Implementation error - no corresponding pdbentry (for index "
-                      + pe + ") to add sequences mappings to");
-    }
-    final String nullChain = "TheNullChain";
-    Vector s = new Vector();
-    Vector c = new Vector();
-    if (chains == null)
-    {
-      chains = new String[pdbentry.length][];
-    }
-    if (sequence[pe] != null)
-    {
-      for (int i = 0; i < sequence[pe].length; i++)
-      {
-        s.addElement(sequence[pe][i]);
-        if (chains[pe] != null)
-        {
-          if (i < chains[pe].length)
-          {
-            c.addElement(chains[pe][i]);
-          }
-          else
-          {
-            c.addElement(nullChain);
-          }
-        }
-        else
-        {
-          if (tchain != null && tchain.length > 0)
-          {
-            c.addElement(nullChain);
-          }
-        }
-      }
-    }
-    for (int i = 0; i < seq.length; i++)
-    {
-      if (!s.contains(seq[i]))
-      {
-        s.addElement(seq[i]);
-        if (tchain != null && i < tchain.length)
-        {
-          c.addElement(tchain[i] == null ? nullChain : tchain[i]);
-        }
-      }
-    }
-    SequenceI[] tmp = new SequenceI[s.size()];
-    s.copyInto(tmp);
-    sequence[pe] = tmp;
-    if (c.size() > 0)
-    {
-      String[] tch = new String[c.size()];
-      c.copyInto(tch);
-      for (int i = 0; i < tch.length; i++)
-      {
-        if (tch[i] == nullChain)
-        {
-          tch[i] = null;
-        }
-      }
-      chains[pe] = tch;
-    }
-    else
-    {
-      chains[pe] = null;
-    }
+  }
+
+  /**
+   * ComponentListener method
+   */
+  @Override
+  public void componentShown(ComponentEvent e)
+  {
+    showConsole(true);
+  }
+
+  /**
+   * ComponentListener method
+   */
+  @Override
+  public void componentHidden(ComponentEvent e)
+  {
+    showConsole(false);
   }
 }