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