JAL-3518 removed unneeded override in ChimeraCommands
[jalview.git] / src / jalview / ext / rbvi / chimera / ChimeraCommands.java
index c52b9a2..780308d 100644 (file)
  */
 package jalview.ext.rbvi.chimera;
 
-import jalview.api.AlignViewportI;
-import jalview.api.AlignmentViewPanel;
-import jalview.api.FeatureRenderer;
-import jalview.api.SequenceRenderer;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.HiddenColumns;
-import jalview.datamodel.SequenceFeature;
-import jalview.datamodel.SequenceI;
-import jalview.renderer.seqfeatures.FeatureColourFinder;
-import jalview.structure.StructureMapping;
-import jalview.structure.StructureMappingcommandSet;
-import jalview.structure.StructureSelectionManager;
-import jalview.structures.models.AAStructureBindingModel;
-import jalview.util.ColorUtils;
-import jalview.util.Comparison;
-import jalview.util.IntRangeComparator;
-
 import java.awt.Color;
 import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.LinkedHashMap;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 
+import jalview.structure.AtomSpecModel;
+import jalview.structure.StructureCommand;
+import jalview.structure.StructureCommandI;
+import jalview.structure.StructureCommandsBase;
+import jalview.util.ColorUtils;
+
 /**
  * Routines for generating Chimera commands for Jalview/Chimera binding
  * 
  * @author JimP
+ * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/framecommand.html
  * 
  */
