Merge develop to Release_2_8_3_Branch
[jalview.git] / src / jalview / structure / StructureSelectionManager.java
index 502c68e..ed5ee2d 100644 (file)
 /*
- * 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.structure;
 
-import java.io.*;
-import java.util.*;
+import jalview.analysis.AlignSeq;
+import jalview.api.StructureSelectionManagerProvider;
+import jalview.commands.CommandI;
+import jalview.commands.EditCommand;
+import jalview.commands.OrderCommand;
+import jalview.datamodel.AlignedCodonFrame;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Annotation;
+import jalview.datamodel.PDBEntry;
+import jalview.datamodel.SearchResults;
+import jalview.datamodel.SequenceI;
+import jalview.io.AppletFormatAdapter;
+import jalview.util.MappingUtils;
+import jalview.util.MessageManager;
+
+import java.io.PrintStream;
+import java.util.ArrayList;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.IdentityHashMap;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.Vector;
 
-import MCview.*;
-import jalview.analysis.*;
-import jalview.datamodel.*;
+import MCview.Atom;
+import MCview.PDBChain;
 
 public class StructureSelectionManager
 {
-  static StructureSelectionManager instance;
+  static IdentityHashMap<StructureSelectionManagerProvider, StructureSelectionManager> instances;
+
+  private List<StructureMapping> mappings = new ArrayList<StructureMapping>();
+
+  private boolean processSecondaryStructure = false;
+
+  private boolean secStructServices = false;
+
+  private boolean addTempFacAnnot = false;
+
+  /*
+   * Set of any registered mappings between (dataset) sequences.
+   */
+  Set<AlignedCodonFrame> seqmappings = new LinkedHashSet<AlignedCodonFrame>();
+
+  /*
+   * Reference counters for the above mappings. Remove mappings when ref count
+   * goes to zero.
+   */
+  Map<AlignedCodonFrame, Integer> seqMappingRefCounts = new HashMap<AlignedCodonFrame, Integer>();
+
+  private List<CommandListener> commandListeners = new ArrayList<CommandListener>();
 
-  StructureMapping[] mappings;
+  private List<SelectionListener> sel_listeners = new ArrayList<SelectionListener>();
+
+  /**
+   * @return true if will try to use external services for processing secondary
+   *         structure
+   */
+  public boolean isSecStructServices()
+  {
+    return secStructServices;
+  }
+
+  /**
+   * control use of external services for processing secondary structure
+   * 
+   * @param secStructServices
+   */
+  public void setSecStructServices(boolean secStructServices)
+  {
+    this.secStructServices = secStructServices;
+  }
+
+  /**
+   * flag controlling addition of any kind of structural annotation
+   * 
+   * @return true if temperature factor annotation will be added
+   */
+  public boolean isAddTempFacAnnot()
+  {
+    return addTempFacAnnot;
+  }
+
+  /**
+   * set flag controlling addition of structural annotation
+   * 
+   * @param addTempFacAnnot
+   */
+  public void setAddTempFacAnnot(boolean addTempFacAnnot)
+  {
+    this.addTempFacAnnot = addTempFacAnnot;
+  }
+
+  /**
+   * 
+   * @return if true, the structure manager will attempt to add secondary
+   *         structure lines for unannotated sequences
+   */
+
+  public boolean isProcessSecondaryStructure()
+  {
+    return processSecondaryStructure;
+  }
+
+  /**
+   * Control whether structure manager will try to annotate mapped sequences
+   * with secondary structure from PDB data.
+   * 
+   * @param enable
+   */
+  public void setProcessSecondaryStructure(boolean enable)
+  {
+    processSecondaryStructure = enable;
+  }
 
   /**
    * debug function - write all mappings to stdout
    */
