src/jalview/structure/StructureSelectionManager.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.structure;
  22
  23 import jalview.analysis.AlignSeq;
  24 import jalview.api.StructureSelectionManagerProvider;
  25 import jalview.commands.CommandI;
  26 import jalview.commands.EditCommand;
  27 import jalview.commands.OrderCommand;
  28 import jalview.datamodel.AlignedCodonFrame;
  29 import jalview.datamodel.AlignmentAnnotation;
  30 import jalview.datamodel.AlignmentI;
  31 import jalview.datamodel.Annotation;
  32 import jalview.datamodel.PDBEntry;
  33 import jalview.datamodel.SearchResults;
  34 import jalview.datamodel.SequenceI;
  35 import jalview.gui.IProgressIndicator;
  36 import jalview.io.AppletFormatAdapter;
  37 import jalview.io.StructureFile;
  38 import jalview.util.MappingUtils;
  39 import jalview.util.MessageManager;
  40 import jalview.ws.sifts.SiftsClient;
  41 import jalview.ws.sifts.SiftsException;
  42 import jalview.ws.sifts.SiftsSettings;
  43
  44 import java.io.PrintStream;
  45 import java.util.ArrayList;
  46 import java.util.Arrays;
  47 import java.util.Collections;
  48 import java.util.Enumeration;
  49 import java.util.HashMap;
  50 import java.util.IdentityHashMap;
  51 import java.util.List;
  52 import java.util.Map;
  53 import java.util.Vector;
  54
  55 import MCview.Atom;
  56 import MCview.PDBChain;
  57 import MCview.PDBfile;
  58
  59 public class StructureSelectionManager
  60 {
  61   public final static String NEWLINE = System.lineSeparator();
  62
  63   static IdentityHashMap<StructureSelectionManagerProvider, StructureSelectionManager> instances;
  64
  65   private List<StructureMapping> mappings = new ArrayList<StructureMapping>();
  66
  67   private boolean processSecondaryStructure = false;
  68
  69   private boolean secStructServices = false;
  70
  71   private boolean addTempFacAnnot = false;
  72
  73   private IProgressIndicator progressIndicator;
  74
  75   private SiftsClient siftsClient = null;
  76
  77   private long progressSessionId;
  78
  79   /*
  80    * Set of any registered mappings between (dataset) sequences.
  81    */
  82   private List<AlignedCodonFrame> seqmappings = new ArrayList<AlignedCodonFrame>();
  83
  84   private List<CommandListener> commandListeners = new ArrayList<CommandListener>();
  85
  86   private List<SelectionListener> sel_listeners = new ArrayList<SelectionListener>();
  87
  88   /**
  89    * @return true if will try to use external services for processing secondary
  90    *         structure
  91    */
  92   public boolean isSecStructServices()
  93   {
  94     return secStructServices;
  95   }
  96
  97   /**
  98    * control use of external services for processing secondary structure
  99    *
 100    * @param secStructServices
 101    */
 102   public void setSecStructServices(boolean secStructServices)
 103   {
 104     this.secStructServices = secStructServices;
 105   }
 106
 107   /**
 108    * flag controlling addition of any kind of structural annotation
 109    *
 110    * @return true if temperature factor annotation will be added
 111    */
 112   public boolean isAddTempFacAnnot()
 113   {
 114     return addTempFacAnnot;
 115   }
 116
 117   /**
 118    * set flag controlling addition of structural annotation
 119    *
 120    * @param addTempFacAnnot
 121    */
 122   public void setAddTempFacAnnot(boolean addTempFacAnnot)
 123   {
 124     this.addTempFacAnnot = addTempFacAnnot;
 125   }
 126
 127   /**
 128    *
 129    * @return if true, the structure manager will attempt to add secondary
 130    *         structure lines for unannotated sequences
 131    */
 132
 133   public boolean isProcessSecondaryStructure()
 134   {
 135     return processSecondaryStructure;
 136   }
 137
 138   /**
 139    * Control whether structure manager will try to annotate mapped sequences
 140    * with secondary structure from PDB data.
 141    *
 142    * @param enable
 143    */
 144   public void setProcessSecondaryStructure(boolean enable)
 145   {
 146     processSecondaryStructure = enable;
 147   }
 148
 149   /**
 150    * debug function - write all mappings to stdout
 151    */
 152   public void reportMapping()
 153   {
 154     if (mappings.isEmpty())
 155     {
 156       System.err.println("reportMapping: No PDB/Sequence mappings.");
 157     }
 158     else
 159     {
 160       System.err.println("reportMapping: There are " + mappings.size()
 161               + " mappings.");
 162       int i = 0;
 163       for (StructureMapping sm : mappings)
 164       {
 165         System.err.println("mapping " + i++ + " : " + sm.pdbfile);
 166       }
 167     }
 168   }
 169
 170   /**
 171    * map between the PDB IDs (or structure identifiers) used by Jalview and the
 172    * absolute filenames for PDB data that corresponds to it
 173    */
 174   Map<String, String> pdbIdFileName = new HashMap<String, String>();
 175
 176   Map<String, String> pdbFileNameId = new HashMap<String, String>();
 177
 178   public void registerPDBFile(String idForFile, String absoluteFile)
 179   {
 180     pdbIdFileName.put(idForFile, absoluteFile);
 181     pdbFileNameId.put(absoluteFile, idForFile);
 182   }
 183
 184   public String findIdForPDBFile(String idOrFile)
 185   {
 186     String id = pdbFileNameId.get(idOrFile);
 187     return id;
 188   }
 189
 190   public String findFileForPDBId(String idOrFile)
 191   {
 192     String id = pdbIdFileName.get(idOrFile);
 193     return id;
 194   }
 195
 196   public boolean isPDBFileRegistered(String idOrFile)
 197   {
 198     return pdbFileNameId.containsKey(idOrFile)
 199             || pdbIdFileName.containsKey(idOrFile);
 200   }
 201
 202   private static StructureSelectionManager nullProvider = null;
 203
 204   public static StructureSelectionManager getStructureSelectionManager(
 205           StructureSelectionManagerProvider context)
 206   {
 207     if (context == null)
 208     {
 209       if (nullProvider == null)
 210       {
 211         if (instances != null)
 212         {
 213           throw new Error(
 214                   MessageManager
 215                           .getString("error.implementation_error_structure_selection_manager_null"),
 216                   new NullPointerException(MessageManager
 217                           .getString("exception.ssm_context_is_null")));
 218         }
 219         else
 220         {
 221           nullProvider = new StructureSelectionManager();
 222         }
 223         return nullProvider;
 224       }
 225     }
 226     if (instances == null)
 227     {
 228       instances = new java.util.IdentityHashMap<StructureSelectionManagerProvider, StructureSelectionManager>();
 229     }
 230     StructureSelectionManager instance = instances.get(context);
 231     if (instance == null)
 232     {
 233       if (nullProvider != null)
 234       {
 235         instance = nullProvider;
 236       }
 237       else
 238       {
 239         instance = new StructureSelectionManager();
 240       }
 241       instances.put(context, instance);
 242     }
 243     return instance;
 244   }
 245
 246   /**
 247    * flag controlling whether SeqMappings are relayed from received sequence
 248    * mouse over events to other sequences
 249    */
 250   boolean relaySeqMappings = true;
 251
 252   /**
 253    * Enable or disable relay of seqMapping events to other sequences. You might
 254    * want to do this if there are many sequence mappings and the host computer
 255    * is slow
 256    *
 257    * @param relay
 258    */
 259   public void setRelaySeqMappings(boolean relay)
 260   {
 261     relaySeqMappings = relay;
 262   }
 263
 264   /**
 265    * get the state of the relay seqMappings flag.
 266    *
 267    * @return true if sequence mouse overs are being relayed to other mapped
 268    *         sequences
 269    */
 270   public boolean isRelaySeqMappingsEnabled()
 271   {
 272     return relaySeqMappings;
 273   }
 274
 275   Vector listeners = new Vector();
 276
 277   /**
 278    * register a listener for alignment sequence mouseover events
 279    *
 280    * @param svl
 281    */
 282   public void addStructureViewerListener(Object svl)
 283   {
 284     if (!listeners.contains(svl))
 285     {
 286       listeners.addElement(svl);
 287     }
 288   }
 289
 290   /**
 291    * Returns the file name for a mapped PDB id (or null if not mapped).
 292    *
 293    * @param pdbid
 294    * @return
 295    */
 296   public String alreadyMappedToFile(String pdbid)
 297   {
 298     for (StructureMapping sm : mappings)
 299     {
 300       if (sm.getPdbId().equals(pdbid))
 301       {
 302         return sm.pdbfile;
 303       }
 304     }
 305     return null;
 306   }
 307
 308   /**
 309    * Import structure data and register a structure mapping for broadcasting
 310    * colouring, mouseovers and selection events (convenience wrapper).
 311    *
 312    * @param sequence
 313    *          - one or more sequences to be mapped to pdbFile
 314    * @param targetChains
 315    *          - optional chain specification for mapping each sequence to pdb
 316    *          (may be nill, individual elements may be nill)
 317    * @param pdbFile
 318    *          - structure data resource
 319    * @param protocol
 320    *          - how to resolve data from resource
 321    * @return null or the structure data parsed as a pdb file
 322    */
 323   synchronized public StructureFile setMapping(SequenceI[] sequence,
 324           String[] targetChains, String pdbFile, String protocol)
 325   {
 326     return setMapping(true, sequence, targetChains, pdbFile, protocol);
 327   }
 328
 329
 330   /**
 331    * create sequence structure mappings between each sequence and the given
 332    * pdbFile (retrieved via the given protocol).
 333    *
 334    * @param forStructureView
 335    *          when true, record the mapping for use in mouseOvers
 336    *
 337    * @param sequenceArray
 338    *          - one or more sequences to be mapped to pdbFile
 339    * @param targetChainIds
 340    *          - optional chain specification for mapping each sequence to pdb
 341    *          (may be nill, individual elements may be nill)
 342    * @param pdbFile
 343    *          - structure data resource
 344    * @param protocol
 345    *          - how to resolve data from resource
 346    * @return null or the structure data parsed as a pdb file
 347    */
 348   synchronized public StructureFile setMapping(boolean forStructureView,
 349           SequenceI[] sequenceArray, String[] targetChainIds,
 350           String pdbFile,
 351           String protocol)
 352   {
 353     /*
 354      * There will be better ways of doing this in the future, for now we'll use
 355      * the tried and tested MCview pdb mapping
 356      */
 357     boolean parseSecStr = processSecondaryStructure;
 358     if (isPDBFileRegistered(pdbFile))
 359     {
 360       for (SequenceI sq : sequenceArray)
 361       {
 362         SequenceI ds = sq;
 363         while (ds.getDatasetSequence() != null)
 364         {
 365           ds = ds.getDatasetSequence();
 366         }
 367         ;
 368         if (ds.getAnnotation() != null)
 369         {
 370           for (AlignmentAnnotation ala : ds.getAnnotation())
 371           {
 372             // false if any annotation present from this structure
 373             // JBPNote this fails for jmol/chimera view because the *file* is
 374             // passed, not the structure data ID -
 375             if (PDBfile.isCalcIdForFile(ala, findIdForPDBFile(pdbFile)))
 376             {
 377               parseSecStr = false;
 378             }
 379           }
 380         }
 381       }
 382     }
 383     StructureFile pdb = null;
 384     boolean isMapUsingSIFTs = SiftsSettings.isMapWithSifts();
 385     try
 386     {
 387
 388       if (pdbFile != null && isCIFFile(pdbFile))
 389       {
 390         pdb = new jalview.ext.jmol.JmolParser(addTempFacAnnot, parseSecStr,
 391                 secStructServices, pdbFile, protocol);
 392       }
 393       else
 394       {
 395         pdb = new PDBfile(addTempFacAnnot, parseSecStr, secStructServices,
 396                 pdbFile, protocol);
 397       }
 398
 399       if (pdb.getId() != null && pdb.getId().trim().length() > 0
 400               && AppletFormatAdapter.FILE.equals(protocol))
 401       {
 402         registerPDBFile(pdb.getId().trim(), pdbFile);
 403       }
 404     } catch (Exception ex)
 405     {
 406       ex.printStackTrace();
 407       return null;
 408     }
 409
 410     try
 411     {
 412       if (isMapUsingSIFTs)
 413       {
 414         siftsClient = new SiftsClient(pdb);
 415       }
 416     } catch (SiftsException e)
 417     {
 418       isMapUsingSIFTs = false;
 419       e.printStackTrace();
 420     }
 421
 422     String targetChainId;
 423     for (int s = 0; s < sequenceArray.length; s++)
 424     {
 425       boolean infChain = true;
 426       final SequenceI seq = sequenceArray[s];
 427       if (targetChainIds != null && targetChainIds[s] != null)
 428       {
 429         infChain = false;
 430         targetChainId = targetChainIds[s];
 431       }
 432       else if (seq.getName().indexOf("|") > -1)
 433       {
 434         targetChainId = seq.getName().substring(
 435                 seq.getName().lastIndexOf("|") + 1);
 436         if (targetChainId.length() > 1)
 437         {
 438           if (targetChainId.trim().length() == 0)
 439           {
 440             targetChainId = " ";
 441           }
 442           else
 443           {
 444             // not a valid chain identifier
 445             targetChainId = "";
 446           }
 447         }
 448       }
 449       else
 450       {
 451         targetChainId = "";
 452       }
 453
 454       /*
 455        * Attempt pairwise alignment of the sequence with each chain in the PDB,
 456        * and remember the highest scoring chain
 457        */
 458       int max = -10;
 459       AlignSeq maxAlignseq = null;
 460       String maxChainId = " ";
 461       PDBChain maxChain = null;
 462       boolean first = true;
 463       for (PDBChain chain : pdb.getChains())
 464       {
 465         if (targetChainId.length() > 0 && !targetChainId.equals(chain.id)
 466                 && !infChain)
 467         {
 468           continue; // don't try to map chains don't match.
 469         }
 470         // TODO: correctly determine sequence type for mixed na/peptide
 471         // structures
 472         final String type = chain.isNa ? AlignSeq.DNA : AlignSeq.PEP;
 473         AlignSeq as = AlignSeq.doGlobalNWAlignment(seq, chain.sequence,
 474                 type);
 475         // equivalent to:
 476         // AlignSeq as = new AlignSeq(sequence[s], chain.sequence, type);
 477         // as.calcScoreMatrix();
 478         // as.traceAlignment();
 479
 480         if (first || as.maxscore > max
 481                 || (as.maxscore == max && chain.id.equals(targetChainId)))
 482         {
 483           first = false;
 484           maxChain = chain;
 485           max = as.maxscore;
 486           maxAlignseq = as;
 487           maxChainId = chain.id;
 488         }
 489       }
 490       if (maxChain == null)
 491       {
 492         continue;
 493       }
 494
 495       if (protocol.equals(jalview.io.AppletFormatAdapter.PASTE))
 496       {
 497         pdbFile = "INLINE" + pdb.getId();
 498       }
 499
 500       ArrayList<StructureMapping> seqToStrucMapping = new ArrayList<StructureMapping>();
 501       if (isMapUsingSIFTs)
 502       {
 503         setProgressBar(null);
 504         setProgressBar("Obtaining mapping with SIFTS");
 505         jalview.datamodel.Mapping sqmpping = maxAlignseq
 506                 .getMappingFromS1(false);
 507         if (targetChainId != null && !targetChainId.trim().isEmpty())
 508         {
 509           StructureMapping mapping = getStructureMapping(seq, pdbFile,
 510                   targetChainId, pdb, maxChain, sqmpping, maxAlignseq);
 511           seqToStrucMapping.add(mapping);
 512         }
 513         else
 514         {
 515           for (PDBChain chain : pdb.getChains())
 516           {
 517             StructureMapping mapping = getStructureMapping(seq, pdbFile,
 518                     chain.id, pdb, chain, sqmpping, maxAlignseq);
 519             seqToStrucMapping.add(mapping);
 520           }
 521         }
 522       }
 523       else
 524       {
 525         setProgressBar(null);
 526         setProgressBar("Obtaining mapping with NW alignment");
 527         seqToStrucMapping.add(getNWMappings(seq, pdbFile, maxChainId,
 528                 maxChain, pdb, maxAlignseq));
 529       }
 530
 531       if (forStructureView)
 532       {
 533         mappings.addAll(seqToStrucMapping);
 534       }
 535     }
 536     return pdb;
 537   }
 538
 539   private boolean isCIFFile(String filename)
 540   {
 541     String fileExt = filename.substring(filename.lastIndexOf(".") + 1,
 542             filename.length());
 543     return "cif".equalsIgnoreCase(fileExt);
 544   }
 545
 546   private StructureMapping getStructureMapping(SequenceI seq,
 547           String pdbFile, String targetChainId, StructureFile pdb,
 548           PDBChain maxChain, jalview.datamodel.Mapping sqmpping,
 549           AlignSeq maxAlignseq)
 550   {
 551     String maxChainId = targetChainId;
 552     try
 553     {
 554       StructureMapping curChainMapping = siftsClient
 555               .getSiftsStructureMapping(seq, pdbFile, targetChainId);
 556       try
 557       {
 558       PDBChain chain = pdb.findChain(targetChainId);
 559       if (chain != null)
 560       {
 561         chain.transferResidueAnnotation(curChainMapping, sqmpping);
 562       }
 563       } catch (Exception e)
 564       {
 565         e.printStackTrace();
 566       }
 567       return curChainMapping;
 568     } catch (SiftsException e)
 569     {
 570       System.err.println(e.getMessage());
 571       System.err.println(">>> Now switching mapping with NW alignment...");
 572       setProgressBar(null);
 573       setProgressBar(">>> Now switching mapping with NW alignment...");
 574       return getNWMappings(seq, pdbFile, maxChainId, maxChain, pdb,
 575               maxAlignseq);
 576     }
 577   }
 578
 579   private StructureMapping getNWMappings(SequenceI seq,
 580           String pdbFile,
 581           String maxChainId, PDBChain maxChain, StructureFile pdb,
 582           AlignSeq maxAlignseq)
 583   {
 584     final StringBuilder mappingDetails = new StringBuilder(128);
 585     mappingDetails.append(NEWLINE).append(
 586             "Sequence \u27f7 Structure mapping details");
 587     mappingDetails.append(NEWLINE);
 588     mappingDetails
 589             .append("Method: inferred with Needleman & Wunsch alignment");
 590     mappingDetails.append(NEWLINE).append("PDB Sequence is :")
 591             .append(NEWLINE).append("Sequence = ")
 592             .append(maxChain.sequence.getSequenceAsString());
 593     mappingDetails.append(NEWLINE).append("No of residues = ")
 594             .append(maxChain.residues.size()).append(NEWLINE)
 595             .append(NEWLINE);
 596     PrintStream ps = new PrintStream(System.out)
 597     {
 598       @Override
 599       public void print(String x)
 600       {
 601         mappingDetails.append(x);
 602       }
 603
 604       @Override
 605       public void println()
 606       {
 607         mappingDetails.append(NEWLINE);
 608       }
 609     };
 610
 611     maxAlignseq.printAlignment(ps);
 612
 613     mappingDetails.append(NEWLINE).append("PDB start/end ");
 614     mappingDetails.append(String.valueOf(maxAlignseq.seq2start))
 615             .append(" ");
 616     mappingDetails.append(String.valueOf(maxAlignseq.seq2end));
 617     mappingDetails.append(NEWLINE).append("SEQ start/end ");
 618     mappingDetails.append(
 619             String.valueOf(maxAlignseq.seq1start + (seq.getStart() - 1)))
 620             .append(" ");
 621     mappingDetails.append(String.valueOf(maxAlignseq.seq1end
 622             + (seq.getStart() - 1)));
 623     mappingDetails.append(NEWLINE);
 624     maxChain.makeExactMapping(maxAlignseq, seq);
 625     jalview.datamodel.Mapping sqmpping = maxAlignseq
 626             .getMappingFromS1(false);
 627     maxChain.transferRESNUMFeatures(seq, null);
 628
 629     HashMap<Integer, int[]> mapping = new HashMap<Integer, int[]>();
 630     int resNum = -10000;
 631     int index = 0;
 632     char insCode = ' ';
 633
 634     do
 635     {
 636       Atom tmp = maxChain.atoms.elementAt(index);
 637       if ((resNum != tmp.resNumber || insCode != tmp.insCode)
 638               && tmp.alignmentMapping != -1)
 639       {
 640         resNum = tmp.resNumber;
 641         insCode = tmp.insCode;
 642         if (tmp.alignmentMapping >= -1)
 643         {
 644           mapping.put(tmp.alignmentMapping + 1, new int[] { tmp.resNumber,
 645               tmp.atomIndex });
 646         }
 647       }
 648
 649       index++;
 650     } while (index < maxChain.atoms.size());
 651
 652     StructureMapping nwMapping = new StructureMapping(seq, pdbFile,
 653             pdb.getId(), maxChainId, mapping, mappingDetails.toString());
 654     maxChain.transferResidueAnnotation(nwMapping, sqmpping);
 655     return nwMapping;
 656   }
 657
 658   public void removeStructureViewerListener(Object svl, String[] pdbfiles)
 659   {
 660     listeners.removeElement(svl);
 661     if (svl instanceof SequenceListener)
 662     {
 663       for (int i = 0; i < listeners.size(); i++)
 664       {
 665         if (listeners.elementAt(i) instanceof StructureListener)
 666         {
 667           ((StructureListener) listeners.elementAt(i))
 668                   .releaseReferences(svl);
 669         }
 670       }
 671     }
 672
 673     if (pdbfiles == null)
 674     {
 675       return;
 676     }
 677
 678     /*
 679      * Remove mappings to the closed listener's PDB files, but first check if
 680      * another listener is still interested
 681      */
 682     List<String> pdbs = new ArrayList<String>(Arrays.asList(pdbfiles));
 683
 684     StructureListener sl;
 685     for (int i = 0; i < listeners.size(); i++)
 686     {
 687       if (listeners.elementAt(i) instanceof StructureListener)
 688       {
 689         sl = (StructureListener) listeners.elementAt(i);
 690         for (String pdbfile : sl.getPdbFile())
 691         {
 692           pdbs.remove(pdbfile);
 693         }
 694       }
 695     }
 696
 697     /*
 698      * Rebuild the mappings set, retaining only those which are for 'other' PDB
 699      * files
 700      */
 701     if (pdbs.size() > 0)
 702     {
 703       List<StructureMapping> tmp = new ArrayList<StructureMapping>();
 704       for (StructureMapping sm : mappings)
 705       {
 706         if (!pdbs.contains(sm.pdbfile))
 707         {
 708           tmp.add(sm);
 709         }
 710       }
 711
 712       mappings = tmp;
 713     }
 714   }
 715
 716   /**
 717    * Propagate mouseover of a single position in a structure
 718    *
 719    * @param pdbResNum
 720    * @param chain
 721    * @param pdbfile
 722    */
 723   public void mouseOverStructure(int pdbResNum, String chain, String pdbfile)
 724   {
 725     AtomSpec atomSpec = new AtomSpec(pdbfile, chain, pdbResNum, 0);
 726     List<AtomSpec> atoms = Collections.singletonList(atomSpec);
 727     mouseOverStructure(atoms);
 728   }
 729
 730   /**
 731    * Propagate mouseover or selection of multiple positions in a structure
 732    *
 733    * @param atoms
 734    */
 735   public void mouseOverStructure(List<AtomSpec> atoms)
 736   {
 737     if (listeners == null)
 738     {
 739       // old or prematurely sent event
 740       return;
 741     }
 742     boolean hasSequenceListener = false;
 743     for (int i = 0; i < listeners.size(); i++)
 744     {
 745       if (listeners.elementAt(i) instanceof SequenceListener)
 746       {
 747         hasSequenceListener = true;
 748       }
 749     }
 750     if (!hasSequenceListener)
 751     {
 752       return;
 753     }
 754
 755     SearchResults results = new SearchResults();
 756     for (AtomSpec atom : atoms)
 757     {
 758       SequenceI lastseq = null;
 759       int lastipos = -1;
 760       for (StructureMapping sm : mappings)
 761       {
 762         if (sm.pdbfile.equals(atom.getPdbFile())
 763                 && sm.pdbchain.equals(atom.getChain()))
 764         {
 765           int indexpos = sm.getSeqPos(atom.getPdbResNum());
 766           if (lastipos != indexpos && lastseq != sm.sequence)
 767           {
 768             results.addResult(sm.sequence, indexpos, indexpos);
 769             lastipos = indexpos;
 770             lastseq = sm.sequence;
 771             // construct highlighted sequence list
 772             for (AlignedCodonFrame acf : seqmappings)
 773             {
 774               acf.markMappedRegion(sm.sequence, indexpos, results);
 775             }
 776           }
 777         }
 778       }
 779     }
 780     for (Object li : listeners)
 781     {
 782       if (li instanceof SequenceListener)
 783       {
 784         ((SequenceListener) li).highlightSequence(results);
 785       }
 786     }
 787   }
 788
 789   /**
 790    * highlight regions associated with a position (indexpos) in seq
 791    *
 792    * @param seq
 793    *          the sequence that the mouse over occurred on
 794    * @param indexpos
 795    *          the absolute position being mouseovered in seq (0 to seq.length())
 796    * @param seqPos
 797    *          the sequence position (if -1, seq.findPosition is called to
 798    *          resolve the residue number)
 799    */
 800   public void mouseOverSequence(SequenceI seq, int indexpos, int seqPos,
 801           VamsasSource source)
 802   {
 803     boolean hasSequenceListeners = handlingVamsasMo
 804             || !seqmappings.isEmpty();
 805     SearchResults results = null;
 806     if (seqPos == -1)
 807     {
 808       seqPos = seq.findPosition(indexpos);
 809     }
 810     for (int i = 0; i < listeners.size(); i++)
 811     {
 812       Object listener = listeners.elementAt(i);
 813       if (listener == source)
 814       {
 815         // TODO listener (e.g. SeqPanel) is never == source (AlignViewport)
 816         // Temporary fudge with SequenceListener.getVamsasSource()
 817         continue;
 818       }
 819       if (listener instanceof StructureListener)
 820       {
 821         highlightStructure((StructureListener) listener, seq, seqPos);
 822       }
 823       else
 824       {
 825         if (listener instanceof SequenceListener)
 826         {
 827           final SequenceListener seqListener = (SequenceListener) listener;
 828           if (hasSequenceListeners
 829                   && seqListener.getVamsasSource() != source)
 830           {
 831             if (relaySeqMappings)
 832             {
 833               if (results == null)
 834               {
 835                 results = MappingUtils.buildSearchResults(seq, seqPos,
 836                         seqmappings);
 837               }
 838               if (handlingVamsasMo)
 839               {
 840                 results.addResult(seq, seqPos, seqPos);
 841
 842               }
 843               if (!results.isEmpty())
 844               {
 845                 seqListener.highlightSequence(results);
 846               }
 847             }
 848           }
 849         }
 850         else if (listener instanceof VamsasListener && !handlingVamsasMo)
 851         {
 852           ((VamsasListener) listener).mouseOverSequence(seq, indexpos,
 853                   source);
 854         }
 855         else if (listener instanceof SecondaryStructureListener)
 856         {
 857           ((SecondaryStructureListener) listener).mouseOverSequence(seq,
 858                   indexpos, seqPos);
 859         }
 860       }
 861     }
 862   }
 863
 864   /**
 865    * Send suitable messages to a StructureListener to highlight atoms
 866    * corresponding to the given sequence position(s)
 867    *
 868    * @param sl
 869    * @param seq
 870    * @param positions
 871    */
 872   public void highlightStructure(StructureListener sl, SequenceI seq,
 873           int... positions)
 874   {
 875     if (!sl.isListeningFor(seq))
 876     {
 877       return;
 878     }
 879     int atomNo;
 880     List<AtomSpec> atoms = new ArrayList<AtomSpec>();
 881     for (StructureMapping sm : mappings)
 882     {
 883       if (sm.sequence == seq || sm.sequence == seq.getDatasetSequence())
 884       {
 885         for (int index : positions)
 886         {
 887           atomNo = sm.getAtomNum(index);
 888
 889           if (atomNo > 0)
 890           {
 891             atoms.add(new AtomSpec(sm.pdbfile, sm.pdbchain, sm
 892                     .getPDBResNum(index), atomNo));
 893           }
 894         }
 895       }
 896     }
 897     sl.highlightAtoms(atoms);
 898   }
 899
 900   /**
 901    * true if a mouse over event from an external (ie Vamsas) source is being
 902    * handled
 903    */
 904   boolean handlingVamsasMo = false;
 905
 906   long lastmsg = 0;
 907
 908   /**
 909    * as mouseOverSequence but only route event to SequenceListeners
 910    *
 911    * @param sequenceI
 912    * @param position
 913    *          in an alignment sequence
 914    */
 915   public void mouseOverVamsasSequence(SequenceI sequenceI, int position,
 916           VamsasSource source)
 917   {
 918     handlingVamsasMo = true;
 919     long msg = sequenceI.hashCode() * (1 + position);
 920     if (lastmsg != msg)
 921     {
 922       lastmsg = msg;
 923       mouseOverSequence(sequenceI, position, -1, source);
 924     }
 925     handlingVamsasMo = false;
 926   }
 927
 928   public Annotation[] colourSequenceFromStructure(SequenceI seq,
 929           String pdbid)
 930   {
 931     return null;
 932     // THIS WILL NOT BE AVAILABLE IN JALVIEW 2.3,
 933     // UNTIL THE COLOUR BY ANNOTATION IS REWORKED
 934     /*
 935      * Annotation [] annotations = new Annotation[seq.getLength()];
 936      *
 937      * StructureListener sl; int atomNo = 0; for (int i = 0; i <
 938      * listeners.size(); i++) { if (listeners.elementAt(i) instanceof
 939      * StructureListener) { sl = (StructureListener) listeners.elementAt(i);
 940      *
 941      * for (int j = 0; j < mappings.length; j++) {
 942      *
 943      * if (mappings[j].sequence == seq && mappings[j].getPdbId().equals(pdbid)
 944      * && mappings[j].pdbfile.equals(sl.getPdbFile())) {
 945      * System.out.println(pdbid+" "+mappings[j].getPdbId() +"
 946      * "+mappings[j].pdbfile);
 947      *
 948      * java.awt.Color col; for(int index=0; index<seq.getLength(); index++) {
 949      * if(jalview.util.Comparison.isGap(seq.getCharAt(index))) continue;
 950      *
 951      * atomNo = mappings[j].getAtomNum(seq.findPosition(index)); col =
 952      * java.awt.Color.white; if (atomNo > 0) { col = sl.getColour(atomNo,
 953      * mappings[j].getPDBResNum(index), mappings[j].pdbchain,
 954      * mappings[j].pdbfile); }
 955      *
 956      * annotations[index] = new Annotation("X",null,' ',0,col); } return
 957      * annotations; } } } }
 958      *
 959      * return annotations;
 960      */
 961   }
 962
 963   public void structureSelectionChanged()
 964   {
 965   }
 966
 967   public void sequenceSelectionChanged()
 968   {
 969   }
 970
 971   public void sequenceColoursChanged(Object source)
 972   {
 973     StructureListener sl;
 974     for (int i = 0; i < listeners.size(); i++)
 975     {
 976       if (listeners.elementAt(i) instanceof StructureListener)
 977       {
 978         sl = (StructureListener) listeners.elementAt(i);
 979         sl.updateColours(source);
 980       }
 981     }
 982   }
 983
 984   public StructureMapping[] getMapping(String pdbfile)
 985   {
 986     List<StructureMapping> tmp = new ArrayList<StructureMapping>();
 987     for (StructureMapping sm : mappings)
 988     {
 989       if (sm.pdbfile.equals(pdbfile))
 990       {
 991         tmp.add(sm);
 992       }
 993     }
 994     return tmp.toArray(new StructureMapping[tmp.size()]);
 995   }
 996
 997   /**
 998    * Returns a readable description of all mappings for the given pdbfile to any
 999    * of the given sequences
1000    *
1001    * @param pdbfile
1002    * @param seqs
1003    * @return
1004    */
1005   public String printMappings(String pdbfile, List<SequenceI> seqs)
1006   {
1007     if (pdbfile == null || seqs == null || seqs.isEmpty())
1008     {
1009       return "";
1010     }
1011
1012     StringBuilder sb = new StringBuilder(64);
1013     for (StructureMapping sm : mappings)
1014     {
1015       if (sm.pdbfile.equals(pdbfile) && seqs.contains(sm.sequence))
1016       {
1017         sb.append(sm.mappingDetails);
1018         sb.append(NEWLINE);
1019         // separator makes it easier to read multiple mappings
1020         sb.append("=====================");
1021         sb.append(NEWLINE);
1022       }
1023     }
1024     sb.append(NEWLINE);
1025
1026     return sb.toString();
1027   }
1028
1029   /**
1030    * Remove the given mapping
1031    *
1032    * @param acf
1033    */
1034   public void deregisterMapping(AlignedCodonFrame acf)
1035   {
1036     if (acf != null)
1037     {
1038       boolean removed = seqmappings.remove(acf);
1039       if (removed && seqmappings.isEmpty())
1040       { // debug
1041         System.out.println("All mappings removed");
1042       }
1043     }
1044   }
1045
1046   /**
1047    * Add each of the given codonFrames to the stored set, if not aready present.
1048    *
1049    * @param mappings
1050    */
1051   public void registerMappings(List<AlignedCodonFrame> mappings)
1052   {
1053     if (mappings != null)
1054     {
1055       for (AlignedCodonFrame acf : mappings)
1056       {
1057         registerMapping(acf);
1058       }
1059     }
1060   }
1061
1062   /**
1063    * Add the given mapping to the stored set, unless already stored.
1064    */
1065   public void registerMapping(AlignedCodonFrame acf)
1066   {
1067     if (acf != null)
1068     {
1069       if (!seqmappings.contains(acf))
1070       {
1071         seqmappings.add(acf);
1072       }
1073     }
1074   }
1075
1076   /**
1077    * Resets this object to its initial state by removing all registered
1078    * listeners, codon mappings, PDB file mappings
1079    */
1080   public void resetAll()
1081   {
1082     if (mappings != null)
1083     {
1084       mappings.clear();
1085     }
1086     if (seqmappings != null)
1087     {
1088       seqmappings.clear();
1089     }
1090     if (sel_listeners != null)
1091     {
1092       sel_listeners.clear();
1093     }
1094     if (listeners != null)
1095     {
1096       listeners.clear();
1097     }
1098     if (commandListeners != null)
1099     {
1100       commandListeners.clear();
1101     }
1102     if (view_listeners != null)
1103     {
1104       view_listeners.clear();
1105     }
1106     if (pdbFileNameId != null)
1107     {
1108       pdbFileNameId.clear();
1109     }
1110     if (pdbIdFileName != null)
1111     {
1112       pdbIdFileName.clear();
1113     }
1114   }
1115
1116   public void addSelectionListener(SelectionListener selecter)
1117   {
1118     if (!sel_listeners.contains(selecter))
1119     {
1120       sel_listeners.add(selecter);
1121     }
1122   }
1123
1124   public void removeSelectionListener(SelectionListener toremove)
1125   {
1126     if (sel_listeners.contains(toremove))
1127     {
1128       sel_listeners.remove(toremove);
1129     }
1130   }
1131
1132   public synchronized void sendSelection(
1133           jalview.datamodel.SequenceGroup selection,
1134           jalview.datamodel.ColumnSelection colsel, SelectionSource source)
1135   {
1136     for (SelectionListener slis : sel_listeners)
1137     {
1138       if (slis != source)
1139       {
1140         slis.selection(selection, colsel, source);
1141       }
1142     }
1143   }
1144
1145   Vector<AlignmentViewPanelListener> view_listeners = new Vector<AlignmentViewPanelListener>();
1146
1147   public synchronized void sendViewPosition(
1148           jalview.api.AlignmentViewPanel source, int startRes, int endRes,
1149           int startSeq, int endSeq)
1150   {
1151
1152     if (view_listeners != null && view_listeners.size() > 0)
1153     {
1154       Enumeration<AlignmentViewPanelListener> listeners = view_listeners
1155               .elements();
1156       while (listeners.hasMoreElements())
1157       {
1158         AlignmentViewPanelListener slis = listeners.nextElement();
1159         if (slis != source)
1160         {
1161           slis.viewPosition(startRes, endRes, startSeq, endSeq, source);
1162         }
1163         ;
1164       }
1165     }
1166   }
1167
1168   /**
1169    * release all references associated with this manager provider
1170    *
1171    * @param jalviewLite
1172    */
1173   public static void release(StructureSelectionManagerProvider jalviewLite)
1174   {
1175     // synchronized (instances)
1176     {
1177       if (instances == null)
1178       {
1179         return;
1180       }
1181       StructureSelectionManager mnger = (instances.get(jalviewLite));
1182       if (mnger != null)
1183       {
1184         instances.remove(jalviewLite);
1185         try
1186         {
1187           mnger.finalize();
1188         } catch (Throwable x)
1189         {
1190         }
1191       }
1192     }
1193   }
1194
1195   public void registerPDBEntry(PDBEntry pdbentry)
1196   {
1197     if (pdbentry.getFile() != null
1198             && pdbentry.getFile().trim().length() > 0)
1199     {
1200       registerPDBFile(pdbentry.getId(), pdbentry.getFile());
1201     }
1202   }
1203
1204   public void addCommandListener(CommandListener cl)
1205   {
1206     if (!commandListeners.contains(cl))
1207     {
1208       commandListeners.add(cl);
1209     }
1210   }
1211
1212   public boolean hasCommandListener(CommandListener cl)
1213   {
1214     return this.commandListeners.contains(cl);
1215   }
1216
1217   public boolean removeCommandListener(CommandListener l)
1218   {
1219     return commandListeners.remove(l);
1220   }
1221
1222   /**
1223    * Forward a command to any command listeners (except for the command's
1224    * source).
1225    *
1226    * @param command
1227    *          the command to be broadcast (in its form after being performed)
1228    * @param undo
1229    *          if true, the command was being 'undone'
1230    * @param source
1231    */
1232   public void commandPerformed(CommandI command, boolean undo,
1233           VamsasSource source)
1234   {
1235     for (CommandListener listener : commandListeners)
1236     {
1237       listener.mirrorCommand(command, undo, this, source);
1238     }
1239   }
1240
1241   /**
1242    * Returns a new CommandI representing the given command as mapped to the
1243    * given sequences. If no mapping could be made, or the command is not of a
1244    * mappable kind, returns null.
1245    *
1246    * @param command
1247    * @param undo
1248    * @param mapTo
1249    * @param gapChar
1250    * @return
1251    */
1252   public CommandI mapCommand(CommandI command, boolean undo,
1253           final AlignmentI mapTo, char gapChar)
1254   {
1255     if (command instanceof EditCommand)
1256     {
1257       return MappingUtils.mapEditCommand((EditCommand) command, undo,
1258               mapTo, gapChar, seqmappings);
1259     }
1260     else if (command instanceof OrderCommand)
1261     {
1262       return MappingUtils.mapOrderCommand((OrderCommand) command, undo,
1263               mapTo, seqmappings);
1264     }
1265     return null;
1266   }
1267
1268   public IProgressIndicator getProgressIndicator()
1269   {
1270     return progressIndicator;
1271   }
1272
1273   public void setProgressIndicator(IProgressIndicator progressIndicator)
1274   {
1275     this.progressIndicator = progressIndicator;
1276   }
1277
1278   public long getProgressSessionId()
1279   {
1280     return progressSessionId;
1281   }
1282
1283   public void setProgressSessionId(long progressSessionId)
1284   {
1285     this.progressSessionId = progressSessionId;
1286   }
1287
1288   public void setProgressBar(String message)
1289   {
1290     progressIndicator.setProgressBar(message, progressSessionId);
1291   }
1292
1293   public List<AlignedCodonFrame> getSequenceMappings()
1294   {
1295     return seqmappings;
1296   }
1297
1298 }