patch for JAL-846 made targetChain mapping constraint selective so
[jalview.git] / src / jalview / structure / StructureSelectionManager.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
10  * 
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package jalview.structure;
19
20 import java.io.*;
21 import java.util.*;
22
23 import MCview.*;
24 import jalview.analysis.*;
25 import jalview.api.AlignmentViewPanel;
26 import jalview.api.StructureSelectionManagerProvider;
27 import jalview.datamodel.*;
28
29 public class StructureSelectionManager
30 {
31   static IdentityHashMap<StructureSelectionManagerProvider,StructureSelectionManager> instances;
32
33   StructureMapping[] mappings;
34
35   /**
36    * debug function - write all mappings to stdout
37    */
38   public void reportMapping() {\r
39     if (mappings==null)\r
40     {\r
41       System.err.println("reportMapping: No PDB/Sequence mappings.");\r
42     }else{\r
43       System.err.println("reportMapping: There are "+mappings.length+" mappings.");\r
44       for (int m=0;m<mappings.length;m++)\r
45       {\r
46         System.err.println("mapping "+m+" : "+mappings[m].pdbfile);\r
47       }\r
48     }\r
49   }\r
50   Hashtable mappingData = new Hashtable();
51
52   public static StructureSelectionManager getStructureSelectionManager(StructureSelectionManagerProvider context)
53   {
54     if (instances == null)
55     {
56       instances = new java.util.IdentityHashMap<StructureSelectionManagerProvider,StructureSelectionManager>();
57     }
58     StructureSelectionManager instance=instances.get(context);
59     if (instance==null)
60     {
61       instances.put(context, instance=new StructureSelectionManager());
62     }
63     return instance;
64   }
65
66   /**
67    * flag controlling whether SeqMappings are relayed from received sequence
68    * mouse over events to other sequences
69    */
70   boolean relaySeqMappings = true;
71
72   /**
73    * Enable or disable relay of seqMapping events to other sequences. You might
74    * want to do this if there are many sequence mappings and the host computer
75    * is slow
76    * 
77    * @param relay
78    */
79   public void setRelaySeqMappings(boolean relay)
80   {
81     relaySeqMappings = relay;
82   }
83
84   /**
85    * get the state of the relay seqMappings flag.
86    * 
87    * @return true if sequence mouse overs are being relayed to other mapped
88    *         sequences
89    */
90   public boolean isRelaySeqMappingsEnabled()
91   {
92     return relaySeqMappings;
93   }
94
95   Vector listeners = new Vector();
96
97   /**
98    * register a listener for alignment sequence mouseover events
99    * @param svl
100    */
101   public void addStructureViewerListener(Object svl)
102   {
103     if (!listeners.contains(svl))
104     {
105       listeners.addElement(svl);
106     }
107   }
108
109   public String alreadyMappedToFile(String pdbid)
110   {
111     if (mappings != null)
112     {
113       for (int i = 0; i < mappings.length; i++)
114       {
115         if (mappings[i].getPdbId().equals(pdbid))
116         {
117           return mappings[i].pdbfile;
118         }
119       }
120     }
121     return null;
122   }
123
124   /**
125    * create sequence structure mappings between each sequence and the given
126    * pdbFile (retrieved via the given protocol).
127    * 
128    * @param sequence
129    *          - one or more sequences to be mapped to pdbFile
130    * @param targetChains
131    *          - optional chain specification for mapping each sequence to pdb
132    *          (may be nill, individual elements may be nill)
133    * @param pdbFile
134    *          - structure data resource
135    * @param protocol
136    *          - how to resolve data from resource
137    * @return null or the structure data parsed as a pdb file
138    */
139   synchronized public MCview.PDBfile setMapping(SequenceI[] sequence,
140           String[] targetChains, String pdbFile, String protocol)
141   {
142     /*
143      * There will be better ways of doing this in the future, for now we'll use
144      * the tried and tested MCview pdb mapping
145      */
146     MCview.PDBfile pdb = null;
147     try
148     {
149       pdb = new MCview.PDBfile(pdbFile, protocol);
150     } catch (Exception ex)
151     {
152       ex.printStackTrace();
153       return null;
154     }
155     
156     String targetChain;
157     for (int s = 0; s < sequence.length; s++)
158     {
159       boolean infChain = true;
160       if (targetChains != null && targetChains[s] != null)
161       {
162         infChain = false;
163         targetChain = targetChains[s];
164       }
165       else if (sequence[s].getName().indexOf("|") > -1)
166       {
167         targetChain = sequence[s].getName().substring(
168                 sequence[s].getName().lastIndexOf("|") + 1);
169         if (targetChain.length() > 1)
170         {
171           if (targetChain.trim().length() == 0)
172           {
173             targetChain = " ";
174           }
175           else
176           {
177             // not a valid chain identifier
178             targetChain = "";
179           }
180         }
181       }
182       else
183         targetChain = "";
184
185       int max = -10;
186       AlignSeq maxAlignseq = null;
187       String maxChainId = " ";
188       PDBChain maxChain = null;
189       boolean first = true;
190       for (int i = 0; i < pdb.chains.size(); i++)
191       {
192         PDBChain chain = ((PDBChain) pdb.chains.elementAt(i));
193         if (targetChain.length() > 0 && !targetChain.equals(chain.id) && !infChain)
194         {
195           continue; // don't try to map chains don't match.
196         }
197         // TODO: correctly determine sequence type for mixed na/peptide
198         // structures
199         AlignSeq as = new AlignSeq(sequence[s],
200                 ((PDBChain) pdb.chains.elementAt(i)).sequence,
201                 ((PDBChain) pdb.chains.elementAt(i)).isNa ? AlignSeq.DNA
202                         : AlignSeq.PEP);
203         as.calcScoreMatrix();
204         as.traceAlignment();
205
206         if (first || as.maxscore > max
207                 || (as.maxscore == max && chain.id.equals(targetChain)))
208         {
209           first = false;
210           maxChain = chain;
211           max = as.maxscore;
212           maxAlignseq = as;
213           maxChainId = chain.id;
214         }
215       }
216       if (maxChain == null)
217       {
218         continue;
219       }
220       final StringBuffer mappingDetails = new StringBuffer();
221       mappingDetails.append("\n\nPDB Sequence is :\nSequence = "
222               + maxChain.sequence.getSequenceAsString());
223       mappingDetails.append("\nNo of residues = "
224               + maxChain.residues.size() + "\n\n");
225       PrintStream ps = new PrintStream(System.out)
226       {
227         public void print(String x)
228         {
229           mappingDetails.append(x);
230         }
231
232         public void println()
233         {
234           mappingDetails.append("\n");
235         }
236       };
237
238       maxAlignseq.printAlignment(ps);
239
240       mappingDetails.append("\nPDB start/end " + maxAlignseq.seq2start
241               + " " + maxAlignseq.seq2end);
242       mappingDetails.append("\nSEQ start/end "
243               + (maxAlignseq.seq1start + sequence[s].getStart() - 1) + " "
244               + (maxAlignseq.seq1end + sequence[s].getEnd() - 1));
245
246       maxChain.makeExactMapping(maxAlignseq, sequence[s]);
247
248       maxChain.transferRESNUMFeatures(sequence[s], null);
249
250       // allocate enough slots to store the mapping from positions in
251       // sequence[s] to the associated chain
252       int[][] mapping = new int[sequence[s].findPosition(sequence[s].getLength()) + 2][2];
253       int resNum = -10000;
254       int index = 0;
255
256       do
257       {
258         Atom tmp = (Atom) maxChain.atoms.elementAt(index);
259         if (resNum != tmp.resNumber && tmp.alignmentMapping != -1)
260         {
261           resNum = tmp.resNumber;
262           mapping[tmp.alignmentMapping + 1][0] = tmp.resNumber;
263           mapping[tmp.alignmentMapping + 1][1] = tmp.atomIndex;
264         }
265
266         index++;
267       } while (index < maxChain.atoms.size());
268
269       if (mappings == null)
270       {
271         mappings = new StructureMapping[1];
272       }
273       else
274       {
275         StructureMapping[] tmp = new StructureMapping[mappings.length + 1];
276         System.arraycopy(mappings, 0, tmp, 0, mappings.length);
277         mappings = tmp;
278       }
279
280       if (protocol.equals(jalview.io.AppletFormatAdapter.PASTE))
281         pdbFile = "INLINE" + pdb.id;
282
283       mappings[mappings.length - 1] = new StructureMapping(sequence[s],
284               pdbFile, pdb.id, maxChainId, mapping,
285               mappingDetails.toString());
286       maxChain.transferResidueAnnotation(mappings[mappings.length - 1]);
287     }
288     // ///////
289
290     return pdb;
291   }
292
293   public void removeStructureViewerListener(Object svl, String[] pdbfiles)
294   {
295     listeners.removeElement(svl);
296     if (svl instanceof SequenceListener)
297     {
298       for (int i=0;i<listeners.size();i++)
299       {
300         if (listeners.elementAt(i) instanceof StructureListener)
301         {
302           ((StructureListener)listeners.elementAt(i)).releaseReferences(svl);
303         }
304       }
305     }
306       
307     if (pdbfiles == null)
308     {
309       return;
310     }
311     boolean removeMapping = true;
312     String[] handlepdbs;
313     Vector pdbs = new Vector();
314     for (int i = 0; i < pdbfiles.length; pdbs.addElement(pdbfiles[i++]))
315       ;
316     StructureListener sl;
317     for (int i = 0; i < listeners.size(); i++)
318     {
319       if (listeners.elementAt(i) instanceof StructureListener)
320       {
321         sl = (StructureListener) listeners.elementAt(i);
322         handlepdbs = sl.getPdbFile();
323         for (int j = 0; j < handlepdbs.length; j++)
324         {
325           if (pdbs.contains(handlepdbs[j]))
326           {
327             pdbs.removeElement(handlepdbs[j]);
328           }
329         }
330
331       }
332     }
333
334     if (pdbs.size() > 0 && mappings != null)
335     {
336       Vector tmp = new Vector();
337       for (int i = 0; i < mappings.length; i++)
338       {
339         if (!pdbs.contains(mappings[i].pdbfile))
340         {
341           tmp.addElement(mappings[i]);
342         }
343       }
344
345       mappings = new StructureMapping[tmp.size()];
346       tmp.copyInto(mappings);
347     }
348   }
349
350   public void mouseOverStructure(int pdbResNum, String chain, String pdbfile)
351   {
352     boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null;
353     SearchResults results = null;
354     SequenceI lastseq = null;
355     int lastipos = -1, indexpos;
356     for (int i = 0; i < listeners.size(); i++)
357     {
358       if (listeners.elementAt(i) instanceof SequenceListener)
359       {
360         if (results == null)
361         {
362           results = new SearchResults();
363         }
364         if (mappings != null)
365         {
366           for (int j = 0; j < mappings.length; j++)
367           {
368             if (mappings[j].pdbfile.equals(pdbfile)
369                     && mappings[j].pdbchain.equals(chain))
370             {
371               indexpos = mappings[j].getSeqPos(pdbResNum);
372               if (lastipos != indexpos && lastseq != mappings[j].sequence)
373               {
374                 results.addResult(mappings[j].sequence, indexpos, indexpos);
375                 lastipos = indexpos;
376                 lastseq = mappings[j].sequence;
377                 // construct highlighted sequence list
378                 if (seqmappings != null)
379                 {
380
381                   Enumeration e = seqmappings.elements();
382                   while (e.hasMoreElements())
383
384                   {
385                     ((AlignedCodonFrame) e.nextElement()).markMappedRegion(
386                             mappings[j].sequence, indexpos, results);
387                   }
388                 }
389               }
390
391             }
392           }
393         }
394       }
395     }
396     if (results!=null)
397     {
398       for (int i = 0; i < listeners.size(); i++)
399       {
400         Object li = listeners.elementAt(i);
401         if (li instanceof SequenceListener)
402           ((SequenceListener) li).highlightSequence(results);
403       }
404     }
405   }
406
407   Vector seqmappings = null; // should be a simpler list of mapped seuqence
408
409   /**
410    * highlight regions associated with a position (indexpos) in seq
411    * 
412    * @param seq
413    *          the sequeence that the mouse over occured on
414    * @param indexpos
415    *          the absolute position being mouseovered in seq (0 to seq.length())
416    * @param index
417    *          the sequence position (if -1, seq.findPosition is called to
418    *          resolve the residue number)
419    */
420   public void mouseOverSequence(SequenceI seq, int indexpos, int index,
421           VamsasSource source)
422   {
423     boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null;
424     SearchResults results = null;
425     if (index == -1)
426       index = seq.findPosition(indexpos);
427     StructureListener sl;
428     int atomNo = 0;
429     for (int i = 0; i < listeners.size(); i++)
430     {
431       if (listeners.elementAt(i) instanceof StructureListener)
432       {
433         sl = (StructureListener) listeners.elementAt(i);
434         if (mappings == null)
435         {
436           continue;
437         }
438         for (int j = 0; j < mappings.length; j++)
439         {
440           if (mappings[j].sequence == seq
441                   || mappings[j].sequence == seq.getDatasetSequence())
442           {
443             atomNo = mappings[j].getAtomNum(index);
444
445             if (atomNo > 0)
446             {
447               sl.highlightAtom(atomNo, mappings[j].getPDBResNum(index),
448                       mappings[j].pdbchain, mappings[j].pdbfile);
449             }
450           }
451         }
452       }
453       else
454       {
455         if (relaySeqMappings && hasSequenceListeners
456                 && listeners.elementAt(i) instanceof SequenceListener)
457         {
458           // DEBUG
459           // System.err.println("relay Seq " + seq.getDisplayId(false) + " " +
460           // index);
461
462           if (results == null)
463           {
464             results = new SearchResults();
465             if (index >= seq.getStart() && index <= seq.getEnd())
466             {
467               // construct highlighted sequence list
468
469               if (seqmappings != null)
470               {
471                 Enumeration e = seqmappings.elements();
472                 while (e.hasMoreElements())
473
474                 {
475                   ((AlignedCodonFrame) e.nextElement()).markMappedRegion(
476                           seq, index, results);
477                 }
478               }
479               // hasSequenceListeners = results.getSize() > 0;
480               if (handlingVamsasMo)
481               {
482                 // maybe have to resolve seq to a dataset seqeunce...
483                 // add in additional direct sequence and/or dataset sequence
484                 // highlighting
485                 results.addResult(seq, index, index);
486               }
487             }
488           }
489           if (hasSequenceListeners)
490           {
491             ((SequenceListener) listeners.elementAt(i))
492                     .highlightSequence(results);
493           }
494         }
495         else if (listeners.elementAt(i) instanceof VamsasListener
496                 && !handlingVamsasMo)
497         {
498           // DEBUG
499           // System.err.println("Vamsas from Seq " + seq.getDisplayId(false) + "
500           // " +
501           // index);
502           // pass the mouse over and absolute position onto the
503           // VamsasListener(s)
504           ((VamsasListener) listeners.elementAt(i)).mouseOver(seq,
505                   indexpos, source);
506         }
507       }
508     }
509   }
510
511   /**
512    * true if a mouse over event from an external (ie Vamsas) source is being
513    * handled
514    */
515   boolean handlingVamsasMo = false;
516
517   long lastmsg = 0;
518
519   /**
520    * as mouseOverSequence but only route event to SequenceListeners
521    * 
522    * @param sequenceI
523    * @param position
524    *          in an alignment sequence
525    */
526   public void mouseOverVamsasSequence(SequenceI sequenceI, int position,
527           VamsasSource source)
528   {
529     handlingVamsasMo = true;
530     long msg = sequenceI.hashCode() * (1 + position);
531     if (lastmsg != msg)
532     {
533       lastmsg = msg;
534       mouseOverSequence(sequenceI, position, -1, source);
535     }
536     handlingVamsasMo = false;
537   }
538
539   public Annotation[] colourSequenceFromStructure(SequenceI seq,
540           String pdbid)
541   {
542     return null;
543     // THIS WILL NOT BE AVAILABLE IN JALVIEW 2.3,
544     // UNTIL THE COLOUR BY ANNOTATION IS REWORKED
545     /*
546      * Annotation [] annotations = new Annotation[seq.getLength()];
547      * 
548      * StructureListener sl; int atomNo = 0; for (int i = 0; i <
549      * listeners.size(); i++) { if (listeners.elementAt(i) instanceof
550      * StructureListener) { sl = (StructureListener) listeners.elementAt(i);
551      * 
552      * for (int j = 0; j < mappings.length; j++) {
553      * 
554      * if (mappings[j].sequence == seq && mappings[j].getPdbId().equals(pdbid)
555      * && mappings[j].pdbfile.equals(sl.getPdbFile())) {
556      * System.out.println(pdbid+" "+mappings[j].getPdbId() +"
557      * "+mappings[j].pdbfile);
558      * 
559      * java.awt.Color col; for(int index=0; index<seq.getLength(); index++) {
560      * if(jalview.util.Comparison.isGap(seq.getCharAt(index))) continue;
561      * 
562      * atomNo = mappings[j].getAtomNum(seq.findPosition(index)); col =
563      * java.awt.Color.white; if (atomNo > 0) { col = sl.getColour(atomNo,
564      * mappings[j].getPDBResNum(index), mappings[j].pdbchain,
565      * mappings[j].pdbfile); }
566      * 
567      * annotations[index] = new Annotation("X",null,' ',0,col); } return
568      * annotations; } } } }
569      * 
570      * return annotations;
571      */
572   }
573
574   public void structureSelectionChanged()
575   {
576   }
577
578   public void sequenceSelectionChanged()
579   {
580   }
581
582   public void sequenceColoursChanged(Object source)
583   {
584     StructureListener sl;
585     for (int i = 0; i < listeners.size(); i++)
586     {
587       if (listeners.elementAt(i) instanceof StructureListener)
588       {
589         sl = (StructureListener) listeners.elementAt(i);
590         sl.updateColours(source);
591       }
592     }
593   }
594
595   public StructureMapping[] getMapping(String pdbfile)
596   {
597     Vector tmp = new Vector();
598     if (mappings != null)
599     {
600       for (int i = 0; i < mappings.length; i++)
601       {
602         if (mappings[i].pdbfile.equals(pdbfile))
603         {
604           tmp.addElement(mappings[i]);
605         }
606       }
607     }
608     StructureMapping[] ret = new StructureMapping[tmp.size()];
609     for (int i = 0; i < tmp.size(); i++)
610     {
611       ret[i] = (StructureMapping) tmp.elementAt(i);
612     }
613
614     return ret;
615   }
616
617   public String printMapping(String pdbfile)
618   {
619     StringBuffer sb = new StringBuffer();
620     for (int i = 0; i < mappings.length; i++)
621     {
622       if (mappings[i].pdbfile.equals(pdbfile))
623       {
624         sb.append(mappings[i].mappingDetails);
625       }
626     }
627
628     return sb.toString();
629   }
630
631   private int[] seqmappingrefs = null; // refcount for seqmappings elements
632
633   private synchronized void modifySeqMappingList(boolean add,
634           AlignedCodonFrame[] codonFrames)
635   {
636     if (!add && (seqmappings == null || seqmappings.size() == 0))
637       return;
638     if (seqmappings == null)
639       seqmappings = new Vector();
640     if (codonFrames != null && codonFrames.length > 0)
641     {
642       for (int cf = 0; cf < codonFrames.length; cf++)
643       {
644         if (seqmappings.contains(codonFrames[cf]))
645         {
646           if (add)
647           {
648             seqmappingrefs[seqmappings.indexOf(codonFrames[cf])]++;
649           }
650           else
651           {
652             if (--seqmappingrefs[seqmappings.indexOf(codonFrames[cf])] <= 0)
653             {
654               int pos = seqmappings.indexOf(codonFrames[cf]);
655               int[] nr = new int[seqmappingrefs.length - 1];
656               if (pos > 0)
657               {
658                 System.arraycopy(seqmappingrefs, 0, nr, 0, pos);
659               }
660               if (pos < seqmappingrefs.length - 1)
661               {
662                 System.arraycopy(seqmappingrefs, pos + 1, nr, 0,
663                         seqmappingrefs.length - pos - 2);
664               }
665             }
666           }
667         }
668         else
669         {
670           if (add)
671           {
672             seqmappings.addElement(codonFrames[cf]);
673
674             int[] nsr = new int[(seqmappingrefs == null) ? 1
675                     : seqmappingrefs.length + 1];
676             if (seqmappingrefs != null && seqmappingrefs.length > 0)
677               System.arraycopy(seqmappingrefs, 0, nsr, 0,
678                       seqmappingrefs.length);
679             nsr[(seqmappingrefs == null) ? 0 : seqmappingrefs.length] = 1;
680             seqmappingrefs = nsr;
681           }
682         }
683       }
684     }
685   }
686
687   public void removeMappings(AlignedCodonFrame[] codonFrames)
688   {
689     modifySeqMappingList(false, codonFrames);
690   }
691
692   public void addMappings(AlignedCodonFrame[] codonFrames)
693   {
694     modifySeqMappingList(true, codonFrames);
695   }
696
697   Vector<SelectionListener> sel_listeners = new Vector<SelectionListener>();
698
699   public void addSelectionListener(SelectionListener selecter)
700   {
701     if (!sel_listeners.contains(selecter))
702     {
703       sel_listeners.addElement(selecter);
704     }
705   }
706
707   public void removeSelectionListener(SelectionListener toremove)
708   {
709     if (sel_listeners.contains(toremove))
710     {
711       sel_listeners.removeElement(toremove);
712     }
713   }
714
715   public synchronized void sendSelection(
716           jalview.datamodel.SequenceGroup selection,
717           jalview.datamodel.ColumnSelection colsel, SelectionSource source)
718   {
719     if (sel_listeners != null && sel_listeners.size() > 0)
720     {
721       Enumeration listeners = sel_listeners.elements();
722       while (listeners.hasMoreElements())
723       {
724         SelectionListener slis = ((SelectionListener) listeners
725                 .nextElement());
726         if (slis != source)
727         {
728           slis.selection(selection, colsel, source);
729         }
730         ;
731       }
732     }
733   }
734   
735   Vector<AlignmentViewPanelListener> view_listeners=new Vector<AlignmentViewPanelListener>();
736   public synchronized void sendViewPosition(jalview.api.AlignmentViewPanel source, int startRes,
737           int endRes, int startSeq, int endSeq)
738   {
739
740     if (view_listeners != null && view_listeners.size() > 0)
741     {
742       Enumeration<AlignmentViewPanelListener> listeners = view_listeners.elements();
743       while (listeners.hasMoreElements())
744       {
745         AlignmentViewPanelListener slis = listeners
746                 .nextElement();
747         if (slis != source)
748         {
749           slis.viewPosition(startRes, endRes, startSeq, endSeq, source);
750         }
751         ;
752       }
753     }
754   }
755   
756
757   public void finalize() throws Throwable {
758     if (listeners!=null) {
759       listeners.clear();
760       listeners=null;
761     }
762     if (mappingData!=null)
763     {
764       mappingData.clear();
765       mappingData=null;
766     }
767     if (sel_listeners!=null)
768     {
769       sel_listeners.clear();
770       sel_listeners=null;
771     }
772     if (view_listeners!=null)
773     {
774       view_listeners.clear();
775       view_listeners=null;
776     }
777     mappings=null;
778     seqmappingrefs=null;
779   }
780
781   /**
782    * release all references associated with this manager provider
783    * @param jalviewLite
784    */
785   public static void release(StructureSelectionManagerProvider jalviewLite)
786   {
787     StructureSelectionManager mnger=(instances.get(jalviewLite));
788     if (mnger!=null)
789     {
790       instances.remove(jalviewLite);
791       try {
792         mnger.finalize();
793       } catch (Throwable x){};
794     }
795   }
796
797 }