-  public void reportMapping() {\r
-    if (mappings==null)\r
-    {\r
-      System.err.println("reportMapping: No PDB/Sequence mappings.");\r
-    }else{\r
-      System.err.println("reportMapping: There are "+mappings.length+" mappings.");\r
-      for (int m=0;m<mappings.length;m++)\r
-      {\r
-        System.err.println("mapping "+m+" : "+mappings[m].pdbfile);\r
-      }\r
-    }\r
-  }\r
-  Hashtable mappingData = new Hashtable();
-
-  public static StructureSelectionManager getStructureSelectionManager()
+  public void reportMapping()
   {
-    if (instance == null)
+    if (mappings.isEmpty())
     {
-      instance = new StructureSelectionManager();
+      System.err.println("reportMapping: No PDB/Sequence mappings.");
+    }
+    else
+    {
+      System.err.println("reportMapping: There are " + mappings.size()
+              + " mappings.");
+      int i = 0;
+      for (StructureMapping sm : mappings)
+      {
+        System.err.println("mapping " + i++ + " : " + sm.pdbfile);
+      }
     }
+  }
+
+  /**
+   * map between the PDB IDs (or structure identifiers) used by Jalview and the
+   * absolute filenames for PDB data that corresponds to it
+   */
+  HashMap<String, String> pdbIdFileName = new HashMap<String, String>(),
+          pdbFileNameId = new HashMap<String, String>();
+
+  public void registerPDBFile(String idForFile, String absoluteFile)
+  {
+    pdbIdFileName.put(idForFile, absoluteFile);
+    pdbFileNameId.put(absoluteFile, idForFile);
+  }
+
+  public String findIdForPDBFile(String idOrFile)
+  {
+    String id = pdbFileNameId.get(idOrFile);
+    return id;
+  }
+
+  public String findFileForPDBId(String idOrFile)
+  {
+    String id = pdbIdFileName.get(idOrFile);
+    return id;
+  }
+
+  public boolean isPDBFileRegistered(String idOrFile)
+  {
+    return pdbFileNameId.containsKey(idOrFile)
+            || pdbIdFileName.containsKey(idOrFile);
+  }
+
+  private static StructureSelectionManager nullProvider = null;
 
+  public static StructureSelectionManager getStructureSelectionManager(
+          StructureSelectionManagerProvider context)
+  {
+    if (context == null)
+    {
+      if (nullProvider == null)
+      {
+        if (instances != null)
+        {
+          throw new Error(MessageManager.getString("error.implementation_error_structure_selection_manager_null"),
+                  new NullPointerException(MessageManager.getString("exception.ssm_context_is_null")));
+        }
+        else
+        {
+          nullProvider = new StructureSelectionManager();
+        }
+        return nullProvider;
+      }
+    }
+    if (instances == null)
+    {
+      instances = new java.util.IdentityHashMap<StructureSelectionManagerProvider, StructureSelectionManager>();
+    }
+    StructureSelectionManager instance = instances.get(context);
+    if (instance == null)
+    {
+      if (nullProvider != null)
+      {
+        instance = nullProvider;
+      }
+      else
+      {
+        instance = new StructureSelectionManager();
+      }
+      instances.put(context, instance);
+    }
     return instance;
   }
 
@@ -90,6 +264,7 @@ public class StructureSelectionManager
 
   /**
    * register a listener for alignment sequence mouseover events
+   * 
    * @param svl
    */
   public void addStructureViewerListener(Object svl)
@@ -100,25 +275,52 @@ public class StructureSelectionManager
     }
   }
 
+  /**
+   * Returns the file name for a mapped PDB id (or null if not mapped).
+   * 
+   * @param pdbid
+   * @return
+   */
   public String alreadyMappedToFile(String pdbid)
   {
-    if (mappings != null)
+    for (StructureMapping sm : mappings)
     {
-      for (int i = 0; i < mappings.length; i++)
+      if (sm.getPdbId().equals(pdbid))
       {
-        if (mappings[i].getPdbId().equals(pdbid))
-        {
-          return mappings[i].pdbfile;
-        }
+        return sm.pdbfile;
       }
     }
     return null;
   }
 
   /**
+   * Import structure data and register a structure mapping for broadcasting
+   * colouring, mouseovers and selection events (convenience wrapper).
+   * 
+   * @param sequence
+   *          - one or more sequences to be mapped to pdbFile
+   * @param targetChains
+   *          - optional chain specification for mapping each sequence to pdb
+   *          (may be nill, individual elements may be nill)
+   * @param pdbFile
+   *          - structure data resource
+   * @param protocol
+   *          - how to resolve data from resource
+   * @return null or the structure data parsed as a pdb file
+   */
+  synchronized public MCview.PDBfile setMapping(SequenceI[] sequence,
+          String[] targetChains, String pdbFile, String protocol)
+  {
+    return setMapping(true, sequence, targetChains, pdbFile, protocol);
+  }
+
+  /**
    * create sequence structure mappings between each sequence and the given
    * pdbFile (retrieved via the given protocol).
    * 
+   * @param forStructureView
+   *          when true, record the mapping for use in mouseOvers
+   * 
    * @param sequence
    *          - one or more sequences to be mapped to pdbFile
    * @param targetChains
@@ -130,7 +332,8 @@ public class StructureSelectionManager
    *          - how to resolve data from resource
    * @return null or the structure data parsed as a pdb file
    */