-public class ChimeraCommands
+public class ChimeraCommands extends StructureCommandsBase
 {
-  public static final String NAMESPACE_PREFIX = "jv_";
+  // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/focus.html
+  private static final StructureCommand FOCUS_VIEW = new StructureCommand("focus");
 
-  /*
-   * colour for residues shown in structure but hidden in alignment
-   */
-  private static final String COLOR_GRAY_HEX = "color "
-          + ColorUtils.toTkCode(Color.GRAY);
+  // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html#listresattr
+  private static final StructureCommand LIST_RESIDUE_ATTRIBUTES = new StructureCommand("list resattr");
 
-  /**
-   * Constructs Chimera commands to colour residues as per the Jalview alignment
-   * 
-   * @param files
-   * @param viewPanel
-   * @param binding
-   * @return
-   */
-  public static StructureMappingcommandSet[] getColourBySequenceCommand(
-          String[] files, AlignmentViewPanel viewPanel,
-          AAStructureBindingModel binding)
-  {
-    StructureSelectionManager ssm = binding.getSsm();
-    SequenceRenderer sr = binding.getSequenceRenderer(viewPanel);
-    SequenceI[][] sequence = binding.getSequence();
-    boolean hideHiddenRegions = binding.isShowAlignmentOnly()
-            && binding.isHideHiddenRegions();
+  // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/stop.html
+  private static final StructureCommand CLOSE_CHIMERA = new StructureCommand("stop really");
 
-    Map<Object, AtomSpecModel> colourMap = buildColoursMap(ssm, files,
-            sequence, sr, hideHiddenRegions, viewPanel);
+  // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html
+  private static final StructureCommand STOP_NOTIFY_SELECTION = new StructureCommand("listen stop selection");
 
-    List<String> colourCommands = buildColourCommands(colourMap, binding);
+  private static final StructureCommand STOP_NOTIFY_MODELS = new StructureCommand("listen stop models");
 
-    StructureMappingcommandSet cs = new StructureMappingcommandSet(
-            ChimeraCommands.class, null,
-            colourCommands.toArray(new String[colourCommands.size()]));
+  // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html#listselection
+  private static final StructureCommand GET_SELECTION = new StructureCommand("list selection level residue");
 
-    return new StructureMappingcommandSet[] { cs };
-  }
+  private static final StructureCommand SHOW_BACKBONE = new StructureCommand(
+          "~display all;~ribbon;chain @CA|P");
 
-  /**
-   * Traverse the map of colours/models/chains/positions to construct a list of
-   * 'color' commands (one per distinct colour used). The format of each command
-   * is
-   * 
-   * <pre>
-   * <blockquote> 
-   * color colorname #modelnumber:range.chain 
-   * e.g. color #00ff00 #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
-   * </blockquote>
-   * </pre>
-   * 
-   * @param colourMap
-   * @param binding
-   * @return
-   */
-  protected static List<String> buildColourCommands(
-          Map<Object, AtomSpecModel> colourMap,
-          AAStructureBindingModel binding)
-  {
-    /*
-     * This version concatenates all commands into a single String (semi-colon
-     * delimited). If length limit issues arise, refactor to return one color
-     * command per colour.
-     */
-    List<String> commands = new ArrayList<>();
-    StringBuilder sb = new StringBuilder(256);
-    sb.append(COLOR_GRAY_HEX);
+  private static final StructureCommandI COLOUR_BY_CHARGE = new StructureCommand(
+          "color white;color red ::ASP,GLU;color blue ::LYS,ARG;color yellow ::CYS");
 
-    for (Object key : colourMap.keySet())
-    {
-      Color colour = (Color) key;
-      String colourCode = ColorUtils.toTkCode(colour);
-      sb.append("; ");
-      sb.append("color ").append(colourCode).append(" ");
-      final AtomSpecModel colourData = colourMap.get(colour);
-      sb.append(getAtomSpec(colourData, binding));
-    }
-    commands.add(sb.toString());
-    return commands;
-  }
-
-  /**
-   * Build a data structure which records contiguous subsequences for each colour.
-   * From this we can easily generate the Chimera command for colour by sequence.
-   * 
-   * <pre>
-   * Color
-   *     Model number
-   *         Chain
-   *             list of start/end ranges
-   * </pre>
-   * 
-   * Ordering is by order of addition (for colours and positions), natural
-   * ordering (for models and chains)
-   * 
-   * @param ssm
-   * @param files
-   * @param sequence
-   * @param sr
-   * @param hideHiddenRegions
-   * @param viewPanel
-   * @return
-   */
-  protected static Map<Object, AtomSpecModel> buildColoursMap(
-          StructureSelectionManager ssm, String[] files,
-          SequenceI[][] sequence, SequenceRenderer sr,
-          boolean hideHiddenRegions, AlignmentViewPanel viewPanel)
-  {
-    FeatureRenderer fr = viewPanel.getFeatureRenderer();
-    FeatureColourFinder finder = new FeatureColourFinder(fr);
-    AlignViewportI viewport = viewPanel.getAlignViewport();
-    HiddenColumns cs = viewport.getAlignment().getHiddenColumns();
-    AlignmentI al = viewport.getAlignment();
-    Map<Object, AtomSpecModel> colourMap = new LinkedHashMap<>();
-    Color lastColour = null;
-
-    for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
-    {
-      StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
-
-      if (mapping == null || mapping.length < 1)
-      {
-        continue;
-      }
+  // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/rainbow.html
+  private static final StructureCommandI COLOUR_BY_CHAIN = new StructureCommand(
+          "rainbow chain");
 
-      int startPos = -1, lastPos = -1;
-      String lastChain = "";
-      for (int s = 0; s < sequence[pdbfnum].length; s++)
-      {
-        for (int sp, m = 0; m < mapping.length; m++)
-        {
-          final SequenceI seq = sequence[pdbfnum][s];
-          if (mapping[m].getSequence() == seq
-                  && (sp = al.findIndex(seq)) > -1)
-          {
-            SequenceI asp = al.getSequenceAt(sp);
-            for (int r = 0; r < asp.getLength(); r++)
-            {
-              // no mapping to gaps in sequence
-              if (Comparison.isGap(asp.getCharAt(r)))
-              {
-                continue;
-              }
-              int pos = mapping[m].getPDBResNum(asp.findPosition(r));
-
-              if (pos < 1 || pos == lastPos)
-              {
-                continue;
-              }
-
-              Color colour = sr.getResidueColour(seq, r, finder);
-
-              /*
-               * hidden regions are shown gray or, optionally, ignored
-               */
-              if (!cs.isVisible(r))
-              {
-                if (hideHiddenRegions)
-                {
-                  continue;
-                }
-                else
-                {
-                  colour = Color.GRAY;
-                }
-              }
-
-              final String chain = mapping[m].getChain();
-
-              /*
-               * Just keep incrementing the end position for this colour range
-               * _unless_ colour, PDB model or chain has changed, or there is a
-               * gap in the mapped residue sequence
-               */
-              final boolean newColour = !colour.equals(lastColour);
-              final boolean nonContig = lastPos + 1 != pos;
-              final boolean newChain = !chain.equals(lastChain);
-              if (newColour || nonContig || newChain)
-              {
-                if (startPos != -1)
-                {
-                  addColourRange(colourMap, lastColour, pdbfnum, startPos,
-                          lastPos, lastChain);
-                }
-                startPos = pos;
-              }
-              lastColour = colour;
-              lastPos = pos;
-              lastChain = chain;
-            }
-            // final colour range
-            if (lastColour != null)
-            {
-              addColourRange(colourMap, lastColour, pdbfnum, startPos,
-                      lastPos, lastChain);
-            }
-            // break;
-          }
-        }
-      }
-    }
-    return colourMap;
-  }
+  // Chimera clause to exclude alternate locations in atom selection
+  private static final String NO_ALTLOCS = "&~@.B-Z&~@.2-9";
 
-  /**
-   * Helper method to add one contiguous colour range to the colour map.
-   * 
-   * @param map
-   * @param key
-   * @param model
-   * @param startPos
-   * @param endPos
-   * @param chain
-   */
-  protected static void addColourRange(Map<Object, AtomSpecModel> map,
-          Object key, int model, int startPos, int endPos, String chain)
+  @Override
+  public StructureCommandI colourResidues(String atomSpec, Color colour)
   {
-    /*
-     * Get/initialize map of data for the colour
-     */
-    AtomSpecModel atomSpec = map.get(key);
-    if (atomSpec == null)
-    {
-      atomSpec = new AtomSpecModel();
-      map.put(key, atomSpec);
-    }
-
-    atomSpec.addRange(model, startPos, endPos, chain);
-  }
-
-  /**
-   * Constructs and returns Chimera commands to set attributes on residues
-   * corresponding to features in Jalview. Attribute names are the Jalview feature
-   * type, with a "jv_" prefix.
-   * 
-   * @param ssm
-   * @param files
-   * @param seqs
-   * @param viewPanel
-   * @param binding
-   * @return
-   */
-  public static StructureMappingcommandSet getSetAttributeCommandsForFeatures(
-          AlignmentViewPanel viewPanel, AAStructureBindingModel binding)
-  {
-    StructureSelectionManager ssm = binding.getSsm();
-    String[] files = binding.getStructureFiles();
-    SequenceI[][] seqs = binding.getSequence();
-
-    Map<String, Map<Object, AtomSpecModel>> featureMap = buildFeaturesMap(
-            ssm, files, seqs, viewPanel);
-
-    List<String> commands = buildSetAttributeCommands(featureMap, binding);
-
-    StructureMappingcommandSet cs = new StructureMappingcommandSet(
-            ChimeraCommands.class, null,
-            commands.toArray(new String[commands.size()]));
-
-    return cs;
+    // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/color.html
+    String colourCode = getColourString(colour);
+    return new StructureCommand("color " + colourCode + " " + atomSpec);
   }
 
   /**
-   * <pre>
-   * Helper method to build a map of 
-   *   { featureType, { feature value, AtomSpecModel } }
-   * </pre>
+   * Returns a colour formatted suitable for use in viewer command syntax
    * 
-   * @param ssm
-   * @param files
-   * @param seqs
-   * @param viewPanel
+   * @param colour
    * @return
    */
-  protected static Map<String, Map<Object, AtomSpecModel>> buildFeaturesMap(
-          StructureSelectionManager ssm, String[] files, SequenceI[][] seqs,
-          AlignmentViewPanel viewPanel)
-  {
-    Map<String, Map<Object, AtomSpecModel>> theMap = new LinkedHashMap<>();
-
-    FeatureRenderer fr = viewPanel.getFeatureRenderer();
-    if (fr == null)
-    {
-      return theMap;
-    }
-
-    List<String> visibleFeatures = fr.getDisplayedFeatureTypes();
-    if (visibleFeatures.isEmpty())
-    {
-      return theMap;
-    }
-
-    AlignmentI alignment = viewPanel.getAlignment();
-    for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
-    {
-      StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
-
-      if (mapping == null || mapping.length < 1)
-      {
-        continue;
-      }
-
-      for (int seqNo = 0; seqNo < seqs[pdbfnum].length; seqNo++)
-      {
-        for (int m = 0; m < mapping.length; m++)
-        {
-          final SequenceI seq = seqs[pdbfnum][seqNo];
-          int sp = alignment.findIndex(seq);
-          if (mapping[m].getSequence() == seq && sp > -1)
-          {
-            /*
-             * found a sequence with a mapping to a structure;
-             * now scan its features
-             */
-            SequenceI asp = alignment.getSequenceAt(sp);
-
-            scanSequenceFeatures(visibleFeatures, mapping[m], asp, theMap,
-                    pdbfnum);
-          }
-        }
-      }
-    }
-    return theMap;
-  }
-
-  /**
-   * Inspect features on the sequence; for each feature that is visible,
-   * determine its mapped ranges in the structure (if any) according to the
-   * given mapping, and add them to the map
-   * 
-   * @param visibleFeatures
-   * @param mapping
-   * @param seq
-   * @param theMap
-   * @param modelNumber
-   */
-  protected static void scanSequenceFeatures(List<String> visibleFeatures,
-          StructureMapping mapping, SequenceI seq,
-          Map<String, Map<Object, AtomSpecModel>> theMap, int modelNumber)
+  protected String getColourString(Color colour)
   {
-    List<SequenceFeature> sfs = seq.getFeatures().getPositionalFeatures(
-            visibleFeatures.toArray(new String[visibleFeatures.size()]));
-    for (SequenceFeature sf : sfs)
-    {
-      String type = sf.getType();
-
-      /*
-       * Only copy visible features, don't copy any which originated
-       * from Chimera, and suppress uninteresting ones (e.g. RESNUM)
-       */
-      boolean isFromViewer = JalviewChimeraBinding.CHIMERA_FEATURE_GROUP
-              .equals(sf.getFeatureGroup());
-      if (isFromViewer)
-      {
-        continue;
-      }
-      List<int[]> mappedRanges = mapping.getPDBResNumRanges(sf.getBegin(),
-              sf.getEnd());
-
-      if (!mappedRanges.isEmpty())
-      {
-        String value = sf.getDescription();
-        if (value == null || value.length() == 0)
-        {
-          value = type;
-        }
-        float score = sf.getScore();
-        if (score != 0f && !Float.isNaN(score))
-        {
-          value = Float.toString(score);
-        }
-        Map<Object, AtomSpecModel> featureValues = theMap.get(type);
-        if (featureValues == null)
-        {
-          featureValues = new HashMap<>();
-          theMap.put(type, featureValues);
-        }
-        for (int[] range : mappedRanges)
-        {
-          addColourRange(featureValues, value, modelNumber, range[0],
-                  range[1], mapping.getChain());
-        }
-      }
-    }
+    return ColorUtils.toTkCode(colour);
   }
 
   /**
@@ -446,7 +98,7 @@ public class ChimeraCommands
    * 
    * <pre>
    * <blockquote> setattr r <featureName> " " #modelnumber:range.chain 
-   * e.g. setattr r jv:chain <value> #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
+   * e.g. setattr r jv_chain &lt;value&gt; #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
    * </blockquote>
    * </pre>
    * 
@@ -454,11 +106,11 @@ public class ChimeraCommands
    * @param binding
    * @return
    */
-  protected static List<String> buildSetAttributeCommands(
-          Map<String, Map<Object, AtomSpecModel>> featureMap,
-          AAStructureBindingModel binding)
+  @Override
+  public List<StructureCommandI> setAttributes(
+          Map<String, Map<Object, AtomSpecModel>> featureMap)
   {
-    List<String> commands = new ArrayList<>();
+    List<StructureCommandI> commands = new ArrayList<>();
     for (String featureType : featureMap.keySet())
     {
       String attributeName = makeAttributeName(featureType);
@@ -477,13 +129,12 @@ public class ChimeraCommands
          * add a command to set the attribute on the mapped residues
          * Put values in single quotes, encoding any embedded single quotes
          */
-        StringBuilder sb = new StringBuilder(128);
+        AtomSpecModel atomSpecModel = values.get(value);
         String featureValue = value.toString();
         featureValue = featureValue.replaceAll("\\'", "&#39;");
-        sb.append("setattr r ").append(attributeName).append(" '")
-                .append(featureValue).append("' ");
-        sb.append(getAtomSpec(values.get(value), binding));
-        commands.add(sb.toString());
+        StructureCommandI cmd = setAttribute(attributeName, featureValue,
+                atomSpecModel);
+        commands.add(cmd);
       }
     }
 
@@ -491,28 +142,42 @@ public class ChimeraCommands
   }
 
   /**
+   * Returns a viewer command to set the given residue attribute value on
+   * residues specified by the AtomSpecModel, for example
+   * 
+   * <pre>
+   * setatr res jv_chain 'primary' #1:12-34,48-55.B
+   * </pre>
+   * 
+   * @param attributeName
+   * @param attributeValue
+   * @param atomSpecModel
+   * @return
+   */
+  protected StructureCommandI setAttribute(String attributeName,
+          String attributeValue,
+          AtomSpecModel atomSpecModel)
+  {
+    StringBuilder sb = new StringBuilder(128);
+    sb.append("setattr res ").append(attributeName).append(" '")
+            .append(attributeValue).append("' ");
+    sb.append(getAtomSpec(atomSpecModel, false));
+    return new StructureCommand(sb.toString());
+  }
+
+  /**
    * Makes a prefixed and valid Chimera attribute name. A jv_ prefix is applied
    * for a 'Jalview' namespace, and any non-alphanumeric character is converted
    * to an underscore.
    * 
    * @param featureType
    * @return
-   * 
-   *         <pre>
-   * &#64;see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
-   *         </pre>
+   * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
    */
