JAL-2009 Codes to enable storing inserted residues as features to their base residue...
[jalview.git] / src / jalview / structure / StructureSelectionManager.java
index ed5ee2d..9d06aef 100644 (file)
@@ -32,12 +32,18 @@ import jalview.datamodel.Annotation;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SearchResults;
 import jalview.datamodel.SequenceI;
+import jalview.gui.IProgressIndicator;
 import jalview.io.AppletFormatAdapter;
 import jalview.util.MappingUtils;
 import jalview.util.MessageManager;
+import jalview.ws.sifts.SiftsClient;
+import jalview.ws.sifts.SiftsException;
+import jalview.ws.sifts.SiftsSettings;
 
 import java.io.PrintStream;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.IdentityHashMap;
@@ -49,9 +55,12 @@ import java.util.Vector;
 
 import MCview.Atom;
 import MCview.PDBChain;
+import MCview.PDBfile;
 
 public class StructureSelectionManager
 {
+  public final static String NEWLINE = System.lineSeparator();
+
   static IdentityHashMap<StructureSelectionManagerProvider, StructureSelectionManager> instances;
 
   private List<StructureMapping> mappings = new ArrayList<StructureMapping>();
@@ -62,16 +71,16 @@ public class StructureSelectionManager
 
   private boolean addTempFacAnnot = false;
 
-  /*
-   * Set of any registered mappings between (dataset) sequences.
-   */
-  Set<AlignedCodonFrame> seqmappings = new LinkedHashSet<AlignedCodonFrame>();
+  private IProgressIndicator progressIndicator;
+
+  private SiftsClient siftsClient = null;
+
+  private long progressSessionId;
 
   /*
-   * Reference counters for the above mappings. Remove mappings when ref count
-   * goes to zero.
+   * Set of any registered mappings between (dataset) sequences.
    */
-  Map<AlignedCodonFrame, Integer> seqMappingRefCounts = new HashMap<AlignedCodonFrame, Integer>();
+  public Set<AlignedCodonFrame> seqmappings = new LinkedHashSet<AlignedCodonFrame>();
 
   private List<CommandListener> commandListeners = new ArrayList<CommandListener>();
 
@@ -163,8 +172,9 @@ public class StructureSelectionManager
    * 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>();
+  Map<String, String> pdbIdFileName = new HashMap<String, String>();
+
+  Map<String, String> pdbFileNameId = new HashMap<String, String>();
 
   public void registerPDBFile(String idForFile, String absoluteFile)
   {
@@ -201,8 +211,11 @@ public class StructureSelectionManager
       {
         if (instances != null)
         {
-          throw new Error(MessageManager.getString("error.implementation_error_structure_selection_manager_null"),
-                  new NullPointerException(MessageManager.getString("exception.ssm_context_is_null")));
+          throw new Error(
+                  MessageManager
+                          .getString("error.implementation_error_structure_selection_manager_null"),
+                  new NullPointerException(MessageManager
+                          .getString("exception.ssm_context_is_null")));
         }
         else
         {
@@ -308,7 +321,7 @@ 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 PDBfile setMapping(SequenceI[] sequence,
           String[] targetChains, String pdbFile, String protocol)
   {
     return setMapping(true, sequence, targetChains, pdbFile, protocol);
@@ -321,9 +334,9 @@ public class StructureSelectionManager
    * @param forStructureView
    *          when true, record the mapping for use in mouseOvers
    * 
-   * @param sequence
+   * @param sequenceArray
    *          - one or more sequences to be mapped to pdbFile
-   * @param targetChains
+   * @param targetChainIds
    *          - optional chain specification for mapping each sequence to pdb
    *          (may be nill, individual elements may be nill)
    * @param pdbFile
@@ -332,19 +345,19 @@ 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(boolean forStructureView,
-          SequenceI[] sequence,
-          String[] targetChains, String pdbFile, String protocol)
+  synchronized public PDBfile setMapping(boolean forStructureView,
+          SequenceI[] sequenceArray, String[] targetChainIds,
+          String pdbFile,
+          String protocol)
   {
     /*
      * There will be better ways of doing this in the future, for now we'll use
      * the tried and tested MCview pdb mapping
      */
-    MCview.PDBfile pdb = null;
     boolean parseSecStr = processSecondaryStructure;
     if (isPDBFileRegistered(pdbFile))
     {
-      for (SequenceI sq : sequence)
+      for (SequenceI sq : sequenceArray)
       {
         SequenceI ds = sq;
         while (ds.getDatasetSequence() != null)
@@ -359,8 +372,7 @@ public class StructureSelectionManager
             // 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)))
+            if (PDBfile.isCalcIdForFile(ala, findIdForPDBFile(pdbFile)))
             {
               parseSecStr = false;
             }
@@ -368,10 +380,13 @@ public class StructureSelectionManager
         }
       }
     }
+    PDBfile pdb = null;
+    boolean isMapUsingSIFTs = SiftsSettings.isMapWithSifts();
     try
     {
-      pdb = new MCview.PDBfile(addTempFacAnnot, parseSecStr,
-              secStructServices, pdbFile, protocol);
+      pdb = new PDBfile(addTempFacAnnot, parseSecStr, secStructServices,
+              pdbFile, protocol);
+
       if (pdb.id != null && pdb.id.trim().length() > 0
               && AppletFormatAdapter.FILE.equals(protocol))
       {
@@ -383,61 +398,78 @@ public class StructureSelectionManager
       return null;
     }
 
-    String targetChain;
-    for (int s = 0; s < sequence.length; s++)
+    try
+    {
+      if (isMapUsingSIFTs)
+      {
+        siftsClient = new SiftsClient(pdb);
+      }
+    } catch (SiftsException e)
+    {
+      isMapUsingSIFTs = false;
+      e.printStackTrace();
+    }
+
+    String targetChainId;
+    for (int s = 0; s < sequenceArray.length; s++)
     {
       boolean infChain = true;
-      if (targetChains != null && targetChains[s] != null)
+      final SequenceI seq = sequenceArray[s];
+      if (targetChainIds != null && targetChainIds[s] != null)
       {
         infChain = false;
-        targetChain = targetChains[s];
+        targetChainId = targetChainIds[s];
       }
-      else if (sequence[s].getName().indexOf("|") > -1)
+      else if (seq.getName().indexOf("|") > -1)
       {
-        targetChain = sequence[s].getName().substring(
-                sequence[s].getName().lastIndexOf("|") + 1);
-        if (targetChain.length() > 1)
+        targetChainId = seq.getName().substring(
+                seq.getName().lastIndexOf("|") + 1);
+        if (targetChainId.length() > 1)
         {
-          if (targetChain.trim().length() == 0)
+          if (targetChainId.trim().length() == 0)
           {
-            targetChain = " ";
+            targetChainId = " ";
           }
           else
           {
             // not a valid chain identifier
-            targetChain = "";
+            targetChainId = "";
           }
         }
       }
       else
       {
-        targetChain = "";
+        targetChainId = "";
       }
 
+      /*
+       * Attempt pairwise alignment of the sequence with each chain in the PDB,
+       * and remember the highest scoring chain
+       */
       int max = -10;
       AlignSeq maxAlignseq = null;
       String maxChainId = " ";
       PDBChain maxChain = null;
       boolean first = true;
-      for (int i = 0; i < pdb.chains.size(); i++)
+      for (PDBChain chain : pdb.chains)
       {
-        PDBChain chain = (pdb.chains.elementAt(i));
-        if (targetChain.length() > 0 && !targetChain.equals(chain.id)
+        if (targetChainId.length() > 0 && !targetChainId.equals(chain.id)
                 && !infChain)
         {
           continue; // don't try to map chains don't match.
         }
         // TODO: correctly determine sequence type for mixed na/peptide
         // structures
-        AlignSeq as = new AlignSeq(sequence[s],
-                pdb.chains.elementAt(i).sequence,
-                pdb.chains.elementAt(i).isNa ? AlignSeq.DNA
-                        : AlignSeq.PEP);
-        as.calcScoreMatrix();
-        as.traceAlignment();
+        final String type = chain.isNa ? AlignSeq.DNA : AlignSeq.PEP;
+        AlignSeq as = AlignSeq.doGlobalNWAlignment(seq, chain.sequence,
+                type);
+        // equivalent to:
+        // AlignSeq as = new AlignSeq(sequence[s], chain.sequence, type);
+        // as.calcScoreMatrix();
+        // as.traceAlignment();
 
         if (first || as.maxscore > max
-                || (as.maxscore == max && chain.id.equals(targetChain)))
+                || (as.maxscore == max && chain.id.equals(targetChainId)))
         {
           first = false;
           maxChain = chain;
@@ -450,79 +482,157 @@ public class StructureSelectionManager
       {
         continue;
       }
-      final StringBuffer mappingDetails = new StringBuffer();
-      mappingDetails.append("\n\nPDB Sequence is :\nSequence = "
-              + maxChain.sequence.getSequenceAsString());
-      mappingDetails.append("\nNo of residues = "
-              + maxChain.residues.size() + "\n\n");
-      PrintStream ps = new PrintStream(System.out)
+
+      if (protocol.equals(jalview.io.AppletFormatAdapter.PASTE))
       {
-        @Override
-        public void print(String x)
-        {
-          mappingDetails.append(x);
-        }
+        pdbFile = "INLINE" + pdb.id;
+      }
 
-        @Override
-        public void println()
+      ArrayList<StructureMapping> seqToStrucMapping = new ArrayList<StructureMapping>();
+      if (isMapUsingSIFTs)
+      {
+        setProgressBar(null);
+        setProgressBar("Obtaining mapping with SIFTS");
+        jalview.datamodel.Mapping sqmpping = maxAlignseq
+                .getMappingFromS1(false);
+        if (targetChainId != null && !targetChainId.trim().isEmpty())
         {
-          mappingDetails.append("\n");
+          StructureMapping mapping = getStructureMapping(seq, pdbFile,
+                  targetChainId, pdb, maxChain, sqmpping, maxAlignseq);
+          seqToStrucMapping.add(mapping);
         }
-      };
-
-      maxAlignseq.printAlignment(ps);
-
-      mappingDetails.append("\nPDB start/end " + maxAlignseq.seq2start
-              + " " + maxAlignseq.seq2end);
-      mappingDetails.append("\nSEQ start/end "
-              + (maxAlignseq.seq1start + sequence[s].getStart() - 1) + " "
-              + (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 resNum = -10000;
-      int index = 0;
-
-      do
-      {
-        Atom tmp = (Atom) maxChain.atoms.elementAt(index);
-        if (resNum != tmp.resNumber && tmp.alignmentMapping != -1)
+        else
         {
-          resNum = tmp.resNumber;
-          mapping[tmp.alignmentMapping + 1][0] = tmp.resNumber;
-          mapping[tmp.alignmentMapping + 1][1] = tmp.atomIndex;
+          for (PDBChain chain : pdb.chains)
+          {
+            StructureMapping mapping = getStructureMapping(seq, pdbFile,
+                    chain.id, pdb, chain, sqmpping, maxAlignseq);
+            seqToStrucMapping.add(mapping);
+          }
         }
-
-        index++;
-      } while (index < maxChain.atoms.size());
-
-      if (protocol.equals(jalview.io.AppletFormatAdapter.PASTE))
+      }
+      else
       {
-        pdbFile = "INLINE" + pdb.id;
+        setProgressBar(null);
+        setProgressBar("Obtaining mapping with NW alignment");
+        seqToStrucMapping.add(getNWMappings(seq, pdbFile, maxChainId,
+                maxChain, pdb, maxAlignseq));
       }
-      StructureMapping newMapping = new StructureMapping(sequence[s],
-              pdbFile, pdb.id, maxChainId, mapping,
-              mappingDetails.toString());
+
       if (forStructureView)
       {
-        mappings.add(newMapping);
+        mappings.addAll(seqToStrucMapping);
       }
-      maxChain.transferResidueAnnotation(newMapping, sqmpping);
     }
-    // ///////
-
     return pdb;
   }
 
+  private StructureMapping getStructureMapping(SequenceI seq,
+          String pdbFile, String targetChainId, PDBfile pdb,
+          PDBChain maxChain, jalview.datamodel.Mapping sqmpping,
+          AlignSeq maxAlignseq)
+  {
+    String maxChainId = targetChainId;
+    try
+    {
+      StructureMapping curChainMapping = siftsClient
+              .getSiftsStructureMapping(seq, pdbFile, targetChainId);
+      PDBChain chain = pdb.findChain(targetChainId);
+      if (chain != null)
+      {
+        chain.transferResidueAnnotation(curChainMapping, sqmpping);
+      }
+      return curChainMapping;
+    } catch (SiftsException e)
+    {
+      System.err.println(e.getMessage());
+      System.err.println(">>> Now switching mapping with NW alignment...");
+      setProgressBar(null);
+      setProgressBar(">>> Now switching mapping with NW alignment...");
+      return getNWMappings(seq, pdbFile, maxChainId, maxChain, pdb,
+              maxAlignseq);
+    }
+  }
+
+  private StructureMapping getNWMappings(SequenceI seq,
+          String pdbFile,
+          String maxChainId, PDBChain maxChain, PDBfile pdb,
+          AlignSeq maxAlignseq)
+  {
+    final StringBuilder mappingDetails = new StringBuilder(128);
+    mappingDetails.append(NEWLINE).append(
+            "Sequence \u27f7 Structure mapping details");
+    mappingDetails.append(NEWLINE);
+    mappingDetails
+            .append("Method: inferred with Needleman & Wunsch alignment");
+    mappingDetails.append(NEWLINE).append("PDB Sequence is :")
+            .append(NEWLINE).append("Sequence = ")
+            .append(maxChain.sequence.getSequenceAsString());
+    mappingDetails.append(NEWLINE).append("No of residues = ")
+            .append(maxChain.residues.size()).append(NEWLINE)
+            .append(NEWLINE);
+    PrintStream ps = new PrintStream(System.out)
+    {
+      @Override
+      public void print(String x)
+      {
+        mappingDetails.append(x);
+      }
+
+      @Override
+      public void println()
+      {
+        mappingDetails.append(NEWLINE);
+      }
+    };
+
+    maxAlignseq.printAlignment(ps);
+
+    mappingDetails.append(NEWLINE).append("PDB start/end ");
+    mappingDetails.append(String.valueOf(maxAlignseq.seq2start))
+            .append(" ");
+    mappingDetails.append(String.valueOf(maxAlignseq.seq2end));
+    mappingDetails.append(NEWLINE).append("SEQ start/end ");
+    mappingDetails.append(
+            String.valueOf(maxAlignseq.seq1start + (seq.getStart() - 1)))
+            .append(" ");
+    mappingDetails.append(String.valueOf(maxAlignseq.seq1end
+            + (seq.getStart() - 1)));
+    mappingDetails.append(NEWLINE);
+    maxChain.makeExactMapping(maxAlignseq, seq);
+    jalview.datamodel.Mapping sqmpping = maxAlignseq
+            .getMappingFromS1(false);
+    maxChain.transferRESNUMFeatures(seq, null);
+
+    HashMap<Integer, int[]> mapping = new HashMap<Integer, int[]>();
+    int resNum = -10000;
+    int index = 0;
+    char insCode = ' ';
+
+    do
+    {
+      Atom tmp = maxChain.atoms.elementAt(index);
+      if ((resNum != tmp.resNumber || insCode != tmp.insCode)
+              && tmp.alignmentMapping != -1)
+      {
+        resNum = tmp.resNumber;
+        insCode = tmp.insCode;
+        if (tmp.alignmentMapping >= -1)
+        {
+          mapping.put(tmp.alignmentMapping + 1, new int[] { tmp.resNumber,
+              tmp.atomIndex });
+        }
+      }
+
+      index++;
+    } while (index < maxChain.atoms.size());
+
+    StructureMapping nwMapping = new StructureMapping(seq, pdbFile,
+            pdb.id, maxChainId, mapping, mappingDetails.toString());
+    maxChain.transferResidueAnnotation(nwMapping, sqmpping);
+    return nwMapping;
+  }
+
   public void removeStructureViewerListener(Object svl, String[] pdbfiles)
   {
     listeners.removeElement(svl);
@@ -542,30 +652,30 @@ public class StructureSelectionManager
     {
       return;
     }
-    String[] handlepdbs;
-    Vector pdbs = new Vector();
-    for (int i = 0; i < pdbfiles.length; pdbs.addElement(pdbfiles[i++]))
-    {
-      ;
-    }
+
+    /*
+     * Remove mappings to the closed listener's PDB files, but first check if
+     * another listener is still interested
+     */
+    List<String> pdbs = new ArrayList<String>(Arrays.asList(pdbfiles));
+
     StructureListener sl;
     for (int i = 0; i < listeners.size(); i++)
     {
       if (listeners.elementAt(i) instanceof StructureListener)
       {
         sl = (StructureListener) listeners.elementAt(i);
-        handlepdbs = sl.getPdbFile();
-        for (int j = 0; j < handlepdbs.length; j++)
+        for (String pdbfile : sl.getPdbFile())
         {
-          if (pdbs.contains(handlepdbs[j]))
-          {
-            pdbs.removeElement(handlepdbs[j]);
-          }
+          pdbs.remove(pdbfile);
         }
-
       }
     }
 
+    /*
+     * Rebuild the mappings set, retaining only those which are for 'other' PDB
+     * files
+     */
     if (pdbs.size() > 0)
     {
       List<StructureMapping> tmp = new ArrayList<StructureMapping>();
@@ -581,53 +691,75 @@ public class StructureSelectionManager
     }
   }
 
+  /**
+   * Propagate mouseover of a single position in a structure
+   * 
+   * @param pdbResNum
+   * @param chain
+   * @param pdbfile
+   */
   public void mouseOverStructure(int pdbResNum, String chain, String pdbfile)
   {
+    AtomSpec atomSpec = new AtomSpec(pdbfile, chain, pdbResNum, 0);
+    List<AtomSpec> atoms = Collections.singletonList(atomSpec);
+    mouseOverStructure(atoms);
+  }
+
+  /**
+   * Propagate mouseover or selection of multiple positions in a structure
+   * 
+   * @param atoms
+   */
+  public void mouseOverStructure(List<AtomSpec> atoms)
+  {
     if (listeners == null)
     {
       // old or prematurely sent event
       return;
     }
-    SearchResults results = null;
-    SequenceI lastseq = null;
-    int lastipos = -1, indexpos;
+    boolean hasSequenceListener = false;
     for (int i = 0; i < listeners.size(); i++)
     {
       if (listeners.elementAt(i) instanceof SequenceListener)
       {
-        if (results == null)
-        {
-          results = new SearchResults();
-        }
-        for (StructureMapping sm : mappings)
+        hasSequenceListener = true;
+      }
+    }
+    if (!hasSequenceListener)
+    {
+      return;
+    }
+
+    SearchResults results = new SearchResults();
+    for (AtomSpec atom : atoms)
+    {
+      SequenceI lastseq = null;
+      int lastipos = -1;
+      for (StructureMapping sm : mappings)
+      {
+        if (sm.pdbfile.equals(atom.getPdbFile())
+                && sm.pdbchain.equals(atom.getChain()))
         {
-          if (sm.pdbfile.equals(pdbfile) && sm.pdbchain.equals(chain))
+          int indexpos = sm.getSeqPos(atom.getPdbResNum());
+          if (lastipos != indexpos && lastseq != sm.sequence)
           {
-            indexpos = sm.getSeqPos(pdbResNum);
-            if (lastipos != indexpos && lastseq != sm.sequence)
+            results.addResult(sm.sequence, indexpos, indexpos);
+            lastipos = indexpos;
+            lastseq = sm.sequence;
+            // construct highlighted sequence list
+            for (AlignedCodonFrame acf : seqmappings)
             {
-              results.addResult(sm.sequence, indexpos, indexpos);
-              lastipos = indexpos;
-              lastseq = sm.sequence;
-              // construct highlighted sequence list
-              for (AlignedCodonFrame acf : seqmappings)
-              {
-                acf.markMappedRegion(sm.sequence, indexpos, results);
-              }
+              acf.markMappedRegion(sm.sequence, indexpos, results);
             }
           }
         }
       }
     }
-    if (results != null)
+    for (Object li : listeners)
     {
-      for (int i = 0; i < listeners.size(); i++)
+      if (li instanceof SequenceListener)
       {
-        Object li = listeners.elementAt(i);
-        if (li instanceof SequenceListener)
-        {
-          ((SequenceListener) li).highlightSequence(results);
-        }
+        ((SequenceListener) li).highlightSequence(results);
       }
     }
   }
@@ -686,7 +818,10 @@ public class StructureSelectionManager
                 results.addResult(seq, index, index);
 
               }
-              seqListener.highlightSequence(results);
+              if (!results.isEmpty())
+              {
+                seqListener.highlightSequence(results);
+              }
             }
           }
         }
@@ -698,7 +833,7 @@ public class StructureSelectionManager
         else if (listener instanceof SecondaryStructureListener)
         {
           ((SecondaryStructureListener) listener).mouseOverSequence(seq,
-                  indexpos);
+                  indexpos, index);
         }
       }
     }
@@ -715,6 +850,10 @@ public class StructureSelectionManager
   protected void highlightStructure(StructureListener sl, SequenceI seq,
           int index)
   {
+    if (!sl.isListeningFor(seq))
+    {
+      return;
+    }
     int atomNo;
     List<AtomSpec> atoms = new ArrayList<AtomSpec>();
     for (StructureMapping sm : mappings)
@@ -821,104 +960,131 @@ public class StructureSelectionManager
   {
     List<StructureMapping> tmp = new ArrayList<StructureMapping>();
     for (StructureMapping sm : mappings)
-      {
+    {
       if (sm.pdbfile.equals(pdbfile))
-        {
+      {
         tmp.add(sm);
-        }
+      }
     }
     return tmp.toArray(new StructureMapping[tmp.size()]);
   }
 
-  public String printMapping(String pdbfile)
+  /**
+   * Returns a readable description of all mappings for the given pdbfile to any
+   * of the given sequences
+   * 
+   * @param pdbfile
+   * @param seqs
+   * @return
+   */
+  public String printMappings(String pdbfile, List<SequenceI> seqs)
   {
+    if (pdbfile == null || seqs == null || seqs.isEmpty())
+    {
+      return "";
+    }
+
     StringBuilder sb = new StringBuilder(64);
     for (StructureMapping sm : mappings)
     {
-      if (sm.pdbfile.equals(pdbfile))
+      if (sm.pdbfile.equals(pdbfile) && seqs.contains(sm.sequence))
       {
         sb.append(sm.mappingDetails);
+        sb.append(NEWLINE);
+        // separator makes it easier to read multiple mappings
+        sb.append("=====================");
+        sb.append(NEWLINE);
       }
     }
+    sb.append(NEWLINE);
 
     return sb.toString();
   }
 
   /**
-   * Decrement the reference counter for each of the given mappings, and remove
-   * it entirely if its reference counter reduces to zero.
+   * Remove the given mapping
    * 
-   * @param set
+   * @param acf
    */
-  public void removeMappings(Set<AlignedCodonFrame> set)
+  public void deregisterMapping(AlignedCodonFrame acf)
   {
-    if (set != null)
+    if (acf != null)
     {
-      for (AlignedCodonFrame acf : set)
-      {
-        removeMapping(acf);
+      boolean removed = seqmappings.remove(acf);
+      if (removed && seqmappings.isEmpty())
+      { // debug
+        System.out.println("All mappings removed");
       }
     }
   }
 
   /**
-   * Decrement the reference counter for the given mapping, and remove it
-   * entirely if its reference counter reduces to zero.
+   * Add each of the given codonFrames to the stored set, if not aready present.
    * 
-   * @param acf
+   * @param set
    */
-  public void removeMapping(AlignedCodonFrame acf)
+  public void registerMappings(Set<AlignedCodonFrame> set)
   {
-    if (acf != null && seqmappings.contains(acf))
+    if (set != null)
     {
-      int count = seqMappingRefCounts.get(acf);
-      count--;
-      if (count > 0)
-      {
-        seqMappingRefCounts.put(acf, count);
-      }
-      else
+      for (AlignedCodonFrame acf : set)
       {
-        seqmappings.remove(acf);
-        seqMappingRefCounts.remove(acf);
+        registerMapping(acf);
       }
     }
   }
 
   /**
-   * Add each of the given codonFrames to the stored set. If not aready present,
-   * increments its reference count instead.
-   * 
-   * @param set
+   * Add the given mapping to the stored set, unless already stored.
    */
-  public void addMappings(Set<AlignedCodonFrame> set)
+  public void registerMapping(AlignedCodonFrame acf)
   {
-    if (set != null)
+    if (acf != null)
     {
-      for (AlignedCodonFrame acf : set)
+      if (!seqmappings.contains(acf))
       {
-        addMapping(acf);
+        seqmappings.add(acf);
       }
     }
   }
 
   /**
-   * Add the given mapping to the stored set, or if already stored, increment
-   * its reference counter.
+   * Resets this object to its initial state by removing all registered
+   * listeners, codon mappings, PDB file mappings
    */
-  public void addMapping(AlignedCodonFrame acf)
+  public void resetAll()
   {
-    if (acf != null)
+    if (mappings != null)
     {
-      if (seqmappings.contains(acf))
-      {
-        seqMappingRefCounts.put(acf, seqMappingRefCounts.get(acf) + 1);
-      }
-      else
-      {
-        seqmappings.add(acf);
-        seqMappingRefCounts.put(acf, 1);
-      }
+      mappings.clear();
+    }
+    if (seqmappings != null)
+    {
+      seqmappings.clear();
+    }
+    if (sel_listeners != null)
+    {
+      sel_listeners.clear();
+    }
+    if (listeners != null)
+    {
+      listeners.clear();
+    }
+    if (commandListeners != null)
+    {
+      commandListeners.clear();
+    }
+    if (view_listeners != null)
+    {
+      view_listeners.clear();
+    }
+    if (pdbFileNameId != null)
+    {
+      pdbFileNameId.clear();
+    }
+    if (pdbIdFileName != null)
+    {
+      pdbIdFileName.clear();
     }
   }
 
@@ -1073,4 +1239,30 @@ public class StructureSelectionManager
     }
     return null;
   }
+
+  public IProgressIndicator getProgressIndicator()
+  {
+    return progressIndicator;
+  }
+
+  public void setProgressIndicator(IProgressIndicator progressIndicator)
+  {
+    this.progressIndicator = progressIndicator;
+  }
+
+  public long getProgressSessionId()
+  {
+    return progressSessionId;
+  }
+
+  public void setProgressSessionId(long progressSessionId)
+  {
+    this.progressSessionId = progressSessionId;
+  }
+
+  public void setProgressBar(String message)
+  {
+    progressIndicator.setProgressBar(message, progressSessionId);
+  }
+
 }