-  synchronized public MCview.PDBfile setMapping(SequenceI[] sequence,
+  synchronized public MCview.PDBfile setMapping(boolean forStructureView,
+          SequenceI[] sequence,
           String[] targetChains, String pdbFile, String protocol)
   {
     /*
@@ -138,9 +341,42 @@ public class StructureSelectionManager
      * the tried and tested MCview pdb mapping
      */
     MCview.PDBfile pdb = null;
+    boolean parseSecStr = processSecondaryStructure;
+    if (isPDBFileRegistered(pdbFile))
+    {
+      for (SequenceI sq : sequence)
+      {
+        SequenceI ds = sq;
+        while (ds.getDatasetSequence() != null)
+        {
+          ds = ds.getDatasetSequence();
+        }
+        ;
+        if (ds.getAnnotation() != null)
+        {
+          for (AlignmentAnnotation ala : ds.getAnnotation())
+          {
+            // false if any annotation present from this structure
+            // JBPNote this fails for jmol/chimera view because the *file* is
+            // passed, not the structure data ID -
+            if (MCview.PDBfile.isCalcIdForFile(ala,
+                    findIdForPDBFile(pdbFile)))
+            {
+              parseSecStr = false;
+            }
+          }
+        }
+      }
+    }
     try
     {
-      pdb = new MCview.PDBfile(pdbFile, protocol);
+      pdb = new MCview.PDBfile(addTempFacAnnot, parseSecStr,
+              secStructServices, pdbFile, protocol);
+      if (pdb.id != null && pdb.id.trim().length() > 0
+              && AppletFormatAdapter.FILE.equals(protocol))
+      {
+        registerPDBFile(pdb.id.trim(), pdbFile);
+      }
     } catch (Exception ex)
     {
       ex.printStackTrace();
@@ -150,15 +386,33 @@ public class StructureSelectionManager
     String targetChain;
     for (int s = 0; s < sequence.length; s++)
     {
+      boolean infChain = true;
       if (targetChains != null && targetChains[s] != null)
+      {
+        infChain = false;
         targetChain = targetChains[s];
+      }
       else if (sequence[s].getName().indexOf("|") > -1)
       {
         targetChain = sequence[s].getName().substring(
                 sequence[s].getName().lastIndexOf("|") + 1);
+        if (targetChain.length() > 1)
+        {
+          if (targetChain.trim().length() == 0)
+          {
+            targetChain = " ";
+          }
+          else
+          {
+            // not a valid chain identifier
+            targetChain = "";
+          }
+        }
       }
       else
+      {
         targetChain = "";
+      }
 
       int max = -10;
       AlignSeq maxAlignseq = null;
@@ -167,19 +421,17 @@ public class StructureSelectionManager
       boolean first = true;
       for (int i = 0; i < pdb.chains.size(); i++)
       {
-        // TODO: re http://issues.jalview.org/browse/JAL-583 : this patch may
-        // need to be revoked
-        PDBChain chain = ((PDBChain) pdb.chains.elementAt(i));
-        if (targetChain.length() > 0 && !targetChain.equals(chain.id))
+        PDBChain chain = (pdb.chains.elementAt(i));
+        if (targetChain.length() > 0 && !targetChain.equals(chain.id)
+                && !infChain)
         {
           continue; // don't try to map chains don't match.
         }
-        // end of patch for limiting computed mappings
         // TODO: correctly determine sequence type for mixed na/peptide
         // structures
         AlignSeq as = new AlignSeq(sequence[s],
-                ((PDBChain) pdb.chains.elementAt(i)).sequence,
-                ((PDBChain) pdb.chains.elementAt(i)).isNa ? AlignSeq.DNA
+                pdb.chains.elementAt(i).sequence,
+                pdb.chains.elementAt(i).isNa ? AlignSeq.DNA
                         : AlignSeq.PEP);
         as.calcScoreMatrix();
         as.traceAlignment();
@@ -205,11 +457,13 @@ public class StructureSelectionManager
               + maxChain.residues.size() + "\n\n");
       PrintStream ps = new PrintStream(System.out)
       {
+        @Override
         public void print(String x)
         {
           mappingDetails.append(x);
         }
 
+        @Override
         public void println()
         {
           mappingDetails.append("\n");
@@ -225,12 +479,16 @@ public class StructureSelectionManager
               + (maxAlignseq.seq1end + sequence[s].getEnd() - 1));
 
       maxChain.makeExactMapping(maxAlignseq, sequence[s]);
-
+      jalview.datamodel.Mapping sqmpping = maxAlignseq
+              .getMappingFromS1(false);
+      jalview.datamodel.Mapping omap = new jalview.datamodel.Mapping(
+              sqmpping.getMap().getInverse());
       maxChain.transferRESNUMFeatures(sequence[s], null);
 
       // allocate enough slots to store the mapping from positions in
       // sequence[s] to the associated chain
-      int[][] mapping = new int[sequence[s].findPosition(sequence[s].getLength()) + 2][2];
+      int[][] mapping = new int[sequence[s].findPosition(sequence[s]
+              .getLength()) + 2][2];
       int resNum = -10000;
       int index = 0;
 
@@ -247,24 +505,18 @@ public class StructureSelectionManager
         index++;
       } while (index < maxChain.atoms.size());
 
-      if (mappings == null)
-      {
-        mappings = new StructureMapping[1];
-      }
-      else
-      {
-        StructureMapping[] tmp = new StructureMapping[mappings.length + 1];
-        System.arraycopy(mappings, 0, tmp, 0, mappings.length);
-        mappings = tmp;
-      }
-
       if (protocol.equals(jalview.io.AppletFormatAdapter.PASTE))
+      {
         pdbFile = "INLINE" + pdb.id;
-
-      mappings[mappings.length - 1] = new StructureMapping(sequence[s],
+      }
+      StructureMapping newMapping = new StructureMapping(sequence[s],
               pdbFile, pdb.id, maxChainId, mapping,
               mappingDetails.toString());
-      maxChain.transferResidueAnnotation(mappings[mappings.length - 1]);
+      if (forStructureView)
+      {
+        mappings.add(newMapping);
+      }
+      maxChain.transferResidueAnnotation(newMapping, sqmpping);
     }
     // ///////
 
@@ -276,24 +528,26 @@ public class StructureSelectionManager
     listeners.removeElement(svl);
     if (svl instanceof SequenceListener)
     {
-      for (int i=0;i<listeners.size();i++)
+      for (int i = 0; i < listeners.size(); i++)
       {
         if (listeners.elementAt(i) instanceof StructureListener)
         {
-          ((StructureListener)listeners.elementAt(i)).releaseReferences(svl);
+          ((StructureListener) listeners.elementAt(i))
+                  .releaseReferences(svl);
         }
       }
     }
-      
+
     if (pdbfiles == null)
     {
       return;
     }
-    boolean removeMapping = true;
     String[] handlepdbs;
     Vector pdbs = new Vector();
     for (int i = 0; i < pdbfiles.length; pdbs.addElement(pdbfiles[i++]))
+    {
       ;
+    }
     StructureListener sl;
     for (int i = 0; i < listeners.size(); i++)
     {
@@ -312,25 +566,28 @@ public class StructureSelectionManager
       }
     }
 
-    if (pdbs.size() > 0 && mappings != null)
+    if (pdbs.size() > 0)
     {
-      Vector tmp = new Vector();
-      for (int i = 0; i < mappings.length; i++)
+      List<StructureMapping> tmp = new ArrayList<StructureMapping>();
+      for (StructureMapping sm : mappings)
       {
-        if (!pdbs.contains(mappings[i].pdbfile))
+        if (!pdbs.contains(sm.pdbfile))
         {
-          tmp.addElement(mappings[i]);
+          tmp.add(sm);
         }
       }
 
-      mappings = new StructureMapping[tmp.size()];
-      tmp.copyInto(mappings);
+      mappings = tmp;
     }
   }
 
   public void mouseOverStructure(int pdbResNum, String chain, String pdbfile)
   {
-    boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null;
+    if (listeners == null)
+    {
+      // old or prematurely sent event
+      return;
+    }
     SearchResults results = null;
     SequenceI lastseq = null;
     int lastipos = -1, indexpos;
@@ -342,56 +599,44 @@ public class StructureSelectionManager
         {
           results = new SearchResults();
         }
-        if (mappings != null)
+        for (StructureMapping sm : mappings)
         {
-          for (int j = 0; j < mappings.length; j++)
+          if (sm.pdbfile.equals(pdbfile) && sm.pdbchain.equals(chain))
           {
-            if (mappings[j].pdbfile.equals(pdbfile)
-                    && mappings[j].pdbchain.equals(chain))
+            indexpos = sm.getSeqPos(pdbResNum);
+            if (lastipos != indexpos && lastseq != sm.sequence)
             {
-              indexpos = mappings[j].getSeqPos(pdbResNum);
-              if (lastipos != indexpos && lastseq != mappings[j].sequence)
+              results.addResult(sm.sequence, indexpos, indexpos);
+              lastipos = indexpos;
+              lastseq = sm.sequence;
+              // construct highlighted sequence list
+              for (AlignedCodonFrame acf : seqmappings)
               {
-                results.addResult(mappings[j].sequence, indexpos, indexpos);
-                lastipos = indexpos;
-                lastseq = mappings[j].sequence;
-                // construct highlighted sequence list
-                if (seqmappings != null)
-                {
-
-                  Enumeration e = seqmappings.elements();
-                  while (e.hasMoreElements())
-
-                  {
-                    ((AlignedCodonFrame) e.nextElement()).markMappedRegion(
-                            mappings[j].sequence, indexpos, results);
-                  }
-                }
+                acf.markMappedRegion(sm.sequence, indexpos, results);
               }
-
             }
           }
         }
       }
     }
-    if (results.getSize() > 0)
+    if (results != null)
     {
       for (int i = 0; i < listeners.size(); i++)
       {
         Object li = listeners.elementAt(i);
         if (li instanceof SequenceListener)
+        {
           ((SequenceListener) li).highlightSequence(results);
+        }
       }
     }
   }
 