-  protected static String makeAttributeName(String featureType)
+  @Override
+  protected String makeAttributeName(String featureType)
   {
-    StringBuilder sb = new StringBuilder();
-    if (featureType != null)
-    {
-      for (char c : featureType.toCharArray())
-      {
-        sb.append(Character.isLetterOrDigit(c) ? c : '_');
-      }
-    }
-    String attName = NAMESPACE_PREFIX + sb.toString();
+    String attName = super.makeAttributeName(featureType);
 
     /*
      * Chimera treats an attribute name ending in 'color' as colour-valued;
@@ -526,111 +191,247 @@ public class ChimeraCommands
     return attName;
   }
 
+  @Override
+  public StructureCommandI colourByChain()
+  {
+    return COLOUR_BY_CHAIN;
+  }
+
+  @Override
+  public List<StructureCommandI> colourByCharge()
+  {
+    return Arrays.asList(COLOUR_BY_CHARGE);
+  }
+
+  @Override
+  public String getResidueSpec(String residue)
+  {
+    return "::" + residue;
+  }
+
+  @Override
+  public StructureCommandI setBackgroundColour(Color col)
+  {
+    // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/set.html#bgcolor
+    return new StructureCommand("set bgColor " + ColorUtils.toTkCode(col));
+  }
+
+  @Override
+  public StructureCommandI focusView()
+  {
+    return FOCUS_VIEW;
+  }
+
+  @Override
+  public List<StructureCommandI> superposeStructures(AtomSpecModel ref,
+          AtomSpecModel spec)
+  {
+    /*
+     * Form Chimera match command to match spec to ref
+     * (the first set of atoms are moved on to the second)
+     * 
+     * match #1:1-30.B,81-100.B@CA #0:21-40.A,61-90.A@CA
+     * 
+     * @see https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/midas/match.html
+     */
+    StringBuilder cmd = new StringBuilder();
+    String atomSpecAlphaOnly = getAtomSpec(spec, true);
+    String refSpecAlphaOnly = getAtomSpec(ref, true);
+    cmd.append("match ").append(atomSpecAlphaOnly).append(" ").append(refSpecAlphaOnly);
+
+    /*
+     * show superposed residues as ribbon
+     */
+    String atomSpec = getAtomSpec(spec, false);
+    String refSpec = getAtomSpec(ref, false);
+    cmd.append("; ribbon ");
+    cmd.append(atomSpec).append("|").append(refSpec).append("; focus");
+
+    return Arrays.asList(new StructureCommand(cmd.toString()));
+  }
+
+  @Override
+  public StructureCommandI openCommandFile(String path)
+  {
+    // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/filetypes.html
+    return new StructureCommand("open cmd:" + path);
+  }
+
+  @Override
+  public StructureCommandI saveSession(String filepath)
+  {
+    // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/save.html
+    return new StructureCommand("save " + filepath);
+  }
+
   /**
-   * Returns the range(s) formatted as a Chimera atomspec
+   * Returns the range(s) modelled by {@code atomSpec} formatted as a Chimera
+   * atomspec string, e.g.
    * 
+   * <pre>
+   * #0:15.A,28.A,54.A,70-72.A|#1:2.A,6.A,11.A,13-14.A
+   * </pre>
+   * 
+   * where
+   * <ul>
+   * <li>#0 is a model number</li>
+   * <li>15 or 70-72 is a residue number, or range of residue numbers</li>
+   * <li>.A is a chain identifier</li>
+   * <li>residue ranges are separated by comma</li>
+   * <li>atomspecs for distinct models are separated by | (or)</li>
+   * </ul>
+   * 
+   * <pre>
+   * 
+   * @param model
+   * @param alphaOnly
    * @return
+   * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/frameatom_spec.html
    */
