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         StructureMapping phyre2ModelMapping = new Phyre2Client(pdb)
 604                 .getStructureMapping(seq, pdbFile,
 605                         getPhyre2FastaFileFor(pdbFile), " ");
 606
 607         seqToStrucMapping.add(phyre2ModelMapping);
 608         ds.addPDBId(maxChain.sequence.getAllPDBEntries().get(0));
 609       }
 610       else
 611       {
 612         if (progress != null)
 613         {
 614           progress.setProgressBar(MessageManager
 615                                   .getString("status.obtaining_mapping_with_nw_alignment"),
 616                   progressSessionId);
 617         }
 618         StructureMapping nwMapping = getNWMappings(seq, pdbFile,
 619                 maxChainId, maxChain, pdb, maxAlignseq);
 620         seqToStrucMapping.add(nwMapping);
 621         ds.addPDBId(maxChain.sequence.getAllPDBEntries().get(0));
 622
 623       }
 624
 625       if (forStructureView)
 626       {
 627         mappings.addAll(seqToStrucMapping);
 628       }
 629     }
 630     return pdb;
 631   }
 632
 633   public void registerPhyre2Template(String phyre2Template,
 634           String fastaMappingFile)
 635   {
 636     phyre2ModelTemplates.put(phyre2Template, fastaMappingFile);
 637   }
 638
 639   /**
 640    * retrieve a mapping for seq from SIFTs using associated DBRefEntry for
 641    * uniprot or PDB
 642    *
 643    * @param seq
 644    * @param pdbFile
 645    * @param targetChainId
 646    * @param pdb
 647    * @param maxChain
 648    * @param sqmpping
 649    * @param maxAlignseq
 650    * @return
 651    * @throws SiftsException
 652    */
 653   private StructureMapping getStructureMapping(SequenceI seq,
 654           String pdbFile, String targetChainId, StructureFile pdb,
 655           PDBChain maxChain, jalview.datamodel.Mapping sqmpping,
 656           AlignSeq maxAlignseq) throws Exception
 657   {
 658     StructureMapping curChainMapping = siftsClient
 659             .getStructureMapping(seq, pdbFile, targetChainId);
 660     try
 661     {
 662       PDBChain chain = pdb.findChain(targetChainId);
 663       if (chain != null)
 664       {
 665         chain.transferResidueAnnotation(curChainMapping, sqmpping);
 666       }
 667     } catch (Exception e)
 668     {
 669       e.printStackTrace();
 670     }
 671     return curChainMapping;
 672   }
 673
 674   private StructureMapping getNWMappings(SequenceI seq, String pdbFile,
 675           String maxChainId, PDBChain maxChain, StructureFile pdb,
 676           AlignSeq maxAlignseq)
 677   {
 678     final StringBuilder mappingDetails = new StringBuilder(128);
 679     mappingDetails.append(NEWLINE).append(
 680             "Sequence \u27f7 Structure mapping details");
 681     mappingDetails.append(NEWLINE);
 682     mappingDetails
 683             .append("Method: inferred with Needleman & Wunsch alignment");
 684     mappingDetails.append(NEWLINE).append("PDB Sequence is :")
 685             .append(NEWLINE).append("Sequence = ")
 686             .append(maxChain.sequence.getSequenceAsString());
 687     mappingDetails.append(NEWLINE).append("No of residues = ")
 688             .append(maxChain.residues.size()).append(NEWLINE)
 689             .append(NEWLINE);
 690     PrintStream ps = new PrintStream(System.out)
 691     {
 692       @Override
 693       public void print(String x)
 694       {
 695         mappingDetails.append(x);
 696       }
 697
 698       @Override
 699       public void println()
 700       {
 701         mappingDetails.append(NEWLINE);
 702       }
 703     };
 704
 705     maxAlignseq.printAlignment(ps);
 706
 707     mappingDetails.append(NEWLINE).append("PDB start/end ");
 708     mappingDetails.append(String.valueOf(maxAlignseq.seq2start))
 709             .append(" ");
 710     mappingDetails.append(String.valueOf(maxAlignseq.seq2end));
 711     mappingDetails.append(NEWLINE).append("SEQ start/end ");
 712     mappingDetails.append(
 713             String.valueOf(maxAlignseq.seq1start + (seq.getStart() - 1)))
 714             .append(" ");
 715     mappingDetails.append(String.valueOf(maxAlignseq.seq1end
 716             + (seq.getStart() - 1)));
 717     mappingDetails.append(NEWLINE);
 718     maxChain.makeExactMapping(maxAlignseq, seq);
 719     jalview.datamodel.Mapping sqmpping = maxAlignseq
 720             .getMappingFromS1(false);
 721     maxChain.transferRESNUMFeatures(seq, null);
 722
 723     HashMap<Integer, int[]> mapping = new HashMap<Integer, int[]>();
 724     int resNum = -10000;
 725     int index = 0;
 726     char insCode = ' ';
 727
 728     do
 729     {
 730       Atom tmp = maxChain.atoms.elementAt(index);
 731       if ((resNum != tmp.resNumber || insCode != tmp.insCode)
 732               && tmp.alignmentMapping != -1)
 733       {
 734         resNum = tmp.resNumber;
 735         insCode = tmp.insCode;
 736         if (tmp.alignmentMapping >= -1)
 737         {
 738           mapping.put(tmp.alignmentMapping + 1, new int[] { tmp.resNumber,
 739               tmp.atomIndex });
 740         }
 741       }
 742
 743       index++;
 744     } while (index < maxChain.atoms.size());
 745
 746     StructureMapping nwMapping = new StructureMapping(seq, pdbFile,
 747             pdb.getId(), maxChainId, mapping, mappingDetails.toString());
 748     maxChain.transferResidueAnnotation(nwMapping, sqmpping);
 749     return nwMapping;
 750   }
 751
 752   public void removeStructureViewerListener(Object svl, String[] pdbfiles)
 753   {
 754     listeners.removeElement(svl);
 755     if (svl instanceof SequenceListener)
 756     {
 757       for (int i = 0; i < listeners.size(); i++)
 758       {
 759         if (listeners.elementAt(i) instanceof StructureListener)
 760         {
 761           ((StructureListener) listeners.elementAt(i))
 762                   .releaseReferences(svl);
 763         }
 764       }
 765     }
 766
 767     if (pdbfiles == null)
 768     {
 769       return;
 770     }
 771
 772     /*
 773      * Remove mappings to the closed listener's PDB files, but first check if
 774      * another listener is still interested
 775      */
 776     List<String> pdbs = new ArrayList<String>(Arrays.asList(pdbfiles));
 777
 778     StructureListener sl;
 779     for (int i = 0; i < listeners.size(); i++)
 780     {
 781       if (listeners.elementAt(i) instanceof StructureListener)
 782       {
 783         sl = (StructureListener) listeners.elementAt(i);
 784         for (String pdbfile : sl.getPdbFile())
 785         {
 786           pdbs.remove(pdbfile);
 787         }
 788       }
 789     }
 790
 791     /*
 792      * Rebuild the mappings set, retaining only those which are for 'other' PDB
 793      * files
 794      */
 795     if (pdbs.size() > 0)
 796     {
 797       List<StructureMapping> tmp = new ArrayList<StructureMapping>();
 798       for (StructureMapping sm : mappings)
 799       {
 800         if (!pdbs.contains(sm.pdbfile))
 801         {
 802           tmp.add(sm);
 803         }
 804       }
 805
 806       mappings = tmp;
 807     }
 808   }
 809
 810   /**
 811    * Propagate mouseover of a single position in a structure
 812    *
 813    * @param pdbResNum
 814    * @param chain
 815    * @param pdbfile
 816    */
 817   public void mouseOverStructure(int pdbResNum, String chain, String pdbfile)
 818   {
 819     AtomSpec atomSpec = new AtomSpec(pdbfile, chain, pdbResNum, 0);
 820     List<AtomSpec> atoms = Collections.singletonList(atomSpec);
 821     mouseOverStructure(atoms);
 822   }
 823
 824   /**
 825    * Propagate mouseover or selection of multiple positions in a structure
 826    *
 827    * @param atoms
 828    */
 829   public void mouseOverStructure(List<AtomSpec> atoms)
 830   {
 831     if (listeners == null)
 832     {
 833       // old or prematurely sent event
 834       return;
 835     }
 836     boolean hasSequenceListener = false;
 837     for (int i = 0; i < listeners.size(); i++)
 838     {
 839       if (listeners.elementAt(i) instanceof SequenceListener)
 840       {
 841         hasSequenceListener = true;
 842       }
 843     }
 844     if (!hasSequenceListener)
 845     {
 846       return;
 847     }
 848
 849     SearchResultsI results = new SearchResults();
 850     for (AtomSpec atom : atoms)
 851     {
 852       SequenceI lastseq = null;
 853       int lastipos = -1;
 854       for (StructureMapping sm : mappings)
 855       {
 856         if (sm.pdbfile.equals(atom.getPdbFile())
 857                 && sm.pdbchain.equals(atom.getChain()))
 858         {
 859           int indexpos = sm.getSeqPos(atom.getPdbResNum());
 860           if (lastipos != indexpos && lastseq != sm.sequence)
 861           {
 862             results.addResult(sm.sequence, indexpos, indexpos);
 863             lastipos = indexpos;
 864             lastseq = sm.sequence;
 865             // construct highlighted sequence list
 866             for (AlignedCodonFrame acf : seqmappings)
 867             {
 868               acf.markMappedRegion(sm.sequence, indexpos, results);
 869             }
 870           }
 871         }
 872       }
 873     }
 874     for (Object li : listeners)
 875     {
 876       if (li instanceof SequenceListener)
 877       {
 878         ((SequenceListener) li).highlightSequence(results);
 879       }
 880     }
 881   }
 882
 883   /**
 884    * highlight regions associated with a position (indexpos) in seq
 885    *
 886    * @param seq
 887    *          the sequence that the mouse over occurred on
 888    * @param indexpos
 889    *          the absolute position being mouseovered in seq (0 to seq.length())
 890    * @param seqPos
 891    *          the sequence position (if -1, seq.findPosition is called to
 892    *          resolve the residue number)
 893    */
 894   public void mouseOverSequence(SequenceI seq, int indexpos, int seqPos,
 895           VamsasSource source)
 896   {
 897     boolean hasSequenceListeners = handlingVamsasMo
 898             || !seqmappings.isEmpty();
 899     SearchResultsI results = null;
 900     if (seqPos == -1)
 901     {
 902       seqPos = seq.findPosition(indexpos);
 903     }
 904     for (int i = 0; i < listeners.size(); i++)
 905     {
 906       Object listener = listeners.elementAt(i);
 907       if (listener == source)
 908       {
 909         // TODO listener (e.g. SeqPanel) is never == source (AlignViewport)
 910         // Temporary fudge with SequenceListener.getVamsasSource()
 911         continue;
 912       }
 913       if (listener instanceof StructureListener)
 914       {
 915         highlightStructure((StructureListener) listener, seq, seqPos);
 916       }
 917       else
 918       {
 919         if (listener instanceof SequenceListener)
 920         {
 921           final SequenceListener seqListener = (SequenceListener) listener;
 922           if (hasSequenceListeners
 923                   && seqListener.getVamsasSource() != source)
 924           {
 925             if (relaySeqMappings)
 926             {
 927               if (results == null)
 928               {
 929                 results = MappingUtils.buildSearchResults(seq, seqPos,
 930                         seqmappings);
 931               }
 932               if (handlingVamsasMo)
 933               {
 934                 results.addResult(seq, seqPos, seqPos);
 935
 936               }
 937               if (!results.isEmpty())
 938               {
 939                 seqListener.highlightSequence(results);
 940               }
 941             }
 942           }
 943         }
 944         else if (listener instanceof VamsasListener && !handlingVamsasMo)
 945         {
 946           ((VamsasListener) listener).mouseOverSequence(seq, indexpos,
 947                   source);
 948         }
 949         else if (listener instanceof SecondaryStructureListener)
 950         {
 951           ((SecondaryStructureListener) listener).mouseOverSequence(seq,
 952                   indexpos, seqPos);
 953         }
 954       }
 955     }
 956   }
 957
 958   /**
 959    * Send suitable messages to a StructureListener to highlight atoms
 960    * corresponding to the given sequence position(s)
 961    *
 962    * @param sl
 963    * @param seq
 964    * @param positions
 965    */
 966   public void highlightStructure(StructureListener sl, SequenceI seq,
 967           int... positions)
 968   {
 969     if (!sl.isListeningFor(seq))
 970     {
 971       return;
 972     }
 973     int atomNo;
 974     List<AtomSpec> atoms = new ArrayList<AtomSpec>();
 975     for (StructureMapping sm : mappings)
 976     {
 977       if (sm.sequence == seq
 978               || sm.sequence == seq.getDatasetSequence()
 979               || (sm.sequence.getDatasetSequence() != null && sm.sequence
 980                       .getDatasetSequence() == seq.getDatasetSequence()))
 981       {
 982         for (int index : positions)
 983         {
 984           atomNo = sm.getAtomNum(index);
 985
 986           if (atomNo > 0)
 987           {
 988             atoms.add(new AtomSpec(sm.pdbfile, sm.pdbchain, sm
 989                     .getPDBResNum(index), atomNo));
 990           }
 991         }
 992       }
 993     }
 994     sl.highlightAtoms(atoms);
 995   }
 996
 997   /**
 998    * true if a mouse over event from an external (ie Vamsas) source is being
 999    * handled
1000    */
1001   boolean handlingVamsasMo = false;
1002
1003   long lastmsg = 0;
1004
1005   /**
1006    * as mouseOverSequence but only route event to SequenceListeners
1007    *
1008    * @param sequenceI
1009    * @param position
1010    *          in an alignment sequence
1011    */
1012   public void mouseOverVamsasSequence(SequenceI sequenceI, int position,
1013           VamsasSource source)
1014   {
1015     handlingVamsasMo = true;
1016     long msg = sequenceI.hashCode() * (1 + position);
1017     if (lastmsg != msg)
1018     {
1019       lastmsg = msg;
1020       mouseOverSequence(sequenceI, position, -1, source);
1021     }
1022     handlingVamsasMo = false;
1023   }
1024
1025   public Annotation[] colourSequenceFromStructure(SequenceI seq,
1026           String pdbid)
1027   {
1028     return null;
1029     // THIS WILL NOT BE AVAILABLE IN JALVIEW 2.3,
1030     // UNTIL THE COLOUR BY ANNOTATION IS REWORKED
1031     /*
1032      * Annotation [] annotations = new Annotation[seq.getLength()];
1033      *
1034      * StructureListener sl; int atomNo = 0; for (int i = 0; i <
1035      * listeners.size(); i++) { if (listeners.elementAt(i) instanceof
1036      * StructureListener) { sl = (StructureListener) listeners.elementAt(i);
1037      *
1038      * for (int j = 0; j < mappings.length; j++) {
1039      *
1040      * if (mappings[j].sequence == seq && mappings[j].getPdbId().equals(pdbid)
1041      * && mappings[j].pdbfile.equals(sl.getPdbFile())) {
1042      * System.out.println(pdbid+" "+mappings[j].getPdbId() +"
1043      * "+mappings[j].pdbfile);
1044      *
1045      * java.awt.Color col; for(int index=0; index<seq.getLength(); index++) {
1046      * if(jalview.util.Comparison.isGap(seq.getCharAt(index))) continue;
1047      *
1048      * atomNo = mappings[j].getAtomNum(seq.findPosition(index)); col =
1049      * java.awt.Color.white; if (atomNo > 0) { col = sl.getColour(atomNo,
1050      * mappings[j].getPDBResNum(index), mappings[j].pdbchain,
1051      * mappings[j].pdbfile); }
1052      *
1053      * annotations[index] = new Annotation("X",null,' ',0,col); } return
1054      * annotations; } } } }
1055      *
1056      * return annotations;
1057      */
1058   }
1059
1060   public void structureSelectionChanged()
1061   {
1062   }
1063
1064   public void sequenceSelectionChanged()
1065   {
1066   }
1067
1068   public void sequenceColoursChanged(Object source)
1069   {
1070     StructureListener sl;
1071     for (int i = 0; i < listeners.size(); i++)
1072     {
1073       if (listeners.elementAt(i) instanceof StructureListener)
1074       {
1075         sl = (StructureListener) listeners.elementAt(i);
1076         sl.updateColours(source);
1077       }
1078     }
1079   }
1080
1081   public StructureMapping[] getMapping(String pdbfile)
1082   {
1083     List<StructureMapping> tmp = new ArrayList<StructureMapping>();
1084     for (StructureMapping sm : mappings)
1085     {
1086       if (sm.pdbfile.equals(pdbfile))
1087       {
1088         tmp.add(sm);
1089       }
1090     }
1091     return tmp.toArray(new StructureMapping[tmp.size()]);
1092   }
1093
1094   /**
1095    * Returns a readable description of all mappings for the given pdbfile to any
1096    * of the given sequences
1097    *
1098    * @param pdbfile
1099    * @param seqs
1100    * @return
1101    */
1102   public String printMappings(String pdbfile, List<SequenceI> seqs)
1103   {
1104     if (pdbfile == null || seqs == null || seqs.isEmpty())
1105     {
1106       return "";
1107     }
1108
1109     StringBuilder sb = new StringBuilder(64);
1110     for (StructureMapping sm : mappings)
1111     {
1112       if (sm.pdbfile.equals(pdbfile) && seqs.contains(sm.sequence))
1113       {
1114         sb.append(sm.mappingDetails);
1115         sb.append(NEWLINE);
1116         // separator makes it easier to read multiple mappings
1117         sb.append("=====================");
1118         sb.append(NEWLINE);
1119       }
1120     }
1121     sb.append(NEWLINE);
1122
1123     return sb.toString();
1124   }
1125
1126   /**
1127    * Remove the given mapping
1128    *
1129    * @param acf
1130    */
1131   public void deregisterMapping(AlignedCodonFrame acf)
1132   {
1133     if (acf != null)
1134     {
1135       boolean removed = seqmappings.remove(acf);
1136       if (removed && seqmappings.isEmpty())
1137       { // debug
1138         System.out.println("All mappings removed");
1139       }
1140     }
1141   }
1142
1143   /**
1144    * Add each of the given codonFrames to the stored set, if not aready present.
1145    *
1146    * @param mappings
1147    */
1148   public void registerMappings(List<AlignedCodonFrame> mappings)
1149   {
1150     if (mappings != null)
1151     {
1152       for (AlignedCodonFrame acf : mappings)
1153       {
1154         registerMapping(acf);
1155       }
1156     }
1157   }
1158
1159   /**
1160    * Add the given mapping to the stored set, unless already stored.
1161    */
1162   public void registerMapping(AlignedCodonFrame acf)
1163   {
1164     if (acf != null)
1165     {
1166       if (!seqmappings.contains(acf))
1167       {
1168         seqmappings.add(acf);
1169       }
1170     }
1171   }
1172
1173   /**
1174    * Resets this object to its initial state by removing all registered
1175    * listeners, codon mappings, PDB file mappings
1176    */
1177   public void resetAll()
1178   {
1179     if (mappings != null)
1180     {
1181       mappings.clear();
1182     }
1183     if (seqmappings != null)
1184     {
1185       seqmappings.clear();
1186     }
1187     if (sel_listeners != null)
1188     {
1189       sel_listeners.clear();
1190     }
1191     if (listeners != null)
1192     {
1193       listeners.clear();
1194     }
1195     if (commandListeners != null)
1196     {
1197       commandListeners.clear();
1198     }
1199     if (view_listeners != null)
1200     {
1201       view_listeners.clear();
1202     }
1203     if (pdbFileNameId != null)
1204     {
1205       pdbFileNameId.clear();
1206     }
1207     if (pdbIdFileName != null)
1208     {
1209       pdbIdFileName.clear();
1210     }
1211   }
1212
1213   public void addSelectionListener(SelectionListener selecter)
1214   {
1215     if (!sel_listeners.contains(selecter))
1216     {
1217       sel_listeners.add(selecter);
1218     }
1219   }
1220
1221   public void removeSelectionListener(SelectionListener toremove)
1222   {
1223     if (sel_listeners.contains(toremove))
1224     {
1225       sel_listeners.remove(toremove);
1226     }
1227   }
1228
1229   public synchronized void sendSelection(
1230           jalview.datamodel.SequenceGroup selection,
1231           jalview.datamodel.ColumnSelection colsel, SelectionSource source)
1232   {
1233     for (SelectionListener slis : sel_listeners)
1234     {
1235       if (slis != source)
1236       {
1237         slis.selection(selection, colsel, source);
1238       }
1239     }
1240   }
1241
1242   Vector<AlignmentViewPanelListener> view_listeners = new Vector<AlignmentViewPanelListener>();
1243
1244   public synchronized void sendViewPosition(
1245           jalview.api.AlignmentViewPanel source, int startRes, int endRes,
1246           int startSeq, int endSeq)
1247   {
1248
1249     if (view_listeners != null && view_listeners.size() > 0)
1250     {
1251       Enumeration<AlignmentViewPanelListener> listeners = view_listeners
1252               .elements();
1253       while (listeners.hasMoreElements())
1254       {
1255         AlignmentViewPanelListener slis = listeners.nextElement();
1256         if (slis != source)
1257         {
1258           slis.viewPosition(startRes, endRes, startSeq, endSeq, source);
1259         }
1260         ;
1261       }
1262     }
1263   }
1264
1265   /**
1266    * release all references associated with this manager provider
1267    *
1268    * @param jalviewLite
1269    */
1270   public static void release(StructureSelectionManagerProvider jalviewLite)
1271   {
1272     // synchronized (instances)
1273     {
1274       if (instances == null)
1275       {
1276         return;
1277       }
1278       StructureSelectionManager mnger = (instances.get(jalviewLite));
1279       if (mnger != null)
1280       {
1281         instances.remove(jalviewLite);
1282         try
1283         {
1284           mnger.finalize();
1285         } catch (Throwable x)
1286         {
1287         }
1288       }
1289     }
1290   }
1291
1292   public void registerPDBEntry(PDBEntry pdbentry)
1293   {
1294     if (pdbentry.getFile() != null
1295             && pdbentry.getFile().trim().length() > 0)
1296     {
1297       registerPDBFile(pdbentry.getId(), pdbentry.getFile());
1298     }
1299   }
1300
1301   public void addCommandListener(CommandListener cl)
1302   {
1303     if (!commandListeners.contains(cl))
1304     {
1305       commandListeners.add(cl);
1306     }
1307   }
1308
1309   public boolean hasCommandListener(CommandListener cl)
1310   {
1311     return this.commandListeners.contains(cl);
1312   }
1313
1314   public boolean removeCommandListener(CommandListener l)
1315   {
1316     return commandListeners.remove(l);
1317   }
1318
1319   /**
1320    * Forward a command to any command listeners (except for the command's
1321    * source).
1322    *
1323    * @param command
1324    *          the command to be broadcast (in its form after being performed)
1325    * @param undo
1326    *          if true, the command was being 'undone'
1327    * @param source
1328    */
1329   public void commandPerformed(CommandI command, boolean undo,
1330           VamsasSource source)
1331   {
1332     for (CommandListener listener : commandListeners)
1333     {
1334       listener.mirrorCommand(command, undo, this, source);
1335     }
1336   }
1337
1338   /**
1339    * Returns a new CommandI representing the given command as mapped to the
1340    * given sequences. If no mapping could be made, or the command is not of a
1341    * mappable kind, returns null.
1342    *
1343    * @param command
1344    * @param undo
1345    * @param mapTo
1346    * @param gapChar
1347    * @return
1348    */
1349   public CommandI mapCommand(CommandI command, boolean undo,
1350           final AlignmentI mapTo, char gapChar)
1351   {
1352     if (command instanceof EditCommand)
1353     {
1354       return MappingUtils.mapEditCommand((EditCommand) command, undo,
1355               mapTo, gapChar, seqmappings);
1356     }
1357     else if (command instanceof OrderCommand)
1358     {
1359       return MappingUtils.mapOrderCommand((OrderCommand) command, undo,
1360               mapTo, seqmappings);
1361     }
1362     return null;
1363   }
1364
1365   public IProgressIndicator getProgressIndicator()
1366   {
1367     return progressIndicator;
1368   }
1369
1370   public void setProgressIndicator(IProgressIndicator progressIndicator)
1371   {
1372     this.progressIndicator = progressIndicator;
1373   }
1374
1375   public long getProgressSessionId()
1376   {
1377     return progressSessionId;
1378   }
1379
1380   public void setProgressSessionId(long progressSessionId)
1381   {
1382     this.progressSessionId = progressSessionId;
1383   }
1384
1385   public void setProgressBar(String message)
1386   {
1387     if (progressIndicator == null)
1388     {
1389       return;
1390     }
1391     progressIndicator.setProgressBar(message, progressSessionId);
1392   }
1393
1394   public List<AlignedCodonFrame> getSequenceMappings()
1395   {
1396     return seqmappings;
1397   }
1398
1399   public boolean isPhyre2Template(String structureFile)
1400   {
1401     if (structureFile == null || phyre2ModelTemplates == null
1402             || phyre2ModelTemplates.isEmpty())
1403     {
1404       return false;
1405     }
1406     return phyre2ModelTemplates.get(structureFile) != null
1407             && !phyre2ModelTemplates.get(structureFile).isEmpty();
1408   }
1409
1410   public String getPhyre2FastaFileFor(String structureFile)
1411   {
1412     return phyre2ModelTemplates.get(structureFile);
1413   }
1414
1415
1416   public static StructureSelectionManager getStructureSelectionManager()
1417   {
1418     return instances.values().iterator().next();
1419   }
1420
1421 }