-  Vector seqmappings = null; // should be a simpler list of mapped seuqence
-
   /**
    * highlight regions associated with a position (indexpos) in seq
    * 
    * @param seq
-   *          the sequeence that the mouse over occured on
+   *          the sequence that the mouse over occurred on
    * @param indexpos
    *          the absolute position being mouseovered in seq (0 to seq.length())
    * @param index
@@ -401,95 +646,94 @@ public class StructureSelectionManager
   public void mouseOverSequence(SequenceI seq, int indexpos, int index,
           VamsasSource source)
   {
-    boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null;
+    boolean hasSequenceListeners = handlingVamsasMo
+            || !seqmappings.isEmpty();
     SearchResults results = null;
     if (index == -1)
+    {
       index = seq.findPosition(indexpos);
-    StructureListener sl;
-    int atomNo = 0;
+    }
     for (int i = 0; i < listeners.size(); i++)
     {
-      if (listeners.elementAt(i) instanceof StructureListener)
+      Object listener = listeners.elementAt(i);
+      if (listener == source)
       {
-        sl = (StructureListener) listeners.elementAt(i);
-        if (mappings == null)
-        {
-          continue;
-        }
-        for (int j = 0; j < mappings.length; j++)
-        {
-          if (mappings[j].sequence == seq
-                  || mappings[j].sequence == seq.getDatasetSequence())
-          {
-            atomNo = mappings[j].getAtomNum(index);
-
-            if (atomNo > 0)
-            {
-              sl.highlightAtom(atomNo, mappings[j].getPDBResNum(index),
-                      mappings[j].pdbchain, mappings[j].pdbfile);
-            }
-          }
-        }
+        // TODO listener (e.g. SeqPanel) is never == source (AlignViewport)
+        // Temporary fudge with SequenceListener.getVamsasSource()
+        continue;
+      }
+      if (listener instanceof StructureListener)
+      {
+        highlightStructure((StructureListener) listener, seq, index);
       }
       else
       {
-        if (relaySeqMappings && hasSequenceListeners
-                && listeners.elementAt(i) instanceof SequenceListener)
+        if (listener instanceof SequenceListener)
         {
-          // DEBUG
-          // System.err.println("relay Seq " + seq.getDisplayId(false) + " " +
-          // index);
-
-          if (results == null)
+          final SequenceListener seqListener = (SequenceListener) listener;
+          if (hasSequenceListeners
+                  && seqListener.getVamsasSource() != source)
           {
-            results = new SearchResults();
-            if (index >= seq.getStart() && index <= seq.getEnd())
+            if (relaySeqMappings)
             {
-              // construct highlighted sequence list
-
-              if (seqmappings != null)
+              if (results == null)
               {
-                Enumeration e = seqmappings.elements();
-                while (e.hasMoreElements())
-
-                {
-                  ((AlignedCodonFrame) e.nextElement()).markMappedRegion(
-                          seq, index, results);
-                }
+                results = MappingUtils.buildSearchResults(seq, index,
+                        seqmappings);
               }
-              // hasSequenceListeners = results.getSize() > 0;
               if (handlingVamsasMo)
               {
-                // maybe have to resolve seq to a dataset seqeunce...
-                // add in additional direct sequence and/or dataset sequence
-                // highlighting
                 results.addResult(seq, index, index);
+
               }
+              seqListener.highlightSequence(results);
             }
           }
-          if (hasSequenceListeners)
-          {
-            ((SequenceListener) listeners.elementAt(i))
-                    .highlightSequence(results);
-          }
         }
-        else if (listeners.elementAt(i) instanceof VamsasListener
-                && !handlingVamsasMo)
+        else if (listener instanceof VamsasListener && !handlingVamsasMo)
         {
-          // DEBUG
-          // System.err.println("Vamsas from Seq " + seq.getDisplayId(false) + "
-          // " +
-          // index);
-          // pass the mouse over and absolute position onto the
-          // VamsasListener(s)
-          ((VamsasListener) listeners.elementAt(i)).mouseOver(seq,
-                  indexpos, source);
+          ((VamsasListener) listener).mouseOverSequence(seq, indexpos,
+                  source);
+        }
+        else if (listener instanceof SecondaryStructureListener)
+        {
+          ((SecondaryStructureListener) listener).mouseOverSequence(seq,
+                  indexpos);
         }
       }
     }
   }
 
   /**
+   * Send suitable messages to a StructureListener to highlight atoms
+   * corresponding to the given sequence position.
+   * 
+   * @param sl
+   * @param seq
+   * @param index
+   */
+  protected void highlightStructure(StructureListener sl, SequenceI seq,
+          int index)
+  {
+    int atomNo;
+    List<AtomSpec> atoms = new ArrayList<AtomSpec>();
+    for (StructureMapping sm : mappings)
+    {
+      if (sm.sequence == seq || sm.sequence == seq.getDatasetSequence())
+      {
+        atomNo = sm.getAtomNum(index);
+
+        if (atomNo > 0)
+        {
+          atoms.add(new AtomSpec(sm.pdbfile, sm.pdbchain, sm
+                  .getPDBResNum(index), atomNo));
+        }
+      }
+    }
+    sl.highlightAtoms(atoms);
+  }
+
+  /**
    * true if a mouse over event from an external (ie Vamsas) source is being
    * handled
    */
