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