-  public static String getAtomSpec(AtomSpecModel atomSpec,
-          AAStructureBindingModel binding)
+  @Override
+  public String getAtomSpec(AtomSpecModel atomSpec, boolean alphaOnly)
   {
     StringBuilder sb = new StringBuilder(128);
     boolean firstModel = true;
-    for (Integer model : atomSpec.getModels())
+    for (String model : atomSpec.getModels())
     {
       if (!firstModel)
       {
         sb.append("|");
       }
       firstModel = false;
-      // todo use JalviewChimeraBinding.getModelSpec(model)
-      // which means this cannot be static
-      sb.append(binding.getModelSpec(model)).append(":");
-
-      boolean firstPositionForModel = true;
-
-      for (String chain : atomSpec.getChains(model))
-      {
-        chain = " ".equals(chain) ? chain : chain.trim();
-
-        List<int[]> rangeList = atomSpec.getRanges(model, chain);
-
-        /*
-         * sort ranges into ascending start position order
-         */
-        Collections.sort(rangeList, IntRangeComparator.ASCENDING);
-
-        int start = rangeList.isEmpty() ? 0 : rangeList.get(0)[0];
-        int end = rangeList.isEmpty() ? 0 : rangeList.get(0)[1];
-
-        Iterator<int[]> iterator = rangeList.iterator();
-        while (iterator.hasNext())
-        {
-          int[] range = iterator.next();
-          if (range[0] <= end + 1)
-          {
-            /*
-             * range overlaps or is contiguous with the last one
-             * - so just extend the end position, and carry on
-             * (unless this is the last in the list)
-             */
-            end = Math.max(end, range[1]);
-          }
-          else
-          {
-            /*
-             * we have a break so append the last range
-             */
-            appendRange(sb, start, end, chain, firstPositionForModel);
-            firstPositionForModel = false;
-            start = range[0];
-            end = range[1];
-          }
-        }
-
-        /*
-         * and append the last range
-         */
-        if (!rangeList.isEmpty())
-        {
-          appendRange(sb, start, end, chain, firstPositionForModel);
-          firstPositionForModel = false;
-        }
-      }
+      appendModel(sb, model, atomSpec, alphaOnly);
     }
     return sb.toString();
   }
 
   /**
-   * A helper method that appends one start-end range to a Chimera atomspec
+   * A helper method to append an atomSpec string for atoms in the given model
    * 
    * @param sb
-   * @param start
-   * @param end
-   * @param chain
-   * @param firstPositionForModel
+   * @param model
+   * @param atomSpec
+   * @param alphaOnly
    */