@@ -575,113 +819,114 @@ public class StructureSelectionManager
 
   public StructureMapping[] getMapping(String pdbfile)
   {
-    Vector tmp = new Vector();
-    if (mappings != null)
-    {
-      for (int i = 0; i < mappings.length; i++)
+    List<StructureMapping> tmp = new ArrayList<StructureMapping>();
+    for (StructureMapping sm : mappings)
       {
-        if (mappings[i].pdbfile.equals(pdbfile))
+      if (sm.pdbfile.equals(pdbfile))
         {
-          tmp.addElement(mappings[i]);
+        tmp.add(sm);
         }
-      }
-    }
-    StructureMapping[] ret = new StructureMapping[tmp.size()];
-    for (int i = 0; i < tmp.size(); i++)
-    {
-      ret[i] = (StructureMapping) tmp.elementAt(i);
     }
-
-    return ret;
+    return tmp.toArray(new StructureMapping[tmp.size()]);
   }
 
   public String printMapping(String pdbfile)
   {
-    StringBuffer sb = new StringBuffer();
-    for (int i = 0; i < mappings.length; i++)
+    StringBuilder sb = new StringBuilder(64);
+    for (StructureMapping sm : mappings)
     {
-      if (mappings[i].pdbfile.equals(pdbfile))
+      if (sm.pdbfile.equals(pdbfile))
       {
-        sb.append(mappings[i].mappingDetails);
+        sb.append(sm.mappingDetails);
       }
     }
 
     return sb.toString();
   }
 
