JAL-1432 updated copyright notices
[jalview.git] / src / jalview / structure / StructureSelectionManager.java
index 0fb8428..5a9e382 100644 (file)
@@ -1,19 +1,20 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
+ * Copyright (C) 2014 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.
- * 
+ *  
  * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.structure;
 
@@ -22,23 +23,54 @@ import java.util.*;
 
 import MCview.*;
 import jalview.analysis.*;
+import jalview.api.AlignmentViewPanel;
+import jalview.api.StructureSelectionManagerProvider;
 import jalview.datamodel.*;
 
 public class StructureSelectionManager
 {
-  static StructureSelectionManager instance;
+  static IdentityHashMap<StructureSelectionManagerProvider, StructureSelectionManager> instances;
 
   StructureMapping[] mappings;
 
+  /**
+   * debug function - write all mappings to stdout
+   */
+  public void reportMapping()
+  {
+    if (mappings == null)
+    {
+      System.err.println("reportMapping: No PDB/Sequence mappings.");
+    }
+    else
+    {
+      System.err.println("reportMapping: There are " + mappings.length
+              + " mappings.");
+      for (int m = 0; m < mappings.length; m++)
+      {
+        System.err.println("mapping " + m + " : " + mappings[m].pdbfile);
+      }
+    }
+  }
+
   Hashtable mappingData = new Hashtable();
 
-  public static StructureSelectionManager getStructureSelectionManager()
+  public static StructureSelectionManager getStructureSelectionManager(
+          StructureSelectionManagerProvider context)
   {
+    if (context==null)
+    {
+      throw new Error("Implementation error. Structure selection manager's context is 'null'", new NullPointerException("SSM context is null"));
+    }
+    if (instances == null)
+    {
+      instances = new java.util.IdentityHashMap<StructureSelectionManagerProvider, StructureSelectionManager>();
+    }
+    StructureSelectionManager instance = instances.get(context);
     if (instance == null)
     {
-      instance = new StructureSelectionManager();
+      instances.put(context, instance = new StructureSelectionManager());
     }
-
     return instance;
   }
 
@@ -73,6 +105,11 @@ public class StructureSelectionManager
 
   Vector listeners = new Vector();
 
+  /**
+   * register a listener for alignment sequence mouseover events
+   * 
+   * @param svl
+   */
   public void addStructureViewerListener(Object svl)
   {
     if (!listeners.contains(svl))
@@ -131,12 +168,28 @@ 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 = "";
@@ -148,14 +201,12 @@ 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))
+        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],
@@ -209,7 +260,10 @@ public class StructureSelectionManager
 
       maxChain.transferRESNUMFeatures(sequence[s], null);
 
-      int[][] mapping = new int[sequence[s].getEnd() + 2][2];
+      // 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;
 
@@ -253,6 +307,18 @@ public class StructureSelectionManager
   public void removeStructureViewerListener(Object svl, String[] pdbfiles)
   {
     listeners.removeElement(svl);
+    if (svl instanceof SequenceListener)
+    {
+      for (int i = 0; i < listeners.size(); i++)
+      {
+        if (listeners.elementAt(i) instanceof StructureListener)
+        {
+          ((StructureListener) listeners.elementAt(i))
+                  .releaseReferences(svl);
+        }
+      }
+    }
+
     if (pdbfiles == null)
     {
       return;
@@ -298,8 +364,15 @@ public class StructureSelectionManager
 
   public void mouseOverStructure(int pdbResNum, String chain, String pdbfile)
   {
+    if (listeners == null)
+    {
+      // old or prematurely sent event
+      return;
+    }
     boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null;
     SearchResults results = null;
+    SequenceI lastseq = null;
+    int lastipos = -1, indexpos;
     for (int i = 0; i < listeners.size(); i++)
     {
       if (listeners.elementAt(i) instanceof SequenceListener)
@@ -308,7 +381,6 @@ public class StructureSelectionManager
         {
           results = new SearchResults();
         }
-        int indexpos;
         if (mappings != null)
         {
           for (int j = 0; j < mappings.length; j++)
@@ -317,25 +389,31 @@ public class StructureSelectionManager
                     && mappings[j].pdbchain.equals(chain))
             {
               indexpos = mappings[j].getSeqPos(pdbResNum);
-              results.addResult(mappings[j].sequence, indexpos, indexpos);
-              // construct highlighted sequence list
-              if (seqmappings != null)
+              if (lastipos != indexpos && lastseq != mappings[j].sequence)
               {
+                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())
+                  Enumeration e = seqmappings.elements();
+                  while (e.hasMoreElements())
 
-                {
-                  ((AlignedCodonFrame) e.nextElement()).markMappedRegion(
-                          mappings[j].sequence, indexpos, results);
+                  {
+                    ((AlignedCodonFrame) e.nextElement()).markMappedRegion(
+                            mappings[j].sequence, indexpos, results);
+                  }
                 }
               }
+
             }
           }
         }
       }
     }