-  static void appendRange(StringBuilder sb, int start, int end,
-          String chain, boolean firstPositionForModel)
+  protected void appendModel(StringBuilder sb, String model,
+          AtomSpecModel atomSpec, boolean alphaOnly)
   {
-    if (!firstPositionForModel)
-    {
-      sb.append(",");
-    }
-    if (end == start)
+    sb.append("#").append(model).append(":");
+
+    boolean firstPositionForModel = true;
+
+    for (String chain : atomSpec.getChains(model))
     {
-      sb.append(start);
+      chain = " ".equals(chain) ? chain : chain.trim();
+
+      List<int[]> rangeList = atomSpec.getRanges(model, chain);
+      for (int[] range : rangeList)
+      {
+        appendRange(sb, range[0], range[1], chain, firstPositionForModel,
+                false);
+        firstPositionForModel = false;
+      }
     }
-    else
+    if (alphaOnly)
     {
-      sb.append(start).append("-").append(end);
+      /*
+       * restrict to alpha carbon, no alternative locations
+       * (needed to ensuring matching atom counts for superposition)
+       */
+      // TODO @P instead if RNA - add nucleotide flag to AtomSpecModel?
+      sb.append("@CA").append(NO_ALTLOCS);
     }
+  }
+
+  @Override
+  public List<StructureCommandI> showBackbone()
+  {
+    return Arrays.asList(SHOW_BACKBONE);
+  }
+
+  @Override
+  public StructureCommandI loadFile(String file)
+  {
+    return new StructureCommand("open " + file);
+  }
+
+  @Override
+  public StructureCommandI openSession(String filepath)
+  {
+    // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/filetypes.html
+    // this version of the command has no dependency on file extension
+    return new StructureCommand("open chimera:" + filepath);
+  }
 