-  private int[] seqmappingrefs = null; // refcount for seqmappings elements
-
-  private synchronized void modifySeqMappingList(boolean add,
-          AlignedCodonFrame[] codonFrames)
+  /**
+   * Decrement the reference counter for each of the given mappings, and remove
+   * it entirely if its reference counter reduces to zero.
+   * 
+   * @param set
+   */
+  public void removeMappings(Set<AlignedCodonFrame> set)
   {
-    if (!add && (seqmappings == null || seqmappings.size() == 0))
-      return;
-    if (seqmappings == null)
-      seqmappings = new Vector();
-    if (codonFrames != null && codonFrames.length > 0)
+    if (set != null)
     {
-      for (int cf = 0; cf < codonFrames.length; cf++)
+      for (AlignedCodonFrame acf : set)
       {
-        if (seqmappings.contains(codonFrames[cf]))
-        {
-          if (add)
-          {
-            seqmappingrefs[seqmappings.indexOf(codonFrames[cf])]++;
-          }
-          else
-          {
-            if (--seqmappingrefs[seqmappings.indexOf(codonFrames[cf])] <= 0)
-            {
-              int pos = seqmappings.indexOf(codonFrames[cf]);
-              int[] nr = new int[seqmappingrefs.length - 1];
-              if (pos > 0)
-              {
-                System.arraycopy(seqmappingrefs, 0, nr, 0, pos);
-              }
-              if (pos < seqmappingrefs.length - 1)
-              {
-                System.arraycopy(seqmappingrefs, pos + 1, nr, 0,
-                        seqmappingrefs.length - pos - 2);
-              }
-            }
-          }
-        }
-        else
-        {
-          if (add)
-          {
-            seqmappings.addElement(codonFrames[cf]);
-
-            int[] nsr = new int[(seqmappingrefs == null) ? 1
-                    : seqmappingrefs.length + 1];
-            if (seqmappingrefs != null && seqmappingrefs.length > 0)
-              System.arraycopy(seqmappingrefs, 0, nsr, 0,
-                      seqmappingrefs.length);
-            nsr[(seqmappingrefs == null) ? 0 : seqmappingrefs.length] = 1;
-            seqmappingrefs = nsr;
-          }
-        }
+        removeMapping(acf);
       }
     }
   }
 
