src/jalview/structure/StructureSelectionManager.java

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