src/jalview/structure/StructureSelectionManager.java

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