-  public void removeMappings(AlignedCodonFrame[] codonFrames)
+  /**
+   * Decrement the reference counter for the given mapping, and remove it
+   * entirely if its reference counter reduces to zero.
+   * 
+   * @param acf
+   */
+  public void removeMapping(AlignedCodonFrame acf)
   {
-    modifySeqMappingList(false, codonFrames);
+    if (acf != null && seqmappings.contains(acf))
+    {
+      int count = seqMappingRefCounts.get(acf);
+      count--;
+      if (count > 0)
+      {
+        seqMappingRefCounts.put(acf, count);
+      }
+      else
+      {
+        seqmappings.remove(acf);
+        seqMappingRefCounts.remove(acf);
+      }
+    }
   }
 
-  public void addMappings(AlignedCodonFrame[] codonFrames)
+  /**
+   * Add each of the given codonFrames to the stored set. If not aready present,
+   * increments its reference count instead.
+   * 
+   * @param set
+   */
+  public void addMappings(Set<AlignedCodonFrame> set)
   {
-    modifySeqMappingList(true, codonFrames);
+    if (set != null)
+    {
+      for (AlignedCodonFrame acf : set)
+      {
+        addMapping(acf);
+      }
+    }
   }
 
-  Vector sel_listeners = new Vector();
+  /**
+   * Add the given mapping to the stored set, or if already stored, increment
+   * its reference counter.
+   */
+  public void addMapping(AlignedCodonFrame acf)
+  {
+    if (acf != null)
+    {
+      if (seqmappings.contains(acf))
+      {
+        seqMappingRefCounts.put(acf, seqMappingRefCounts.get(acf) + 1);
+      }
+      else
+      {
+        seqmappings.add(acf);
+        seqMappingRefCounts.put(acf, 1);
+      }
+    }
+  }
 
   public void addSelectionListener(SelectionListener selecter)
   {
     if (!sel_listeners.contains(selecter))
     {
-      sel_listeners.addElement(selecter);
+      sel_listeners.add(selecter);
     }
   }
 