-    sb.append(".");
-    if (!" ".equals(chain))
+  @Override
+  public StructureCommandI showStructures(AtomSpecModel restrictTo)
+  {
+    if (restrictTo == null)
     {
-      sb.append(chain);
+      return new StructureCommand("ribbon");
     }
+
+    String atomSpec = getAtomSpec(restrictTo, false);
+    String cmd = "ribbon " + atomSpec;
+    return new StructureCommand(cmd);
+  }
+
+  @Override
+  public StructureCommandI hideChain(String modelId, String chainId)
+  {
+    String what = "#" + modelId + ":." + chainId;
+    return new StructureCommand("~ribbon " + what + ";~display " + what);
+  }
+
+  @Override
+  public StructureCommandI hideAll()
+  {
+    return new StructureCommand("~display; ~ribbon");
+  }
+  public StructureCommandI closeViewer()
+  {
+    return CLOSE_CHIMERA;
+  }
+
+  @Override
+  public List<StructureCommandI> startNotifications(String uri)
+  {
+    // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html
+    List<StructureCommandI> cmds = new ArrayList<>();
+    cmds.add(new StructureCommand("listen start models url " + uri));
+    cmds.add(new StructureCommand("listen start select prefix SelectionChanged url " + uri));
+    return cmds;
+  }
+
+  @Override
+  public List<StructureCommandI> stopNotifications()
+  {
+    List<StructureCommandI> cmds = new ArrayList<>();
+    cmds.add(STOP_NOTIFY_MODELS);
+    cmds.add(STOP_NOTIFY_SELECTION);
+    return cmds;
+  }
+
+  @Override
+  public StructureCommandI getSelectedResidues()
+  {
+    return GET_SELECTION;
+  }
+
+  @Override
+  public StructureCommandI listResidueAttributes()
+  {
+    return LIST_RESIDUE_ATTRIBUTES;
+  }
+
+  @Override
+  public StructureCommandI getResidueAttributes(String attName)
+  {
+    // this alternative command
+    // list residues spec ':*/attName' attr attName
+    // doesn't report 'None' values (which is good), but
+    // fails for 'average.bfactor' (which is bad):
+    return new StructureCommand("list residues attr '" + attName + "'");
   }
 
 }