-    if (results.getSize() > 0)
+    if (results != null)
     {
       for (int i = 0; i < listeners.size(); i++)
       {
@@ -359,7 +437,8 @@ public class StructureSelectionManager
    *          the sequence position (if -1, seq.findPosition is called to
    *          resolve the residue number)
    */
-  public void mouseOverSequence(SequenceI seq, int indexpos, int index)
+  public void mouseOverSequence(SequenceI seq, int indexpos, int index,
+          VamsasSource source)
   {
     boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null;
     SearchResults results = null;
@@ -369,9 +448,14 @@ public class StructureSelectionManager
     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);
+        continue;
+      }
+      if (listener instanceof StructureListener)
+      {
+        sl = (StructureListener) listener;
         if (mappings == null)
         {
           continue;
@@ -394,7 +478,7 @@ public class StructureSelectionManager
       else
       {
         if (relaySeqMappings && hasSequenceListeners
-                && listeners.elementAt(i) instanceof SequenceListener)
+                && listener instanceof SequenceListener)
         {
           // DEBUG
           // System.err.println("relay Seq " + seq.getDisplayId(false) + " " +
@@ -429,12 +513,10 @@ public class StructureSelectionManager
           }
           if (hasSequenceListeners)
           {
-            ((SequenceListener) listeners.elementAt(i))
-                    .highlightSequence(results);
+            ((SequenceListener) listener).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) + "
@@ -442,8 +524,12 @@ public class StructureSelectionManager
           // index);
           // pass the mouse over and absolute position onto the
           // VamsasListener(s)
-          ((VamsasListener) listeners.elementAt(i))
-                  .mouseOver(seq, indexpos);
+          ((VamsasListener) listener).mouseOver(seq, indexpos, source);
+        }
+        else if (listener instanceof SecondaryStructureListener)
+        {
+          ((SecondaryStructureListener) listener).mouseOverSequence(seq,
+                  indexpos);
         }
       }
     }
@@ -464,14 +550,15 @@ public class StructureSelectionManager
    * @param position
    *          in an alignment sequence
    */
-  public void mouseOverVamsasSequence(SequenceI sequenceI, int position)
+  public void mouseOverVamsasSequence(SequenceI sequenceI, int position,
+          VamsasSource source)
   {
     handlingVamsasMo = true;
     long msg = sequenceI.hashCode() * (1 + position);
     if (lastmsg != msg)
     {
       lastmsg = msg;
-      mouseOverSequence(sequenceI, position, -1);
+      mouseOverSequence(sequenceI, position, -1, source);
     }
     handlingVamsasMo = false;
   }
@@ -634,7 +721,7 @@ public class StructureSelectionManager
     modifySeqMappingList(true, codonFrames);
   }
 
-  Vector sel_listeners = new Vector();
+  Vector<SelectionListener> sel_listeners = new Vector<SelectionListener>();
 
   public void addSelectionListener(SelectionListener selecter)
   {
@@ -671,4 +758,82 @@ public class StructureSelectionManager
       }
     }
   }
+
+  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())
+      {
+        AlignmentViewPanelListener slis = listeners.nextElement();
+        if (slis != source)
+        {
+          slis.viewPosition(startRes, endRes, startSeq, endSeq, source);
+        }
+        ;
+      }
+    }
+  }
+
+  public void finalize() throws Throwable
+  {
+    if (listeners != null)
+    {
+      listeners.clear();
+      listeners = null;
+    }
+    if (mappingData != null)
+    {
+      mappingData.clear();
+      mappingData = null;
+    }
+    if (sel_listeners != null)
+    {
+      sel_listeners.clear();
+      sel_listeners = null;
+    }
+    if (view_listeners != null)
+    {
+      view_listeners.clear();
+      view_listeners = null;
+    }
+    mappings = null;
+    seqmappingrefs = null;
+  }
+
+  /**
+   * 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)
+        {
+        }
+        ;
+      }
+    }
+  }
+
 }