@@ -689,7 +934,7 @@ public class StructureSelectionManager
   {
     if (sel_listeners.contains(toremove))
     {
-      sel_listeners.removeElement(toremove);
+      sel_listeners.remove(toremove);
     }
   }
 
@@ -697,19 +942,135 @@ public class StructureSelectionManager
           jalview.datamodel.SequenceGroup selection,
           jalview.datamodel.ColumnSelection colsel, SelectionSource source)
   {
-    if (sel_listeners != null && sel_listeners.size() > 0)
+    for (SelectionListener slis : sel_listeners)
     {
-      Enumeration listeners = sel_listeners.elements();
+      if (slis != source)
+      {
+        slis.selection(selection, colsel, source);
+      }
+    }
+  }
+
+  Vector<AlignmentViewPanelListener> view_listeners = new Vector<AlignmentViewPanelListener>();
+
+  public synchronized void sendViewPosition(
+          jalview.api.AlignmentViewPanel source, int startRes, int endRes,
+          int startSeq, int endSeq)
+  {
+
+    if (view_listeners != null && view_listeners.size() > 0)
+    {
+      Enumeration<AlignmentViewPanelListener> listeners = view_listeners
+              .elements();
       while (listeners.hasMoreElements())
       {
-        SelectionListener slis = ((SelectionListener) listeners
-                .nextElement());
+        AlignmentViewPanelListener slis = listeners.nextElement();
         if (slis != source)
         {
-          slis.selection(selection, colsel, source);
+          slis.viewPosition(startRes, endRes, startSeq, endSeq, source);
         }
         ;
       }
     }
   }
+
+  /**
+   * release all references associated with this manager provider
+   * 
+   * @param jalviewLite
+   */
+  public static void release(StructureSelectionManagerProvider jalviewLite)
+  {
+    // synchronized (instances)
+    {
+      if (instances == null)
+      {
+        return;
+      }
+      StructureSelectionManager mnger = (instances.get(jalviewLite));
+      if (mnger != null)
+      {
+        instances.remove(jalviewLite);
+        try
+        {
+          mnger.finalize();
+        } catch (Throwable x)
+        {
+        }
+      }
+    }
+  }
+
+  public void registerPDBEntry(PDBEntry pdbentry)
+  {
+    if (pdbentry.getFile() != null
+            && pdbentry.getFile().trim().length() > 0)
+    {
+      registerPDBFile(pdbentry.getId(), pdbentry.getFile());
+    }
+  }
+
+  public void addCommandListener(CommandListener cl)
+  {
+    if (!commandListeners.contains(cl))
+    {
+      commandListeners.add(cl);
+    }
+  }
+
+  public boolean hasCommandListener(CommandListener cl)
+  {
+    return this.commandListeners.contains(cl);
+  }
+
+  public boolean removeCommandListener(CommandListener l)
+  {
+    return commandListeners.remove(l);
+  }
+
+  /**
+   * Forward a command to any command listeners (except for the command's
+   * source).
+   * 
+   * @param command
+   *          the command to be broadcast (in its form after being performed)
+   * @param undo
+   *          if true, the command was being 'undone'
+   * @param source
+   */
+  public void commandPerformed(CommandI command, boolean undo,
+          VamsasSource source)
+  {
+    for (CommandListener listener : commandListeners)
+    {
+      listener.mirrorCommand(command, undo, this, source);
+    }
+  }
+
+  /**
+   * Returns a new CommandI representing the given command as mapped to the
+   * given sequences. If no mapping could be made, or the command is not of a
+   * mappable kind, returns null.
+   * 
+   * @param command
+   * @param undo
+   * @param mapTo
+   * @param gapChar
+   * @return
+   */
+  public CommandI mapCommand(CommandI command, boolean undo,
+          final AlignmentI mapTo, char gapChar)
+  {
+    if (command instanceof EditCommand)
+    {
+      return MappingUtils.mapEditCommand((EditCommand) command, undo,
+              mapTo, gapChar, seqmappings);
+    }
+    else if (command instanceof OrderCommand)
+    {
+      return MappingUtils.mapOrderCommand((OrderCommand) command, undo,
+              mapTo, seqmappings);
+    }
+    return null;
+  }
 }