src/jalview/gui/Jalview2XML.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.gui;
  22
  23 import jalview.analysis.Conservation;
  24 import jalview.api.FeatureColourI;
  25 import jalview.api.ViewStyleI;
  26 import jalview.api.structures.JalviewStructureDisplayI;
  27 import jalview.bin.Cache;
  28 import jalview.datamodel.AlignedCodonFrame;
  29 import jalview.datamodel.Alignment;
  30 import jalview.datamodel.AlignmentAnnotation;
  31 import jalview.datamodel.AlignmentI;
  32 import jalview.datamodel.GraphLine;
  33 import jalview.datamodel.PDBEntry;
  34 import jalview.datamodel.RnaViewerModel;
  35 import jalview.datamodel.SequenceGroup;
  36 import jalview.datamodel.SequenceI;
  37 import jalview.datamodel.StructureViewerModel;
  38 import jalview.datamodel.StructureViewerModel.StructureData;
  39 import jalview.ext.varna.RnaModel;
  40 import jalview.gui.StructureViewer.ViewerType;
  41 import jalview.io.DataSourceType;
  42 import jalview.io.FileFormat;
  43 import jalview.renderer.ResidueShaderI;
  44 import jalview.schemabinding.version2.AlcodMap;
  45 import jalview.schemabinding.version2.AlcodonFrame;
  46 import jalview.schemabinding.version2.Annotation;
  47 import jalview.schemabinding.version2.AnnotationColours;
  48 import jalview.schemabinding.version2.AnnotationElement;
  49 import jalview.schemabinding.version2.CalcIdParam;
  50 import jalview.schemabinding.version2.DBRef;
  51 import jalview.schemabinding.version2.Features;
  52 import jalview.schemabinding.version2.Group;
  53 import jalview.schemabinding.version2.HiddenColumns;
  54 import jalview.schemabinding.version2.JGroup;
  55 import jalview.schemabinding.version2.JSeq;
  56 import jalview.schemabinding.version2.JalviewModel;
  57 import jalview.schemabinding.version2.JalviewModelSequence;
  58 import jalview.schemabinding.version2.MapListFrom;
  59 import jalview.schemabinding.version2.MapListTo;
  60 import jalview.schemabinding.version2.Mapping;
  61 import jalview.schemabinding.version2.MappingChoice;
  62 import jalview.schemabinding.version2.OtherData;
  63 import jalview.schemabinding.version2.PdbentryItem;
  64 import jalview.schemabinding.version2.Pdbids;
  65 import jalview.schemabinding.version2.Property;
  66 import jalview.schemabinding.version2.RnaViewer;
  67 import jalview.schemabinding.version2.SecondaryStructure;
  68 import jalview.schemabinding.version2.Sequence;
  69 import jalview.schemabinding.version2.SequenceSet;
  70 import jalview.schemabinding.version2.SequenceSetProperties;
  71 import jalview.schemabinding.version2.Setting;
  72 import jalview.schemabinding.version2.StructureState;
  73 import jalview.schemabinding.version2.ThresholdLine;
  74 import jalview.schemabinding.version2.Tree;
  75 import jalview.schemabinding.version2.UserColours;
  76 import jalview.schemabinding.version2.Viewport;
  77 import jalview.schemes.AnnotationColourGradient;
  78 import jalview.schemes.ColourSchemeI;
  79 import jalview.schemes.ColourSchemeProperty;
  80 import jalview.schemes.FeatureColour;
  81 import jalview.schemes.ResidueProperties;
  82 import jalview.schemes.UserColourScheme;
  83 import jalview.structure.StructureSelectionManager;
  84 import jalview.structures.models.AAStructureBindingModel;
  85 import jalview.util.MessageManager;
  86 import jalview.util.Platform;
  87 import jalview.util.StringUtils;
  88 import jalview.util.jarInputStreamProvider;
  89 import jalview.viewmodel.AlignmentViewport;
  90 import jalview.viewmodel.ViewportRanges;
  91 import jalview.viewmodel.seqfeatures.FeatureRendererSettings;
  92 import jalview.viewmodel.seqfeatures.FeaturesDisplayed;
  93 import jalview.ws.jws2.Jws2Discoverer;
  94 import jalview.ws.jws2.dm.AAConSettings;
  95 import jalview.ws.jws2.jabaws2.Jws2Instance;
  96 import jalview.ws.params.ArgumentI;
  97 import jalview.ws.params.AutoCalcSetting;
  98 import jalview.ws.params.WsParamSetI;
  99
 100 import java.awt.Color;
 101 import java.awt.Rectangle;
 102 import java.io.BufferedReader;
 103 import java.io.DataInputStream;
 104 import java.io.DataOutputStream;
 105 import java.io.File;
 106 import java.io.FileInputStream;
 107 import java.io.FileOutputStream;
 108 import java.io.IOException;
 109 import java.io.InputStreamReader;
 110 import java.io.OutputStreamWriter;
 111 import java.io.PrintWriter;
 112 import java.lang.reflect.InvocationTargetException;
 113 import java.net.MalformedURLException;
 114 import java.net.URL;
 115 import java.util.ArrayList;
 116 import java.util.Arrays;
 117 import java.util.Enumeration;
 118 import java.util.HashMap;
 119 import java.util.HashSet;
 120 import java.util.Hashtable;
 121 import java.util.IdentityHashMap;
 122 import java.util.Iterator;
 123 import java.util.LinkedHashMap;
 124 import java.util.List;
 125 import java.util.Map;
 126 import java.util.Map.Entry;
 127 import java.util.Set;
 128 import java.util.Vector;
 129 import java.util.jar.JarEntry;
 130 import java.util.jar.JarInputStream;
 131 import java.util.jar.JarOutputStream;
 132
 133 import javax.swing.JInternalFrame;
 134 import javax.swing.SwingUtilities;
 135
 136 import org.exolab.castor.xml.Marshaller;
 137 import org.exolab.castor.xml.Unmarshaller;
 138
 139 /**
 140  * Write out the current jalview desktop state as a Jalview XML stream.
 141  *
 142  * Note: the vamsas objects referred to here are primitive versions of the
 143  * VAMSAS project schema elements - they are not the same and most likely never
 144  * will be :)
 145  *
 146  * @author $author$
 147  * @version $Revision: 1.134 $
 148  */
 149 public class Jalview2XML
 150 {
 151   private static final String VIEWER_PREFIX = "viewer_";
 152
 153   private static final String RNA_PREFIX = "rna_";
 154
 155   private static final String UTF_8 = "UTF-8";
 156
 157   // use this with nextCounter() to make unique names for entities
 158   private int counter = 0;
 159
 160   /*
 161    * SequenceI reference -> XML ID string in jalview XML. Populated as XML reps
 162    * of sequence objects are created.
 163    */
 164   IdentityHashMap<SequenceI, String> seqsToIds = null;
 165
 166   /**
 167    * jalview XML Sequence ID to jalview sequence object reference (both dataset
 168    * and alignment sequences. Populated as XML reps of sequence objects are
 169    * created.)
 170    */
 171   Map<String, SequenceI> seqRefIds = null;
 172
 173   Map<String, SequenceI> incompleteSeqs = null;
 174
 175   List<SeqFref> frefedSequence = null;
 176
 177   boolean raiseGUI = true; // whether errors are raised in dialog boxes or not
 178
 179   /*
 180    * Map of reconstructed AlignFrame objects that appear to have come from
 181    * SplitFrame objects (have a dna/protein complement view).
 182    */
 183   private Map<Viewport, AlignFrame> splitFrameCandidates = new HashMap<Viewport, AlignFrame>();
 184
 185   /*
 186    * Map from displayed rna structure models to their saved session state jar
 187    * entry names
 188    */
 189   private Map<RnaModel, String> rnaSessions = new HashMap<RnaModel, String>();
 190
 191   /**
 192    * create/return unique hash string for sq
 193    *
 194    * @param sq
 195    * @return new or existing unique string for sq
 196    */
 197   String seqHash(SequenceI sq)
 198   {
 199     if (seqsToIds == null)
 200     {
 201       initSeqRefs();
 202     }
 203     if (seqsToIds.containsKey(sq))
 204     {
 205       return seqsToIds.get(sq);
 206     }
 207     else
 208     {
 209       // create sequential key
 210       String key = "sq" + (seqsToIds.size() + 1);
 211       key = makeHashCode(sq, key); // check we don't have an external reference
 212       // for it already.
 213       seqsToIds.put(sq, key);
 214       return key;
 215     }
 216   }
 217
 218   void clearSeqRefs()
 219   {
 220     if (_cleartables)
 221     {
 222       if (seqRefIds != null)
 223       {
 224         seqRefIds.clear();
 225       }
 226       if (seqsToIds != null)
 227       {
 228         seqsToIds.clear();
 229       }
 230       if (incompleteSeqs != null)
 231       {
 232         incompleteSeqs.clear();
 233       }
 234       // seqRefIds = null;
 235       // seqsToIds = null;
 236     }
 237     else
 238     {
 239       // do nothing
 240       warn("clearSeqRefs called when _cleartables was not set. Doing nothing.");
 241       // seqRefIds = new Hashtable();
 242       // seqsToIds = new IdentityHashMap();
 243     }
 244   }
 245
 246   void initSeqRefs()
 247   {
 248     if (seqsToIds == null)
 249     {
 250       seqsToIds = new IdentityHashMap<SequenceI, String>();
 251     }
 252     if (seqRefIds == null)
 253     {
 254       seqRefIds = new HashMap<String, SequenceI>();
 255     }
 256     if (incompleteSeqs == null)
 257     {
 258       incompleteSeqs = new HashMap<String, SequenceI>();
 259     }
 260     if (frefedSequence == null)
 261     {
 262       frefedSequence = new ArrayList<SeqFref>();
 263     }
 264   }
 265
 266   public Jalview2XML()
 267   {
 268   }
 269
 270   public Jalview2XML(boolean raiseGUI)
 271   {
 272     this.raiseGUI = raiseGUI;
 273   }
 274
 275   /**
 276    * base class for resolving forward references to sequences by their ID
 277    *
 278    * @author jprocter
 279    *
 280    */
 281   abstract class SeqFref
 282   {
 283     String sref;
 284
 285     String type;
 286
 287     public SeqFref(String _sref, String type)
 288     {
 289       sref = _sref;
 290       this.type = type;
 291     }
 292
 293     public String getSref()
 294     {
 295       return sref;
 296     }
 297
 298     public SequenceI getSrefSeq()
 299     {
 300       return seqRefIds.get(sref);
 301     }
 302
 303     public boolean isResolvable()
 304     {
 305       return seqRefIds.get(sref) != null;
 306     }
 307
 308     public SequenceI getSrefDatasetSeq()
 309     {
 310       SequenceI sq = seqRefIds.get(sref);
 311       if (sq != null)
 312       {
 313         while (sq.getDatasetSequence() != null)
 314         {
 315           sq = sq.getDatasetSequence();
 316         }
 317       }
 318       return sq;
 319     }
 320
 321     /**
 322      * @return true if the forward reference was fully resolved
 323      */
 324     abstract boolean resolve();
 325
 326     @Override
 327     public String toString()
 328     {
 329       return type + " reference to " + sref;
 330     }
 331   }
 332
 333   /**
 334    * create forward reference for a mapping
 335    *
 336    * @param sref
 337    * @param _jmap
 338    * @return
 339    */
 340   public SeqFref newMappingRef(final String sref,
 341           final jalview.datamodel.Mapping _jmap)
 342   {
 343     SeqFref fref = new SeqFref(sref, "Mapping")
 344     {
 345       public jalview.datamodel.Mapping jmap = _jmap;
 346
 347       @Override
 348       boolean resolve()
 349       {
 350         SequenceI seq = getSrefDatasetSeq();
 351         if (seq == null)
 352         {
 353           return false;
 354         }
 355         jmap.setTo(seq);
 356         return true;
 357       }
 358     };
 359     return fref;
 360   }
 361
 362   public SeqFref newAlcodMapRef(final String sref,
 363           final AlignedCodonFrame _cf, final jalview.datamodel.Mapping _jmap)
 364   {
 365
 366     SeqFref fref = new SeqFref(sref, "Codon Frame")
 367     {
 368       AlignedCodonFrame cf = _cf;
 369
 370       public jalview.datamodel.Mapping mp = _jmap;
 371
 372       @Override
 373       public boolean isResolvable()
 374       {
 375         return super.isResolvable() && mp.getTo() != null;
 376       };
 377
 378       @Override
 379       boolean resolve()
 380       {
 381         SequenceI seq = getSrefDatasetSeq();
 382         if (seq == null)
 383         {
 384           return false;
 385         }
 386         cf.addMap(seq, mp.getTo(), mp.getMap());
 387         return true;
 388       }
 389     };
 390     return fref;
 391   }
 392
 393   public void resolveFrefedSequences()
 394   {
 395     Iterator<SeqFref> nextFref = frefedSequence.iterator();
 396     int toresolve = frefedSequence.size();
 397     int unresolved = 0, failedtoresolve = 0;
 398     while (nextFref.hasNext())
 399     {
 400       SeqFref ref = nextFref.next();
 401       if (ref.isResolvable())
 402       {
 403         try
 404         {
 405           if (ref.resolve())
 406           {
 407             nextFref.remove();
 408           }
 409           else
 410           {
 411             failedtoresolve++;
 412           }
 413         } catch (Exception x)
 414         {
 415           System.err
 416                   .println("IMPLEMENTATION ERROR: Failed to resolve forward reference for sequence "
 417                           + ref.getSref());
 418           x.printStackTrace();
 419           failedtoresolve++;
 420         }
 421       }
 422       else
 423       {
 424         unresolved++;
 425       }
 426     }
 427     if (unresolved > 0)
 428     {
 429       System.err.println("Jalview Project Import: There were " + unresolved
 430               + " forward references left unresolved on the stack.");
 431     }
 432     if (failedtoresolve > 0)
 433     {
 434       System.err.println("SERIOUS! " + failedtoresolve
 435               + " resolvable forward references failed to resolve.");
 436     }
 437     if (incompleteSeqs != null && incompleteSeqs.size() > 0)
 438     {
 439       System.err.println("Jalview Project Import: There are "
 440               + incompleteSeqs.size()
 441               + " sequences which may have incomplete metadata.");
 442       if (incompleteSeqs.size() < 10)
 443       {
 444         for (SequenceI s : incompleteSeqs.values())
 445         {
 446           System.err.println(s.toString());
 447         }
 448       }
 449       else
 450       {
 451         System.err
 452                 .println("Too many to report. Skipping output of incomplete sequences.");
 453       }
 454     }
 455   }
 456
 457   /**
 458    * This maintains a map of viewports, the key being the seqSetId. Important to
 459    * set historyItem and redoList for multiple views
 460    */
 461   Map<String, AlignViewport> viewportsAdded = new HashMap<String, AlignViewport>();
 462
 463   Map<String, AlignmentAnnotation> annotationIds = new HashMap<String, AlignmentAnnotation>();
 464
 465   String uniqueSetSuffix = "";
 466
 467   /**
 468    * List of pdbfiles added to Jar
 469    */
 470   List<String> pdbfiles = null;
 471
 472   // SAVES SEVERAL ALIGNMENT WINDOWS TO SAME JARFILE
 473   public void saveState(File statefile)
 474   {
 475     FileOutputStream fos = null;
 476     try
 477     {
 478       fos = new FileOutputStream(statefile);
 479       JarOutputStream jout = new JarOutputStream(fos);
 480       saveState(jout);
 481
 482     } catch (Exception e)
 483     {
 484       // TODO: inform user of the problem - they need to know if their data was
 485       // not saved !
 486       if (errorMessage == null)
 487       {
 488         errorMessage = "Couldn't write Jalview Archive to output file '"
 489                 + statefile + "' - See console error log for details";
 490       }
 491       else
 492       {
 493         errorMessage += "(output file was '" + statefile + "')";
 494       }
 495       e.printStackTrace();
 496     } finally
 497     {
 498       if (fos != null)
 499       {
 500         try
 501         {
 502           fos.close();
 503         } catch (IOException e)
 504         {
 505           // ignore
 506         }
 507       }
 508     }
 509     reportErrors();
 510   }
 511
 512   /**
 513    * Writes a jalview project archive to the given Jar output stream.
 514    *
 515    * @param jout
 516    */
 517   public void saveState(JarOutputStream jout)
 518   {
 519     AlignFrame[] frames = Desktop.getAlignFrames();
 520
 521     if (frames == null)
 522     {
 523       return;
 524     }
 525     saveAllFrames(Arrays.asList(frames), jout);
 526   }
 527
 528   /**
 529    * core method for storing state for a set of AlignFrames.
 530    *
 531    * @param frames
 532    *          - frames involving all data to be exported (including containing
 533    *          splitframes)
 534    * @param jout
 535    *          - project output stream
 536    */
 537   private void saveAllFrames(List<AlignFrame> frames, JarOutputStream jout)
 538   {
 539     Hashtable<String, AlignFrame> dsses = new Hashtable<String, AlignFrame>();
 540
 541     /*
 542      * ensure cached data is clear before starting
 543      */
 544     // todo tidy up seqRefIds, seqsToIds initialisation / reset
 545     rnaSessions.clear();
 546     splitFrameCandidates.clear();
 547
 548     try
 549     {
 550
 551       // NOTE UTF-8 MUST BE USED FOR WRITING UNICODE CHARS
 552       // //////////////////////////////////////////////////
 553
 554       List<String> shortNames = new ArrayList<String>();
 555       List<String> viewIds = new ArrayList<String>();
 556
 557       // REVERSE ORDER
 558       for (int i = frames.size() - 1; i > -1; i--)
 559       {
 560         AlignFrame af = frames.get(i);
 561         // skip ?
 562         if (skipList != null
 563                 && skipList
 564                         .containsKey(af.getViewport().getSequenceSetId()))
 565         {
 566           continue;
 567         }
 568
 569         String shortName = makeFilename(af, shortNames);
 570
 571         int ap, apSize = af.alignPanels.size();
 572
 573         for (ap = 0; ap < apSize; ap++)
 574         {
 575           AlignmentPanel apanel = af.alignPanels.get(ap);
 576           String fileName = apSize == 1 ? shortName : ap + shortName;
 577           if (!fileName.endsWith(".xml"))
 578           {
 579             fileName = fileName + ".xml";
 580           }
 581
 582           saveState(apanel, fileName, jout, viewIds);
 583
 584           String dssid = getDatasetIdRef(af.getViewport().getAlignment()
 585                   .getDataset());
 586           if (!dsses.containsKey(dssid))
 587           {
 588             dsses.put(dssid, af);
 589           }
 590         }
 591       }
 592
 593       writeDatasetFor(dsses, "" + jout.hashCode() + " " + uniqueSetSuffix,
 594               jout);
 595
 596       try
 597       {
 598         jout.flush();
 599       } catch (Exception foo)
 600       {
 601       }
 602       ;
 603       jout.close();
 604     } catch (Exception ex)
 605     {
 606       // TODO: inform user of the problem - they need to know if their data was
 607       // not saved !
 608       if (errorMessage == null)
 609       {
 610         errorMessage = "Couldn't write Jalview Archive - see error output for details";
 611       }
 612       ex.printStackTrace();
 613     }
 614   }
 615
 616   /**
 617    * Generates a distinct file name, based on the title of the AlignFrame, by
 618    * appending _n for increasing n until an unused name is generated. The new
 619    * name (without its extension) is added to the list.
 620    *
 621    * @param af
 622    * @param namesUsed
 623    * @return the generated name, with .xml extension
 624    */
 625   protected String makeFilename(AlignFrame af, List<String> namesUsed)
 626   {
 627     String shortName = af.getTitle();
 628
 629     if (shortName.indexOf(File.separatorChar) > -1)
 630     {
 631       shortName = shortName.substring(shortName
 632               .lastIndexOf(File.separatorChar) + 1);
 633     }
 634
 635     int count = 1;
 636
 637     while (namesUsed.contains(shortName))
 638     {
 639       if (shortName.endsWith("_" + (count - 1)))
 640       {
 641         shortName = shortName.substring(0, shortName.lastIndexOf("_"));
 642       }
 643
 644       shortName = shortName.concat("_" + count);
 645       count++;
 646     }
 647
 648     namesUsed.add(shortName);
 649
 650     if (!shortName.endsWith(".xml"))
 651     {
 652       shortName = shortName + ".xml";
 653     }
 654     return shortName;
 655   }
 656
 657   // USE THIS METHOD TO SAVE A SINGLE ALIGNMENT WINDOW
 658   public boolean saveAlignment(AlignFrame af, String jarFile,
 659           String fileName)
 660   {
 661     try
 662     {
 663       FileOutputStream fos = new FileOutputStream(jarFile);
 664       JarOutputStream jout = new JarOutputStream(fos);
 665       List<AlignFrame> frames = new ArrayList<AlignFrame>();
 666
 667       // resolve splitframes
 668       if (af.getViewport().getCodingComplement() != null)
 669       {
 670         frames = ((SplitFrame) af.getSplitViewContainer()).getAlignFrames();
 671       }
 672       else
 673       {
 674         frames.add(af);
 675       }
 676       saveAllFrames(frames, jout);
 677       try
 678       {
 679         jout.flush();
 680       } catch (Exception foo)
 681       {
 682       }
 683       ;
 684       jout.close();
 685       return true;
 686     } catch (Exception ex)
 687     {
 688       errorMessage = "Couldn't Write alignment view to Jalview Archive - see error output for details";
 689       ex.printStackTrace();
 690       return false;
 691     }
 692   }
 693
 694   private void writeDatasetFor(Hashtable<String, AlignFrame> dsses,
 695           String fileName, JarOutputStream jout)
 696   {
 697
 698     for (String dssids : dsses.keySet())
 699     {
 700       AlignFrame _af = dsses.get(dssids);
 701       String jfileName = fileName + " Dataset for " + _af.getTitle();
 702       if (!jfileName.endsWith(".xml"))
 703       {
 704         jfileName = jfileName + ".xml";
 705       }
 706       saveState(_af.alignPanel, jfileName, true, jout, null);
 707     }
 708   }
 709
 710   /**
 711    * create a JalviewModel from an alignment view and marshall it to a
 712    * JarOutputStream
 713    *
 714    * @param ap
 715    *          panel to create jalview model for
 716    * @param fileName
 717    *          name of alignment panel written to output stream
 718    * @param jout
 719    *          jar output stream
 720    * @param viewIds
 721    * @param out
 722    *          jar entry name
 723    */
 724   public JalviewModel saveState(AlignmentPanel ap, String fileName,
 725           JarOutputStream jout, List<String> viewIds)
 726   {
 727     return saveState(ap, fileName, false, jout, viewIds);
 728   }
 729
 730   /**
 731    * create a JalviewModel from an alignment view and marshall it to a
 732    * JarOutputStream
 733    *
 734    * @param ap
 735    *          panel to create jalview model for
 736    * @param fileName
 737    *          name of alignment panel written to output stream
 738    * @param storeDS
 739    *          when true, only write the dataset for the alignment, not the data
 740    *          associated with the view.
 741    * @param jout
 742    *          jar output stream
 743    * @param out
 744    *          jar entry name
 745    */
 746   public JalviewModel saveState(AlignmentPanel ap, String fileName,
 747           boolean storeDS, JarOutputStream jout, List<String> viewIds)
 748   {
 749     if (viewIds == null)
 750     {
 751       viewIds = new ArrayList<String>();
 752     }
 753
 754     initSeqRefs();
 755
 756     List<UserColourScheme> userColours = new ArrayList<UserColourScheme>();
 757
 758     AlignViewport av = ap.av;
 759     ViewportRanges vpRanges = av.getRanges();
 760
 761     JalviewModel object = new JalviewModel();
 762     object.setVamsasModel(new jalview.schemabinding.version2.VamsasModel());
 763
 764     object.setCreationDate(new java.util.Date(System.currentTimeMillis()));
 765     object.setVersion(jalview.bin.Cache.getDefault("VERSION",
 766             "Development Build"));
 767
 768     /**
 769      * rjal is full height alignment, jal is actual alignment with full metadata
 770      * but excludes hidden sequences.
 771      */
 772     jalview.datamodel.AlignmentI rjal = av.getAlignment(), jal = rjal;
 773
 774     if (av.hasHiddenRows())
 775     {
 776       rjal = jal.getHiddenSequences().getFullAlignment();
 777     }
 778
 779     SequenceSet vamsasSet = new SequenceSet();
 780     Sequence vamsasSeq;
 781     JalviewModelSequence jms = new JalviewModelSequence();
 782
 783     vamsasSet.setGapChar(jal.getGapCharacter() + "");
 784
 785     if (jal.getDataset() != null)
 786     {
 787       // dataset id is the dataset's hashcode
 788       vamsasSet.setDatasetId(getDatasetIdRef(jal.getDataset()));
 789       if (storeDS)
 790       {
 791         // switch jal and the dataset
 792         jal = jal.getDataset();
 793         rjal = jal;
 794       }
 795     }
 796     if (jal.getProperties() != null)
 797     {
 798       Enumeration en = jal.getProperties().keys();
 799       while (en.hasMoreElements())
 800       {
 801         String key = en.nextElement().toString();
 802         SequenceSetProperties ssp = new SequenceSetProperties();
 803         ssp.setKey(key);
 804         ssp.setValue(jal.getProperties().get(key).toString());
 805         vamsasSet.addSequenceSetProperties(ssp);
 806       }
 807     }
 808
 809     JSeq jseq;
 810     Set<String> calcIdSet = new HashSet<String>();
 811     // record the set of vamsas sequence XML POJO we create.
 812     HashMap<String, Sequence> vamsasSetIds = new HashMap<String, Sequence>();
 813     // SAVE SEQUENCES
 814     for (final SequenceI jds : rjal.getSequences())
 815     {
 816       final SequenceI jdatasq = jds.getDatasetSequence() == null ? jds
 817               : jds.getDatasetSequence();
 818       String id = seqHash(jds);
 819       if (vamsasSetIds.get(id) == null)
 820       {
 821         if (seqRefIds.get(id) != null && !storeDS)
 822         {
 823           // This happens for two reasons: 1. multiple views are being
 824           // serialised.
 825           // 2. the hashCode has collided with another sequence's code. This
 826           // DOES
 827           // HAPPEN! (PF00072.15.stk does this)
 828           // JBPNote: Uncomment to debug writing out of files that do not read
 829           // back in due to ArrayOutOfBoundExceptions.
 830           // System.err.println("vamsasSeq backref: "+id+"");
 831           // System.err.println(jds.getName()+"
 832           // "+jds.getStart()+"-"+jds.getEnd()+" "+jds.getSequenceAsString());
 833           // System.err.println("Hashcode: "+seqHash(jds));
 834           // SequenceI rsq = (SequenceI) seqRefIds.get(id + "");
 835           // System.err.println(rsq.getName()+"
 836           // "+rsq.getStart()+"-"+rsq.getEnd()+" "+rsq.getSequenceAsString());
 837           // System.err.println("Hashcode: "+seqHash(rsq));
 838         }
 839         else
 840         {
 841           vamsasSeq = createVamsasSequence(id, jds);
 842           vamsasSet.addSequence(vamsasSeq);
 843           vamsasSetIds.put(id, vamsasSeq);
 844           seqRefIds.put(id, jds);
 845         }
 846       }
 847       jseq = new JSeq();
 848       jseq.setStart(jds.getStart());
 849       jseq.setEnd(jds.getEnd());
 850       jseq.setColour(av.getSequenceColour(jds).getRGB());
 851
 852       jseq.setId(id); // jseq id should be a string not a number
 853       if (!storeDS)
 854       {
 855         // Store any sequences this sequence represents
 856         if (av.hasHiddenRows())
 857         {
 858           // use rjal, contains the full height alignment
 859           jseq.setHidden(av.getAlignment().getHiddenSequences()
 860                   .isHidden(jds));
 861
 862           if (av.isHiddenRepSequence(jds))
 863           {
 864             jalview.datamodel.SequenceI[] reps = av
 865                     .getRepresentedSequences(jds).getSequencesInOrder(rjal);
 866
 867             for (int h = 0; h < reps.length; h++)
 868             {
 869               if (reps[h] != jds)
 870               {
 871                 jseq.addHiddenSequences(rjal.findIndex(reps[h]));
 872               }
 873             }
 874           }
 875         }
 876         // mark sequence as reference - if it is the reference for this view
 877         if (jal.hasSeqrep())
 878         {
 879           jseq.setViewreference(jds == jal.getSeqrep());
 880         }
 881       }
 882
 883       // TODO: omit sequence features from each alignment view's XML dump if we
 884       // are storing dataset
 885       if (jds.getSequenceFeatures() != null)
 886       {
 887         jalview.datamodel.SequenceFeature[] sf = jds.getSequenceFeatures();
 888         int index = 0;
 889         while (index < sf.length)
 890         {
 891           Features features = new Features();
 892
 893           features.setBegin(sf[index].getBegin());
 894           features.setEnd(sf[index].getEnd());
 895           features.setDescription(sf[index].getDescription());
 896           features.setType(sf[index].getType());
 897           features.setFeatureGroup(sf[index].getFeatureGroup());
 898           features.setScore(sf[index].getScore());
 899           if (sf[index].links != null)
 900           {
 901             for (int l = 0; l < sf[index].links.size(); l++)
 902             {
 903               OtherData keyValue = new OtherData();
 904               keyValue.setKey("LINK_" + l);
 905               keyValue.setValue(sf[index].links.elementAt(l).toString());
 906               features.addOtherData(keyValue);
 907             }
 908           }
 909           if (sf[index].otherDetails != null)
 910           {
 911             String key;
 912             Iterator<String> keys = sf[index].otherDetails.keySet()
 913                     .iterator();
 914             while (keys.hasNext())
 915             {
 916               key = keys.next();
 917               OtherData keyValue = new OtherData();
 918               keyValue.setKey(key);
 919               keyValue.setValue(sf[index].otherDetails.get(key).toString());
 920               features.addOtherData(keyValue);
 921             }
 922           }
 923
 924           jseq.addFeatures(features);
 925           index++;
 926         }
 927       }
 928
 929       if (jdatasq.getAllPDBEntries() != null)
 930       {
 931         Enumeration en = jdatasq.getAllPDBEntries().elements();
 932         while (en.hasMoreElements())
 933         {
 934           Pdbids pdb = new Pdbids();
 935           jalview.datamodel.PDBEntry entry = (jalview.datamodel.PDBEntry) en
 936                   .nextElement();
 937
 938           String pdbId = entry.getId();
 939           pdb.setId(pdbId);
 940           pdb.setType(entry.getType());
 941
 942           /*
 943            * Store any structure views associated with this sequence. This
 944            * section copes with duplicate entries in the project, so a dataset
 945            * only view *should* be coped with sensibly.
 946            */
 947           // This must have been loaded, is it still visible?
 948           JInternalFrame[] frames = Desktop.desktop.getAllFrames();
 949           String matchedFile = null;
 950           for (int f = frames.length - 1; f > -1; f--)
 951           {
 952             if (frames[f] instanceof StructureViewerBase)
 953             {
 954               StructureViewerBase viewFrame = (StructureViewerBase) frames[f];
 955               matchedFile = saveStructureState(ap, jds, pdb, entry,
 956                       viewIds, matchedFile, viewFrame);
 957               /*
 958                * Only store each structure viewer's state once in the project
 959                * jar. First time through only (storeDS==false)
 960                */
 961               String viewId = viewFrame.getViewId();
 962               if (!storeDS && !viewIds.contains(viewId))
 963               {
 964                 viewIds.add(viewId);
 965                 try
 966                 {
 967                   String viewerState = viewFrame.getStateInfo();
 968                   writeJarEntry(jout, getViewerJarEntryName(viewId),
 969                           viewerState.getBytes());
 970                 } catch (IOException e)
 971                 {
 972                   System.err.println("Error saving viewer state: "
 973                           + e.getMessage());
 974                 }
 975               }
 976             }
 977           }
 978
 979           if (matchedFile != null || entry.getFile() != null)
 980           {
 981             if (entry.getFile() != null)
 982             {
 983               // use entry's file
 984               matchedFile = entry.getFile();
 985             }
 986             pdb.setFile(matchedFile); // entry.getFile());
 987             if (pdbfiles == null)
 988             {
 989               pdbfiles = new ArrayList<String>();
 990             }
 991
 992             if (!pdbfiles.contains(pdbId))
 993             {
 994               pdbfiles.add(pdbId);
 995               copyFileToJar(jout, matchedFile, pdbId);
 996             }
 997           }
 998
 999           Enumeration<String> props = entry.getProperties();
1000           if (props.hasMoreElements())
1001           {
1002             PdbentryItem item = new PdbentryItem();
1003             while (props.hasMoreElements())
1004             {
1005               Property prop = new Property();
1006               String key = props.nextElement();
1007               prop.setName(key);
1008               prop.setValue(entry.getProperty(key).toString());
1009               item.addProperty(prop);
1010             }
1011             pdb.addPdbentryItem(item);
1012           }
1013
1014           jseq.addPdbids(pdb);
1015         }
1016       }
1017
1018       saveRnaViewers(jout, jseq, jds, viewIds, ap, storeDS);
1019
1020       jms.addJSeq(jseq);
1021     }
1022
1023     if (!storeDS && av.hasHiddenRows())
1024     {
1025       jal = av.getAlignment();
1026     }
1027     // SAVE MAPPINGS
1028     // FOR DATASET
1029     if (storeDS && jal.getCodonFrames() != null)
1030     {
1031       List<AlignedCodonFrame> jac = jal.getCodonFrames();
1032       for (AlignedCodonFrame acf : jac)
1033       {
1034         AlcodonFrame alc = new AlcodonFrame();
1035         if (acf.getProtMappings() != null
1036                 && acf.getProtMappings().length > 0)
1037         {
1038           boolean hasMap = false;
1039           SequenceI[] dnas = acf.getdnaSeqs();
1040           jalview.datamodel.Mapping[] pmaps = acf.getProtMappings();
1041           for (int m = 0; m < pmaps.length; m++)
1042           {
1043             AlcodMap alcmap = new AlcodMap();
1044             alcmap.setDnasq(seqHash(dnas[m]));
1045             alcmap.setMapping(createVamsasMapping(pmaps[m], dnas[m], null,
1046                     false));
1047             alc.addAlcodMap(alcmap);
1048             hasMap = true;
1049           }
1050           if (hasMap)
1051           {
1052             vamsasSet.addAlcodonFrame(alc);
1053           }
1054         }
1055         // TODO: delete this ? dead code from 2.8.3->2.9 ?
1056         // {
1057         // AlcodonFrame alc = new AlcodonFrame();
1058         // vamsasSet.addAlcodonFrame(alc);
1059         // for (int p = 0; p < acf.aaWidth; p++)
1060         // {
1061         // Alcodon cmap = new Alcodon();
1062         // if (acf.codons[p] != null)
1063         // {
1064         // // Null codons indicate a gapped column in the translated peptide
1065         // // alignment.
1066         // cmap.setPos1(acf.codons[p][0]);
1067         // cmap.setPos2(acf.codons[p][1]);
1068         // cmap.setPos3(acf.codons[p][2]);
1069         // }
1070         // alc.addAlcodon(cmap);
1071         // }
1072         // if (acf.getProtMappings() != null
1073         // && acf.getProtMappings().length > 0)
1074         // {
1075         // SequenceI[] dnas = acf.getdnaSeqs();
1076         // jalview.datamodel.Mapping[] pmaps = acf.getProtMappings();
1077         // for (int m = 0; m < pmaps.length; m++)
1078         // {
1079         // AlcodMap alcmap = new AlcodMap();
1080         // alcmap.setDnasq(seqHash(dnas[m]));
1081         // alcmap.setMapping(createVamsasMapping(pmaps[m], dnas[m], null,
1082         // false));
1083         // alc.addAlcodMap(alcmap);
1084         // }
1085         // }
1086       }
1087     }
1088
1089     // SAVE TREES
1090     // /////////////////////////////////
1091     if (!storeDS && av.currentTree != null)
1092     {
1093       // FIND ANY ASSOCIATED TREES
1094       // NOT IMPLEMENTED FOR HEADLESS STATE AT PRESENT
1095       if (Desktop.desktop != null)
1096       {
1097         JInternalFrame[] frames = Desktop.desktop.getAllFrames();
1098
1099         for (int t = 0; t < frames.length; t++)
1100         {
1101           if (frames[t] instanceof TreePanel)
1102           {
1103             TreePanel tp = (TreePanel) frames[t];
1104
1105             if (tp.treeCanvas.av.getAlignment() == jal)
1106             {
1107               Tree tree = new Tree();
1108               tree.setTitle(tp.getTitle());
1109               tree.setCurrentTree((av.currentTree == tp.getTree()));
1110               tree.setNewick(tp.getTree().toString());
1111               tree.setThreshold(tp.treeCanvas.threshold);
1112
1113               tree.setFitToWindow(tp.fitToWindow.getState());
1114               tree.setFontName(tp.getTreeFont().getName());
1115               tree.setFontSize(tp.getTreeFont().getSize());
1116               tree.setFontStyle(tp.getTreeFont().getStyle());
1117               tree.setMarkUnlinked(tp.placeholdersMenu.getState());
1118
1119               tree.setShowBootstrap(tp.bootstrapMenu.getState());
1120               tree.setShowDistances(tp.distanceMenu.getState());
1121
1122               tree.setHeight(tp.getHeight());
1123               tree.setWidth(tp.getWidth());
1124               tree.setXpos(tp.getX());
1125               tree.setYpos(tp.getY());
1126               tree.setId(makeHashCode(tp, null));
1127               jms.addTree(tree);
1128             }
1129           }
1130         }
1131       }
1132     }
1133
1134     // SAVE ANNOTATIONS
1135     /**
1136      * store forward refs from an annotationRow to any groups
1137      */
1138     IdentityHashMap<SequenceGroup, String> groupRefs = new IdentityHashMap<SequenceGroup, String>();
1139     if (storeDS)
1140     {
1141       for (SequenceI sq : jal.getSequences())
1142       {
1143         // Store annotation on dataset sequences only
1144         AlignmentAnnotation[] aa = sq.getAnnotation();
1145         if (aa != null && aa.length > 0)
1146         {
1147           storeAlignmentAnnotation(aa, groupRefs, av, calcIdSet, storeDS,
1148                   vamsasSet);
1149         }
1150       }
1151     }
1152     else
1153     {
1154       if (jal.getAlignmentAnnotation() != null)
1155       {
1156         // Store the annotation shown on the alignment.
1157         AlignmentAnnotation[] aa = jal.getAlignmentAnnotation();
1158         storeAlignmentAnnotation(aa, groupRefs, av, calcIdSet, storeDS,
1159                 vamsasSet);
1160       }
1161     }
1162     // SAVE GROUPS
1163     if (jal.getGroups() != null)
1164     {
1165       JGroup[] groups = new JGroup[jal.getGroups().size()];
1166       int i = -1;
1167       for (jalview.datamodel.SequenceGroup sg : jal.getGroups())
1168       {
1169         JGroup jGroup = new JGroup();
1170         groups[++i] = jGroup;
1171
1172         jGroup.setStart(sg.getStartRes());
1173         jGroup.setEnd(sg.getEndRes());
1174         jGroup.setName(sg.getName());
1175         if (groupRefs.containsKey(sg))
1176         {
1177           // group has references so set its ID field
1178           jGroup.setId(groupRefs.get(sg));
1179         }
1180         ColourSchemeI colourScheme = sg.getColourScheme();
1181         if (colourScheme != null)
1182         {
1183           ResidueShaderI groupColourScheme = sg
1184                   .getGroupColourScheme();
1185           if (groupColourScheme.conservationApplied())
1186           {
1187             jGroup.setConsThreshold(groupColourScheme.getConservationInc());
1188
1189             if (colourScheme instanceof jalview.schemes.UserColourScheme)
1190             {
1191               jGroup.setColour(setUserColourScheme(colourScheme,
1192                       userColours, jms));
1193             }
1194             else
1195             {
1196               jGroup.setColour(colourScheme.getSchemeName());
1197             }
1198           }
1199           else if (colourScheme instanceof jalview.schemes.AnnotationColourGradient)
1200           {
1201             jGroup.setColour("AnnotationColourGradient");
1202             jGroup.setAnnotationColours(constructAnnotationColours(
1203                     (jalview.schemes.AnnotationColourGradient) colourScheme,
1204                     userColours, jms));
1205           }
1206           else if (colourScheme instanceof jalview.schemes.UserColourScheme)
1207           {
1208             jGroup.setColour(setUserColourScheme(colourScheme,
1209                     userColours, jms));
1210           }
1211           else
1212           {
1213             jGroup.setColour(colourScheme.getSchemeName());
1214           }
1215
1216           jGroup.setPidThreshold(groupColourScheme.getThreshold());
1217         }
1218
1219         jGroup.setOutlineColour(sg.getOutlineColour().getRGB());
1220         jGroup.setDisplayBoxes(sg.getDisplayBoxes());
1221         jGroup.setDisplayText(sg.getDisplayText());
1222         jGroup.setColourText(sg.getColourText());
1223         jGroup.setTextCol1(sg.textColour.getRGB());
1224         jGroup.setTextCol2(sg.textColour2.getRGB());
1225         jGroup.setTextColThreshold(sg.thresholdTextColour);
1226         jGroup.setShowUnconserved(sg.getShowNonconserved());
1227         jGroup.setIgnoreGapsinConsensus(sg.getIgnoreGapsConsensus());
1228         jGroup.setShowConsensusHistogram(sg.isShowConsensusHistogram());
1229         jGroup.setShowSequenceLogo(sg.isShowSequenceLogo());
1230         jGroup.setNormaliseSequenceLogo(sg.isNormaliseSequenceLogo());
1231         for (SequenceI seq : sg.getSequences())
1232         {
1233           jGroup.addSeq(seqHash(seq));
1234         }
1235       }
1236
1237       jms.setJGroup(groups);
1238     }
1239     if (!storeDS)
1240     {
1241       // /////////SAVE VIEWPORT
1242       Viewport view = new Viewport();
1243       view.setTitle(ap.alignFrame.getTitle());
1244       view.setSequenceSetId(makeHashCode(av.getSequenceSetId(),
1245               av.getSequenceSetId()));
1246       view.setId(av.getViewId());
1247       if (av.getCodingComplement() != null)
1248       {
1249         view.setComplementId(av.getCodingComplement().getViewId());
1250       }
1251       view.setViewName(av.viewName);
1252       view.setGatheredViews(av.isGatherViewsHere());
1253
1254       Rectangle size = ap.av.getExplodedGeometry();
1255       Rectangle position = size;
1256       if (size == null)
1257       {
1258         size = ap.alignFrame.getBounds();
1259         if (av.getCodingComplement() != null)
1260         {
1261           position = ((SplitFrame) ap.alignFrame.getSplitViewContainer())
1262                   .getBounds();
1263         }
1264         else
1265         {
1266           position = size;
1267         }
1268       }
1269       view.setXpos(position.x);
1270       view.setYpos(position.y);
1271
1272       view.setWidth(size.width);
1273       view.setHeight(size.height);
1274
1275       view.setStartRes(vpRanges.getStartRes());
1276       view.setStartSeq(vpRanges.getStartSeq());
1277
1278       if (av.getGlobalColourScheme() instanceof jalview.schemes.UserColourScheme)
1279       {
1280         view.setBgColour(setUserColourScheme(av.getGlobalColourScheme(),
1281                 userColours, jms));
1282       }
1283       else if (av.getGlobalColourScheme() instanceof jalview.schemes.AnnotationColourGradient)
1284       {
1285         AnnotationColours ac = constructAnnotationColours(
1286                 (jalview.schemes.AnnotationColourGradient) av
1287                         .getGlobalColourScheme(),
1288                 userColours, jms);
1289
1290         view.setAnnotationColours(ac);
1291         view.setBgColour("AnnotationColourGradient");
1292       }
1293       else
1294       {
1295         view.setBgColour(ColourSchemeProperty.getColourName(av
1296                 .getGlobalColourScheme()));
1297       }
1298
1299       ResidueShaderI vcs = av.getResidueShading();
1300       ColourSchemeI cs = av.getGlobalColourScheme();
1301
1302       if (cs != null)
1303       {
1304         if (vcs.conservationApplied())
1305         {
1306           view.setConsThreshold(vcs.getConservationInc());
1307           if (cs instanceof jalview.schemes.UserColourScheme)
1308           {
1309             view.setBgColour(setUserColourScheme(cs, userColours, jms));
1310           }
1311         }
1312         view.setPidThreshold(vcs.getThreshold());
1313       }
1314
1315       view.setConservationSelected(av.getConservationSelected());
1316       view.setPidSelected(av.getAbovePIDThreshold());
1317       view.setFontName(av.font.getName());
1318       view.setFontSize(av.font.getSize());
1319       view.setFontStyle(av.font.getStyle());
1320       view.setScaleProteinAsCdna(av.getViewStyle().isScaleProteinAsCdna());
1321       view.setRenderGaps(av.isRenderGaps());
1322       view.setShowAnnotation(av.isShowAnnotation());
1323       view.setShowBoxes(av.getShowBoxes());
1324       view.setShowColourText(av.getColourText());
1325       view.setShowFullId(av.getShowJVSuffix());
1326       view.setRightAlignIds(av.isRightAlignIds());
1327       view.setShowSequenceFeatures(av.isShowSequenceFeatures());
1328       view.setShowText(av.getShowText());
1329       view.setShowUnconserved(av.getShowUnconserved());
1330       view.setWrapAlignment(av.getWrapAlignment());
1331       view.setTextCol1(av.getTextColour().getRGB());
1332       view.setTextCol2(av.getTextColour2().getRGB());
1333       view.setTextColThreshold(av.getThresholdTextColour());
1334       view.setShowConsensusHistogram(av.isShowConsensusHistogram());
1335       view.setShowSequenceLogo(av.isShowSequenceLogo());
1336       view.setNormaliseSequenceLogo(av.isNormaliseSequenceLogo());
1337       view.setShowGroupConsensus(av.isShowGroupConsensus());
1338       view.setShowGroupConservation(av.isShowGroupConservation());
1339       view.setShowNPfeatureTooltip(av.isShowNPFeats());
1340       view.setShowDbRefTooltip(av.isShowDBRefs());
1341       view.setFollowHighlight(av.isFollowHighlight());
1342       view.setFollowSelection(av.followSelection);
1343       view.setIgnoreGapsinConsensus(av.isIgnoreGapsConsensus());
1344       if (av.getFeaturesDisplayed() != null)
1345       {
1346         jalview.schemabinding.version2.FeatureSettings fs = new jalview.schemabinding.version2.FeatureSettings();
1347
1348         String[] renderOrder = ap.getSeqPanel().seqCanvas
1349                 .getFeatureRenderer().getRenderOrder()
1350                 .toArray(new String[0]);
1351
1352         Vector<String> settingsAdded = new Vector<String>();
1353         if (renderOrder != null)
1354         {
1355           for (String featureType : renderOrder)
1356           {
1357             FeatureColourI fcol = ap.getSeqPanel().seqCanvas
1358                     .getFeatureRenderer().getFeatureStyle(featureType);
1359             Setting setting = new Setting();
1360             setting.setType(featureType);
1361             if (!fcol.isSimpleColour())
1362             {
1363               setting.setColour(fcol.getMaxColour().getRGB());
1364               setting.setMincolour(fcol.getMinColour().getRGB());
1365               setting.setMin(fcol.getMin());
1366               setting.setMax(fcol.getMax());
1367               setting.setColourByLabel(fcol.isColourByLabel());
1368               setting.setAutoScale(fcol.isAutoScaled());
1369               setting.setThreshold(fcol.getThreshold());
1370               // -1 = No threshold, 0 = Below, 1 = Above
1371               setting.setThreshstate(fcol.isAboveThreshold() ? 1 : (fcol
1372                       .isBelowThreshold() ? 0 : -1));
1373             }
1374             else
1375             {
1376               setting.setColour(fcol.getColour().getRGB());
1377             }
1378
1379             setting.setDisplay(av.getFeaturesDisplayed().isVisible(
1380                     featureType));
1381             float rorder = ap.getSeqPanel().seqCanvas.getFeatureRenderer()
1382                     .getOrder(featureType);
1383             if (rorder > -1)
1384             {
1385               setting.setOrder(rorder);
1386             }
1387             fs.addSetting(setting);
1388             settingsAdded.addElement(featureType);
1389           }
1390         }
1391
1392         // is groups actually supposed to be a map here ?
1393         Iterator<String> en = ap.getSeqPanel().seqCanvas
1394                 .getFeatureRenderer().getFeatureGroups().iterator();
1395         Vector<String> groupsAdded = new Vector<String>();
1396         while (en.hasNext())
1397         {
1398           String grp = en.next();
1399           if (groupsAdded.contains(grp))
1400           {
1401             continue;
1402           }
1403           Group g = new Group();
1404           g.setName(grp);
1405           g.setDisplay(((Boolean) ap.getSeqPanel().seqCanvas
1406                   .getFeatureRenderer().checkGroupVisibility(grp, false))
1407                   .booleanValue());
1408           fs.addGroup(g);
1409           groupsAdded.addElement(grp);
1410         }
1411         jms.setFeatureSettings(fs);
1412       }
1413
1414       if (av.hasHiddenColumns())
1415       {
1416         jalview.datamodel.HiddenColumns hidden = av.getAlignment()
1417                 .getHiddenColumns();
1418         if (hidden == null || hidden.getHiddenRegions() == null)
1419         {
1420           warn("REPORT BUG: avoided null columnselection bug (DMAM reported). Please contact Jim about this.");
1421         }
1422         else
1423         {
1424           for (int c = 0; c < hidden.getHiddenRegions()
1425                   .size(); c++)
1426           {
1427             int[] region = hidden.getHiddenRegions()
1428                     .get(c);
1429             HiddenColumns hc = new HiddenColumns();
1430             hc.setStart(region[0]);
1431             hc.setEnd(region[1]);
1432             view.addHiddenColumns(hc);
1433           }
1434         }
1435       }
1436       if (calcIdSet.size() > 0)
1437       {
1438         for (String calcId : calcIdSet)
1439         {
1440           if (calcId.trim().length() > 0)
1441           {
1442             CalcIdParam cidp = createCalcIdParam(calcId, av);
1443             // Some calcIds have no parameters.
1444             if (cidp != null)
1445             {
1446               view.addCalcIdParam(cidp);
1447             }
1448           }
1449         }
1450       }
1451
1452       jms.addViewport(view);
1453     }
1454     object.setJalviewModelSequence(jms);
1455     object.getVamsasModel().addSequenceSet(vamsasSet);
1456
1457     if (jout != null && fileName != null)
1458     {
1459       // We may not want to write the object to disk,
1460       // eg we can copy the alignViewport to a new view object
1461       // using save and then load
1462       try
1463       {
1464         System.out.println("Writing jar entry " + fileName);
1465         JarEntry entry = new JarEntry(fileName);
1466         jout.putNextEntry(entry);
1467         PrintWriter pout = new PrintWriter(new OutputStreamWriter(jout,
1468                 UTF_8));
1469         Marshaller marshaller = new Marshaller(pout);
1470         marshaller.marshal(object);
1471         pout.flush();
1472         jout.closeEntry();
1473       } catch (Exception ex)
1474       {
1475         // TODO: raise error in GUI if marshalling failed.
1476         ex.printStackTrace();
1477       }
1478     }
1479     return object;
1480   }
1481
1482   /**
1483    * Save any Varna viewers linked to this sequence. Writes an rnaViewer element
1484    * for each viewer, with
1485    * <ul>
1486    * <li>viewer geometry (position, size, split pane divider location)</li>
1487    * <li>index of the selected structure in the viewer (currently shows gapped
1488    * or ungapped)</li>
1489    * <li>the id of the annotation holding RNA secondary structure</li>
1490    * <li>(currently only one SS is shown per viewer, may be more in future)</li>
1491    * </ul>
1492    * Varna viewer state is also written out (in native Varna XML) to separate
1493    * project jar entries. A separate entry is written for each RNA structure
1494    * displayed, with the naming convention
1495    * <ul>
1496    * <li>rna_viewId_sequenceId_annotationId_[gapped|trimmed]</li>
1497    * </ul>
1498    *
1499    * @param jout
1500    * @param jseq
1501    * @param jds
1502    * @param viewIds
1503    * @param ap
1504    * @param storeDataset
1505    */
1506   protected void saveRnaViewers(JarOutputStream jout, JSeq jseq,
1507           final SequenceI jds, List<String> viewIds, AlignmentPanel ap,
1508           boolean storeDataset)
1509   {
1510     if (Desktop.desktop == null)
1511     {
1512       return;
1513     }
1514     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
1515     for (int f = frames.length - 1; f > -1; f--)
1516     {
1517       if (frames[f] instanceof AppVarna)
1518       {
1519         AppVarna varna = (AppVarna) frames[f];
1520         /*
1521          * link the sequence to every viewer that is showing it and is linked to
1522          * its alignment panel
1523          */
1524         if (varna.isListeningFor(jds) && ap == varna.getAlignmentPanel())
1525         {
1526           String viewId = varna.getViewId();
1527           RnaViewer rna = new RnaViewer();
1528           rna.setViewId(viewId);
1529           rna.setTitle(varna.getTitle());
1530           rna.setXpos(varna.getX());
1531           rna.setYpos(varna.getY());
1532           rna.setWidth(varna.getWidth());
1533           rna.setHeight(varna.getHeight());
1534           rna.setDividerLocation(varna.getDividerLocation());
1535           rna.setSelectedRna(varna.getSelectedIndex());
1536           jseq.addRnaViewer(rna);
1537
1538           /*
1539            * Store each Varna panel's state once in the project per sequence.
1540            * First time through only (storeDataset==false)
1541            */
1542           // boolean storeSessions = false;
1543           // String sequenceViewId = viewId + seqsToIds.get(jds);
1544           // if (!storeDataset && !viewIds.contains(sequenceViewId))
1545           // {
1546           // viewIds.add(sequenceViewId);
1547           // storeSessions = true;
1548           // }
1549           for (RnaModel model : varna.getModels())
1550           {
1551             if (model.seq == jds)
1552             {
1553               /*
1554                * VARNA saves each view (sequence or alignment secondary
1555                * structure, gapped or trimmed) as a separate XML file
1556                */
1557               String jarEntryName = rnaSessions.get(model);
1558               if (jarEntryName == null)
1559               {
1560
1561                 String varnaStateFile = varna.getStateInfo(model.rna);
1562                 jarEntryName = RNA_PREFIX + viewId + "_" + nextCounter();
1563                 copyFileToJar(jout, varnaStateFile, jarEntryName);
1564                 rnaSessions.put(model, jarEntryName);
1565               }
1566               SecondaryStructure ss = new SecondaryStructure();
1567               String annotationId = varna.getAnnotation(jds).annotationId;
1568               ss.setAnnotationId(annotationId);
1569               ss.setViewerState(jarEntryName);
1570               ss.setGapped(model.gapped);
1571               ss.setTitle(model.title);
1572               rna.addSecondaryStructure(ss);
1573             }
1574           }
1575         }
1576       }
1577     }
1578   }
1579
1580   /**
1581    * Copy the contents of a file to a new entry added to the output jar
1582    *
1583    * @param jout
1584    * @param infilePath
1585    * @param jarEntryName
1586    */
1587   protected void copyFileToJar(JarOutputStream jout, String infilePath,
1588           String jarEntryName)
1589   {
1590     DataInputStream dis = null;
1591     try
1592     {
1593       File file = new File(infilePath);
1594       if (file.exists() && jout != null)
1595       {
1596         dis = new DataInputStream(new FileInputStream(file));
1597         byte[] data = new byte[(int) file.length()];
1598         dis.readFully(data);
1599         writeJarEntry(jout, jarEntryName, data);
1600       }
1601     } catch (Exception ex)
1602     {
1603       ex.printStackTrace();
1604     } finally
1605     {
1606       if (dis != null)
1607       {
1608         try
1609         {
1610           dis.close();
1611         } catch (IOException e)
1612         {
1613           // ignore
1614         }
1615       }
1616     }
1617   }
1618
1619   /**
1620    * Write the data to a new entry of given name in the output jar file
1621    *
1622    * @param jout
1623    * @param jarEntryName
1624    * @param data
1625    * @throws IOException
1626    */
1627   protected void writeJarEntry(JarOutputStream jout, String jarEntryName,
1628           byte[] data) throws IOException
1629   {
1630     if (jout != null)
1631     {
1632       System.out.println("Writing jar entry " + jarEntryName);
1633       jout.putNextEntry(new JarEntry(jarEntryName));
1634       DataOutputStream dout = new DataOutputStream(jout);
1635       dout.write(data, 0, data.length);
1636       dout.flush();
1637       jout.closeEntry();
1638     }
1639   }
1640
1641   /**
1642    * Save the state of a structure viewer
1643    *
1644    * @param ap
1645    * @param jds
1646    * @param pdb
1647    *          the archive XML element under which to save the state
1648    * @param entry
1649    * @param viewIds
1650    * @param matchedFile
1651    * @param viewFrame
1652    * @return
1653    */
1654   protected String saveStructureState(AlignmentPanel ap, SequenceI jds,
1655           Pdbids pdb, PDBEntry entry, List<String> viewIds,
1656           String matchedFile, StructureViewerBase viewFrame)
1657   {
1658     final AAStructureBindingModel bindingModel = viewFrame.getBinding();
1659
1660     /*
1661      * Look for any bindings for this viewer to the PDB file of interest
1662      * (including part matches excluding chain id)
1663      */
1664     for (int peid = 0; peid < bindingModel.getPdbCount(); peid++)
1665     {
1666       final PDBEntry pdbentry = bindingModel.getPdbEntry(peid);
1667       final String pdbId = pdbentry.getId();
1668       if (!pdbId.equals(entry.getId())
1669               && !(entry.getId().length() > 4 && entry.getId()
1670                       .toLowerCase().startsWith(pdbId.toLowerCase())))
1671       {
1672         /*
1673          * not interested in a binding to a different PDB entry here
1674          */
1675         continue;
1676       }
1677       if (matchedFile == null)
1678       {
1679         matchedFile = pdbentry.getFile();
1680       }
1681       else if (!matchedFile.equals(pdbentry.getFile()))
1682       {
1683         Cache.log
1684                 .warn("Probably lost some PDB-Sequence mappings for this structure file (which apparently has same PDB Entry code): "
1685                         + pdbentry.getFile());
1686       }
1687       // record the
1688       // file so we
1689       // can get at it if the ID
1690       // match is ambiguous (e.g.
1691       // 1QIP==1qipA)
1692
1693       for (int smap = 0; smap < viewFrame.getBinding().getSequence()[peid].length; smap++)
1694       {
1695         // if (jal.findIndex(jmol.jmb.sequence[peid][smap]) > -1)
1696         if (jds == viewFrame.getBinding().getSequence()[peid][smap])
1697         {
1698           StructureState state = new StructureState();
1699           state.setVisible(true);
1700           state.setXpos(viewFrame.getX());
1701           state.setYpos(viewFrame.getY());
1702           state.setWidth(viewFrame.getWidth());
1703           state.setHeight(viewFrame.getHeight());
1704           final String viewId = viewFrame.getViewId();
1705           state.setViewId(viewId);
1706           state.setAlignwithAlignPanel(viewFrame.isUsedforaligment(ap));
1707           state.setColourwithAlignPanel(viewFrame.isUsedforcolourby(ap));
1708           state.setColourByJmol(viewFrame.isColouredByViewer());
1709           state.setType(viewFrame.getViewerType().toString());
1710           pdb.addStructureState(state);
1711         }
1712       }
1713     }
1714     return matchedFile;
1715   }
1716
1717   /**
1718    * Populates the AnnotationColours xml for save. This captures the settings of
1719    * the options in the 'Colour by Annotation' dialog.
1720    *
1721    * @param acg
1722    * @param userColours
1723    * @param jms
1724    * @return
1725    */
1726   private AnnotationColours constructAnnotationColours(
1727           AnnotationColourGradient acg, List<UserColourScheme> userColours,
1728           JalviewModelSequence jms)
1729   {
1730     AnnotationColours ac = new AnnotationColours();
1731     ac.setAboveThreshold(acg.getAboveThreshold());
1732     ac.setThreshold(acg.getAnnotationThreshold());
1733     // 2.10.2 save annotationId (unique) not annotation label
1734     ac.setAnnotation(acg.getAnnotation().annotationId);
1735     if (acg.getBaseColour() instanceof UserColourScheme)
1736     {
1737       ac.setColourScheme(setUserColourScheme(acg.getBaseColour(),
1738               userColours, jms));
1739     }
1740     else
1741     {
1742       ac.setColourScheme(ColourSchemeProperty.getColourName(acg.getBaseColour()));
1743     }
1744
1745     ac.setMaxColour(acg.getMaxColour().getRGB());
1746     ac.setMinColour(acg.getMinColour().getRGB());
1747     ac.setPerSequence(acg.isSeqAssociated());
1748     ac.setPredefinedColours(acg.isPredefinedColours());
1749     return ac;
1750   }
1751
1752   private void storeAlignmentAnnotation(AlignmentAnnotation[] aa,
1753           IdentityHashMap<SequenceGroup, String> groupRefs,
1754           AlignmentViewport av, Set<String> calcIdSet, boolean storeDS,
1755           SequenceSet vamsasSet)
1756   {
1757
1758     for (int i = 0; i < aa.length; i++)
1759     {
1760       Annotation an = new Annotation();
1761
1762       AlignmentAnnotation annotation = aa[i];
1763       if (annotation.annotationId != null)
1764       {
1765         annotationIds.put(annotation.annotationId, annotation);
1766       }
1767
1768       an.setId(annotation.annotationId);
1769
1770       an.setVisible(annotation.visible);
1771
1772       an.setDescription(annotation.description);
1773
1774       if (annotation.sequenceRef != null)
1775       {
1776         // 2.9 JAL-1781 xref on sequence id rather than name
1777         an.setSequenceRef(seqsToIds.get(annotation.sequenceRef));
1778       }
1779       if (annotation.groupRef != null)
1780       {
1781         String groupIdr = groupRefs.get(annotation.groupRef);
1782         if (groupIdr == null)
1783         {
1784           // make a locally unique String
1785           groupRefs.put(
1786                   annotation.groupRef,
1787                   groupIdr = ("" + System.currentTimeMillis()
1788                           + annotation.groupRef.getName() + groupRefs
1789                           .size()));
1790         }
1791         an.setGroupRef(groupIdr.toString());
1792       }
1793
1794       // store all visualization attributes for annotation
1795       an.setGraphHeight(annotation.graphHeight);
1796       an.setCentreColLabels(annotation.centreColLabels);
1797       an.setScaleColLabels(annotation.scaleColLabel);
1798       an.setShowAllColLabels(annotation.showAllColLabels);
1799       an.setBelowAlignment(annotation.belowAlignment);
1800
1801       if (annotation.graph > 0)
1802       {
1803         an.setGraph(true);
1804         an.setGraphType(annotation.graph);
1805         an.setGraphGroup(annotation.graphGroup);
1806         if (annotation.getThreshold() != null)
1807         {
1808           ThresholdLine line = new ThresholdLine();
1809           line.setLabel(annotation.getThreshold().label);
1810           line.setValue(annotation.getThreshold().value);
1811           line.setColour(annotation.getThreshold().colour.getRGB());
1812           an.setThresholdLine(line);
1813         }
1814       }
1815       else
1816       {
1817         an.setGraph(false);
1818       }
1819
1820       an.setLabel(annotation.label);
1821
1822       if (annotation == av.getAlignmentQualityAnnot()
1823               || annotation == av.getAlignmentConservationAnnotation()
1824               || annotation == av.getAlignmentConsensusAnnotation()
1825               || annotation.autoCalculated)
1826       {
1827         // new way of indicating autocalculated annotation -
1828         an.setAutoCalculated(annotation.autoCalculated);
1829       }
1830       if (annotation.hasScore())
1831       {
1832         an.setScore(annotation.getScore());
1833       }
1834
1835       if (annotation.getCalcId() != null)
1836       {
1837         calcIdSet.add(annotation.getCalcId());
1838         an.setCalcId(annotation.getCalcId());
1839       }
1840       if (annotation.hasProperties())
1841       {
1842         for (String pr : annotation.getProperties())
1843         {
1844           Property prop = new Property();
1845           prop.setName(pr);
1846           prop.setValue(annotation.getProperty(pr));
1847           an.addProperty(prop);
1848         }
1849       }
1850
1851       AnnotationElement ae;
1852       if (annotation.annotations != null)
1853       {
1854         an.setScoreOnly(false);
1855         for (int a = 0; a < annotation.annotations.length; a++)
1856         {
1857           if ((annotation == null) || (annotation.annotations[a] == null))
1858           {
1859             continue;
1860           }
1861
1862           ae = new AnnotationElement();
1863           if (annotation.annotations[a].description != null)
1864           {
1865             ae.setDescription(annotation.annotations[a].description);
1866           }
1867           if (annotation.annotations[a].displayCharacter != null)
1868           {
1869             ae.setDisplayCharacter(annotation.annotations[a].displayCharacter);
1870           }
1871
1872           if (!Float.isNaN(annotation.annotations[a].value))
1873           {
1874             ae.setValue(annotation.annotations[a].value);
1875           }
1876
1877           ae.setPosition(a);
1878           if (annotation.annotations[a].secondaryStructure > ' ')
1879           {
1880             ae.setSecondaryStructure(annotation.annotations[a].secondaryStructure
1881                     + "");
1882           }
1883
1884           if (annotation.annotations[a].colour != null
1885                   && annotation.annotations[a].colour != java.awt.Color.black)
1886           {
1887             ae.setColour(annotation.annotations[a].colour.getRGB());
1888           }
1889
1890           an.addAnnotationElement(ae);
1891           if (annotation.autoCalculated)
1892           {
1893             // only write one non-null entry into the annotation row -
1894             // sufficient to get the visualization attributes necessary to
1895             // display data
1896             continue;
1897           }
1898         }
1899       }
1900       else
1901       {
1902         an.setScoreOnly(true);
1903       }
1904       if (!storeDS || (storeDS && !annotation.autoCalculated))
1905       {
1906         // skip autocalculated annotation - these are only provided for
1907         // alignments
1908         vamsasSet.addAnnotation(an);
1909       }
1910     }
1911
1912   }
1913
1914   private CalcIdParam createCalcIdParam(String calcId, AlignViewport av)
1915   {
1916     AutoCalcSetting settings = av.getCalcIdSettingsFor(calcId);
1917     if (settings != null)
1918     {
1919       CalcIdParam vCalcIdParam = new CalcIdParam();
1920       vCalcIdParam.setCalcId(calcId);
1921       vCalcIdParam.addServiceURL(settings.getServiceURI());
1922       // generic URI allowing a third party to resolve another instance of the
1923       // service used for this calculation
1924       for (String urls : settings.getServiceURLs())
1925       {
1926         vCalcIdParam.addServiceURL(urls);
1927       }
1928       vCalcIdParam.setVersion("1.0");
1929       if (settings.getPreset() != null)
1930       {
1931         WsParamSetI setting = settings.getPreset();
1932         vCalcIdParam.setName(setting.getName());
1933         vCalcIdParam.setDescription(setting.getDescription());
1934       }
1935       else
1936       {
1937         vCalcIdParam.setName("");
1938         vCalcIdParam.setDescription("Last used parameters");
1939       }
1940       // need to be able to recover 1) settings 2) user-defined presets or
1941       // recreate settings from preset 3) predefined settings provided by
1942       // service - or settings that can be transferred (or discarded)
1943       vCalcIdParam.setParameters(settings.getWsParamFile().replace("\n",
1944               "|\\n|"));
1945       vCalcIdParam.setAutoUpdate(settings.isAutoUpdate());
1946       // todo - decide if updateImmediately is needed for any projects.
1947
1948       return vCalcIdParam;
1949     }
1950     return null;
1951   }
1952
1953   private boolean recoverCalcIdParam(CalcIdParam calcIdParam,
1954           AlignViewport av)
1955   {
1956     if (calcIdParam.getVersion().equals("1.0"))
1957     {
1958       Jws2Instance service = Jws2Discoverer.getDiscoverer()
1959               .getPreferredServiceFor(calcIdParam.getServiceURL());
1960       if (service != null)
1961       {
1962         WsParamSetI parmSet = null;
1963         try
1964         {
1965           parmSet = service.getParamStore().parseServiceParameterFile(
1966                   calcIdParam.getName(), calcIdParam.getDescription(),
1967                   calcIdParam.getServiceURL(),
1968                   calcIdParam.getParameters().replace("|\\n|", "\n"));
1969         } catch (IOException x)
1970         {
1971           warn("Couldn't parse parameter data for "
1972                   + calcIdParam.getCalcId(), x);
1973           return false;
1974         }
1975         List<ArgumentI> argList = null;
1976         if (calcIdParam.getName().length() > 0)
1977         {
1978           parmSet = service.getParamStore()
1979                   .getPreset(calcIdParam.getName());
1980           if (parmSet != null)
1981           {
1982             // TODO : check we have a good match with settings in AACon -
1983             // otherwise we'll need to create a new preset
1984           }
1985         }
1986         else
1987         {
1988           argList = parmSet.getArguments();
1989           parmSet = null;
1990         }
1991         AAConSettings settings = new AAConSettings(
1992                 calcIdParam.isAutoUpdate(), service, parmSet, argList);
1993         av.setCalcIdSettingsFor(calcIdParam.getCalcId(), settings,
1994                 calcIdParam.isNeedsUpdate());
1995         return true;
1996       }
1997       else
1998       {
1999         warn("Cannot resolve a service for the parameters used in this project. Try configuring a JABAWS server.");
2000         return false;
2001       }
2002     }
2003     throw new Error(MessageManager.formatMessage(
2004             "error.unsupported_version_calcIdparam",
2005             new Object[] { calcIdParam.toString() }));
2006   }
2007
2008   /**
2009    * External mapping between jalview objects and objects yielding a valid and
2010    * unique object ID string. This is null for normal Jalview project IO, but
2011    * non-null when a jalview project is being read or written as part of a
2012    * vamsas session.
2013    */
2014   IdentityHashMap jv2vobj = null;
2015
2016   /**
2017    * Construct a unique ID for jvobj using either existing bindings or if none
2018    * exist, the result of the hashcode call for the object.
2019    *
2020    * @param jvobj
2021    *          jalview data object
2022    * @return unique ID for referring to jvobj
2023    */
2024   private String makeHashCode(Object jvobj, String altCode)
2025   {
2026     if (jv2vobj != null)
2027     {
2028       Object id = jv2vobj.get(jvobj);
2029       if (id != null)
2030       {
2031         return id.toString();
2032       }
2033       // check string ID mappings
2034       if (jvids2vobj != null && jvobj instanceof String)
2035       {
2036         id = jvids2vobj.get(jvobj);
2037       }
2038       if (id != null)
2039       {
2040         return id.toString();
2041       }
2042       // give up and warn that something has gone wrong
2043       warn("Cannot find ID for object in external mapping : " + jvobj);
2044     }
2045     return altCode;
2046   }
2047
2048   /**
2049    * return local jalview object mapped to ID, if it exists
2050    *
2051    * @param idcode
2052    *          (may be null)
2053    * @return null or object bound to idcode
2054    */
2055   private Object retrieveExistingObj(String idcode)
2056   {
2057     if (idcode != null && vobj2jv != null)
2058     {
2059       return vobj2jv.get(idcode);
2060     }
2061     return null;
2062   }
2063
2064   /**
2065    * binding from ID strings from external mapping table to jalview data model
2066    * objects.
2067    */
2068   private Hashtable vobj2jv;
2069
2070   private Sequence createVamsasSequence(String id, SequenceI jds)
2071   {
2072     return createVamsasSequence(true, id, jds, null);
2073   }
2074
2075   private Sequence createVamsasSequence(boolean recurse, String id,
2076           SequenceI jds, SequenceI parentseq)
2077   {
2078     Sequence vamsasSeq = new Sequence();
2079     vamsasSeq.setId(id);
2080     vamsasSeq.setName(jds.getName());
2081     vamsasSeq.setSequence(jds.getSequenceAsString());
2082     vamsasSeq.setDescription(jds.getDescription());
2083     jalview.datamodel.DBRefEntry[] dbrefs = null;
2084     if (jds.getDatasetSequence() != null)
2085     {
2086       vamsasSeq.setDsseqid(seqHash(jds.getDatasetSequence()));
2087     }
2088     else
2089     {
2090       // seqId==dsseqid so we can tell which sequences really are
2091       // dataset sequences only
2092       vamsasSeq.setDsseqid(id);
2093       dbrefs = jds.getDBRefs();
2094       if (parentseq == null)
2095       {
2096         parentseq = jds;
2097       }
2098     }
2099     if (dbrefs != null)
2100     {
2101       for (int d = 0; d < dbrefs.length; d++)
2102       {
2103         DBRef dbref = new DBRef();
2104         dbref.setSource(dbrefs[d].getSource());
2105         dbref.setVersion(dbrefs[d].getVersion());
2106         dbref.setAccessionId(dbrefs[d].getAccessionId());
2107         if (dbrefs[d].hasMap())
2108         {
2109           Mapping mp = createVamsasMapping(dbrefs[d].getMap(), parentseq,
2110                   jds, recurse);
2111           dbref.setMapping(mp);
2112         }
2113         vamsasSeq.addDBRef(dbref);
2114       }
2115     }
2116     return vamsasSeq;
2117   }
2118
2119   private Mapping createVamsasMapping(jalview.datamodel.Mapping jmp,
2120           SequenceI parentseq, SequenceI jds, boolean recurse)
2121   {
2122     Mapping mp = null;
2123     if (jmp.getMap() != null)
2124     {
2125       mp = new Mapping();
2126
2127       jalview.util.MapList mlst = jmp.getMap();
2128       List<int[]> r = mlst.getFromRanges();
2129       for (int[] range : r)
2130       {
2131         MapListFrom mfrom = new MapListFrom();
2132         mfrom.setStart(range[0]);
2133         mfrom.setEnd(range[1]);
2134         mp.addMapListFrom(mfrom);
2135       }
2136       r = mlst.getToRanges();
2137       for (int[] range : r)
2138       {
2139         MapListTo mto = new MapListTo();
2140         mto.setStart(range[0]);
2141         mto.setEnd(range[1]);
2142         mp.addMapListTo(mto);
2143       }
2144       mp.setMapFromUnit(mlst.getFromRatio());
2145       mp.setMapToUnit(mlst.getToRatio());
2146       if (jmp.getTo() != null)
2147       {
2148         MappingChoice mpc = new MappingChoice();
2149
2150         // check/create ID for the sequence referenced by getTo()
2151
2152         String jmpid = "";
2153         SequenceI ps = null;
2154         if (parentseq != jmp.getTo()
2155                 && parentseq.getDatasetSequence() != jmp.getTo())
2156         {
2157           // chaining dbref rather than a handshaking one
2158           jmpid = seqHash(ps = jmp.getTo());
2159         }
2160         else
2161         {
2162           jmpid = seqHash(ps = parentseq);
2163         }
2164         mpc.setDseqFor(jmpid);
2165         if (!seqRefIds.containsKey(mpc.getDseqFor()))
2166         {
2167           jalview.bin.Cache.log.debug("creatign new DseqFor ID");
2168           seqRefIds.put(mpc.getDseqFor(), ps);
2169         }
2170         else
2171         {
2172           jalview.bin.Cache.log.debug("reusing DseqFor ID");
2173         }
2174
2175         mp.setMappingChoice(mpc);
2176       }
2177     }
2178     return mp;
2179   }
2180
2181   String setUserColourScheme(jalview.schemes.ColourSchemeI cs,
2182           List<UserColourScheme> userColours, JalviewModelSequence jms)
2183   {
2184     String id = null;
2185     jalview.schemes.UserColourScheme ucs = (jalview.schemes.UserColourScheme) cs;
2186     boolean newucs = false;
2187     if (!userColours.contains(ucs))
2188     {
2189       userColours.add(ucs);
2190       newucs = true;
2191     }
2192     id = "ucs" + userColours.indexOf(ucs);
2193     if (newucs)
2194     {
2195       // actually create the scheme's entry in the XML model
2196       java.awt.Color[] colours = ucs.getColours();
2197       jalview.schemabinding.version2.UserColours uc = new jalview.schemabinding.version2.UserColours();
2198       jalview.schemabinding.version2.UserColourScheme jbucs = new jalview.schemabinding.version2.UserColourScheme();
2199
2200       for (int i = 0; i < colours.length; i++)
2201       {
2202         jalview.schemabinding.version2.Colour col = new jalview.schemabinding.version2.Colour();
2203         col.setName(ResidueProperties.aa[i]);
2204         col.setRGB(jalview.util.Format.getHexString(colours[i]));
2205         jbucs.addColour(col);
2206       }
2207       if (ucs.getLowerCaseColours() != null)
2208       {
2209         colours = ucs.getLowerCaseColours();
2210         for (int i = 0; i < colours.length; i++)
2211         {
2212           jalview.schemabinding.version2.Colour col = new jalview.schemabinding.version2.Colour();
2213           col.setName(ResidueProperties.aa[i].toLowerCase());
2214           col.setRGB(jalview.util.Format.getHexString(colours[i]));
2215           jbucs.addColour(col);
2216         }
2217       }
2218
2219       uc.setId(id);
2220       uc.setUserColourScheme(jbucs);
2221       jms.addUserColours(uc);
2222     }
2223
2224     return id;
2225   }
2226
2227   jalview.schemes.UserColourScheme getUserColourScheme(
2228           JalviewModelSequence jms, String id)
2229   {
2230     UserColours[] uc = jms.getUserColours();
2231     UserColours colours = null;
2232
2233     for (int i = 0; i < uc.length; i++)
2234     {
2235       if (uc[i].getId().equals(id))
2236       {
2237         colours = uc[i];
2238
2239         break;
2240       }
2241     }
2242
2243     java.awt.Color[] newColours = new java.awt.Color[24];
2244
2245     for (int i = 0; i < 24; i++)
2246     {
2247       newColours[i] = new java.awt.Color(Integer.parseInt(colours
2248               .getUserColourScheme().getColour(i).getRGB(), 16));
2249     }
2250
2251     jalview.schemes.UserColourScheme ucs = new jalview.schemes.UserColourScheme(
2252             newColours);
2253
2254     if (colours.getUserColourScheme().getColourCount() > 24)
2255     {
2256       newColours = new java.awt.Color[23];
2257       for (int i = 0; i < 23; i++)
2258       {
2259         newColours[i] = new java.awt.Color(Integer.parseInt(colours
2260                 .getUserColourScheme().getColour(i + 24).getRGB(), 16));
2261       }
2262       ucs.setLowerCaseColours(newColours);
2263     }
2264
2265     return ucs;
2266   }
2267
2268   /**
2269    * contains last error message (if any) encountered by XML loader.
2270    */
2271   String errorMessage = null;
2272
2273   /**
2274    * flag to control whether the Jalview2XML_V1 parser should be deferred to if
2275    * exceptions are raised during project XML parsing
2276    */
2277   public boolean attemptversion1parse = true;
2278
2279   /**
2280    * Load a jalview project archive from a jar file
2281    *
2282    * @param file
2283    *          - HTTP URL or filename
2284    */
2285   public AlignFrame loadJalviewAlign(final String file)
2286   {
2287
2288     jalview.gui.AlignFrame af = null;
2289
2290     try
2291     {
2292       // create list to store references for any new Jmol viewers created
2293       newStructureViewers = new Vector<JalviewStructureDisplayI>();
2294       // UNMARSHALLER SEEMS TO CLOSE JARINPUTSTREAM, MOST ANNOYING
2295       // Workaround is to make sure caller implements the JarInputStreamProvider
2296       // interface
2297       // so we can re-open the jar input stream for each entry.
2298
2299       jarInputStreamProvider jprovider = createjarInputStreamProvider(file);
2300       af = loadJalviewAlign(jprovider);
2301
2302     } catch (MalformedURLException e)
2303     {
2304       errorMessage = "Invalid URL format for '" + file + "'";
2305       reportErrors();
2306     } finally
2307     {
2308       try
2309       {
2310         SwingUtilities.invokeAndWait(new Runnable()
2311         {
2312           @Override
2313           public void run()
2314           {
2315             setLoadingFinishedForNewStructureViewers();
2316           };
2317         });
2318       } catch (Exception x)
2319       {
2320         System.err.println("Error loading alignment: " + x.getMessage());
2321       }
2322     }
2323     return af;
2324   }
2325
2326   private jarInputStreamProvider createjarInputStreamProvider(
2327           final String file) throws MalformedURLException
2328   {
2329     URL url = null;
2330     errorMessage = null;
2331     uniqueSetSuffix = null;
2332     seqRefIds = null;
2333     viewportsAdded.clear();
2334     frefedSequence = null;
2335
2336     if (file.startsWith("http://"))
2337     {
2338       url = new URL(file);
2339     }
2340     final URL _url = url;
2341     return new jarInputStreamProvider()
2342     {
2343
2344       @Override
2345       public JarInputStream getJarInputStream() throws IOException
2346       {
2347         if (_url != null)
2348         {
2349           return new JarInputStream(_url.openStream());
2350         }
2351         else
2352         {
2353           return new JarInputStream(new FileInputStream(file));
2354         }
2355       }
2356
2357       @Override
2358       public String getFilename()
2359       {
2360         return file;
2361       }
2362     };
2363   }
2364
2365   /**
2366    * Recover jalview session from a jalview project archive. Caller may
2367    * initialise uniqueSetSuffix, seqRefIds, viewportsAdded and frefedSequence
2368    * themselves. Any null fields will be initialised with default values,
2369    * non-null fields are left alone.
2370    *
2371    * @param jprovider
2372    * @return
2373    */
2374   public AlignFrame loadJalviewAlign(final jarInputStreamProvider jprovider)
2375   {
2376     errorMessage = null;
2377     if (uniqueSetSuffix == null)
2378     {
2379       uniqueSetSuffix = System.currentTimeMillis() % 100000 + "";
2380     }
2381     if (seqRefIds == null)
2382     {
2383       initSeqRefs();
2384     }
2385     AlignFrame af = null, _af = null;
2386     IdentityHashMap<AlignmentI, AlignmentI> importedDatasets = new IdentityHashMap<AlignmentI, AlignmentI>();
2387     Map<String, AlignFrame> gatherToThisFrame = new HashMap<String, AlignFrame>();
2388     final String file = jprovider.getFilename();
2389     try
2390     {
2391       JarInputStream jin = null;
2392       JarEntry jarentry = null;
2393       int entryCount = 1;
2394
2395       do
2396       {
2397         jin = jprovider.getJarInputStream();
2398         for (int i = 0; i < entryCount; i++)
2399         {
2400           jarentry = jin.getNextJarEntry();
2401         }
2402
2403         if (jarentry != null && jarentry.getName().endsWith(".xml"))
2404         {
2405           InputStreamReader in = new InputStreamReader(jin, UTF_8);
2406           JalviewModel object = new JalviewModel();
2407
2408           Unmarshaller unmar = new Unmarshaller(object);
2409           unmar.setValidation(false);
2410           object = (JalviewModel) unmar.unmarshal(in);
2411           if (true) // !skipViewport(object))
2412           {
2413             _af = loadFromObject(object, file, true, jprovider);
2414             if (_af != null
2415                     && object.getJalviewModelSequence().getViewportCount() > 0)
2416             {
2417               if (af == null)
2418               {
2419                 // store a reference to the first view
2420                 af = _af;
2421               }
2422               if (_af.viewport.isGatherViewsHere())
2423               {
2424                 // if this is a gathered view, keep its reference since
2425                 // after gathering views, only this frame will remain
2426                 af = _af;
2427                 gatherToThisFrame.put(_af.viewport.getSequenceSetId(), _af);
2428               }
2429               // Save dataset to register mappings once all resolved
2430               importedDatasets.put(af.viewport.getAlignment().getDataset(),
2431                       af.viewport.getAlignment().getDataset());
2432             }
2433           }
2434           entryCount++;
2435         }
2436         else if (jarentry != null)
2437         {
2438           // Some other file here.
2439           entryCount++;
2440         }
2441       } while (jarentry != null);
2442       resolveFrefedSequences();
2443     } catch (IOException ex)
2444     {
2445       ex.printStackTrace();
2446       errorMessage = "Couldn't locate Jalview XML file : " + file;
2447       System.err.println("Exception whilst loading jalview XML file : "
2448               + ex + "\n");
2449     } catch (Exception ex)
2450     {
2451       System.err.println("Parsing as Jalview Version 2 file failed.");
2452       ex.printStackTrace(System.err);
2453       if (attemptversion1parse)
2454       {
2455         // Is Version 1 Jar file?
2456         try
2457         {
2458           af = new Jalview2XML_V1(raiseGUI).LoadJalviewAlign(jprovider);
2459         } catch (Exception ex2)
2460         {
2461           System.err.println("Exception whilst loading as jalviewXMLV1:");
2462           ex2.printStackTrace();
2463           af = null;
2464         }
2465       }
2466       if (Desktop.instance != null)
2467       {
2468         Desktop.instance.stopLoading();
2469       }
2470       if (af != null)
2471       {
2472         System.out.println("Successfully loaded archive file");
2473         return af;
2474       }
2475       ex.printStackTrace();
2476
2477       System.err.println("Exception whilst loading jalview XML file : "
2478               + ex + "\n");
2479     } catch (OutOfMemoryError e)
2480     {
2481       // Don't use the OOM Window here
2482       errorMessage = "Out of memory loading jalview XML file";
2483       System.err.println("Out of memory whilst loading jalview XML file");
2484       e.printStackTrace();
2485     }
2486
2487     /*
2488      * Regather multiple views (with the same sequence set id) to the frame (if
2489      * any) that is flagged as the one to gather to, i.e. convert them to tabbed
2490      * views instead of separate frames. Note this doesn't restore a state where
2491      * some expanded views in turn have tabbed views - the last "first tab" read
2492      * in will play the role of gatherer for all.
2493      */
2494     for (AlignFrame fr : gatherToThisFrame.values())
2495     {
2496       Desktop.instance.gatherViews(fr);
2497     }
2498
2499     restoreSplitFrames();
2500     for (AlignmentI ds : importedDatasets.keySet())
2501     {
2502       if (ds.getCodonFrames() != null)
2503       {
2504         StructureSelectionManager.getStructureSelectionManager(
2505                 Desktop.instance).registerMappings(ds.getCodonFrames());
2506       }
2507     }
2508     if (errorMessage != null)
2509     {
2510       reportErrors();
2511     }
2512
2513     if (Desktop.instance != null)
2514     {
2515       Desktop.instance.stopLoading();
2516     }
2517
2518     return af;
2519   }
2520
2521   /**
2522    * Try to reconstruct and display SplitFrame windows, where each contains
2523    * complementary dna and protein alignments. Done by pairing up AlignFrame
2524    * objects (created earlier) which have complementary viewport ids associated.
2525    */
2526   protected void restoreSplitFrames()
2527   {
2528     List<SplitFrame> gatherTo = new ArrayList<SplitFrame>();
2529     List<AlignFrame> addedToSplitFrames = new ArrayList<AlignFrame>();
2530     Map<String, AlignFrame> dna = new HashMap<String, AlignFrame>();
2531
2532     /*
2533      * Identify the DNA alignments
2534      */
2535     for (Entry<Viewport, AlignFrame> candidate : splitFrameCandidates
2536             .entrySet())
2537     {
2538       AlignFrame af = candidate.getValue();
2539       if (af.getViewport().getAlignment().isNucleotide())
2540       {
2541         dna.put(candidate.getKey().getId(), af);
2542       }
2543     }
2544
2545     /*
2546      * Try to match up the protein complements
2547      */
2548     for (Entry<Viewport, AlignFrame> candidate : splitFrameCandidates
2549             .entrySet())
2550     {
2551       AlignFrame af = candidate.getValue();
2552       if (!af.getViewport().getAlignment().isNucleotide())
2553       {
2554         String complementId = candidate.getKey().getComplementId();
2555         // only non-null complements should be in the Map
2556         if (complementId != null && dna.containsKey(complementId))
2557         {
2558           final AlignFrame dnaFrame = dna.get(complementId);
2559           SplitFrame sf = createSplitFrame(dnaFrame, af);
2560           addedToSplitFrames.add(dnaFrame);
2561           addedToSplitFrames.add(af);
2562           dnaFrame.setMenusForViewport();
2563           af.setMenusForViewport();
2564           if (af.viewport.isGatherViewsHere())
2565           {
2566             gatherTo.add(sf);
2567           }
2568         }
2569       }
2570     }
2571
2572     /*
2573      * Open any that we failed to pair up (which shouldn't happen!) as
2574      * standalone AlignFrame's.
2575      */
2576     for (Entry<Viewport, AlignFrame> candidate : splitFrameCandidates
2577             .entrySet())
2578     {
2579       AlignFrame af = candidate.getValue();
2580       if (!addedToSplitFrames.contains(af))
2581       {
2582         Viewport view = candidate.getKey();
2583         Desktop.addInternalFrame(af, view.getTitle(), view.getWidth(),
2584                 view.getHeight());
2585         af.setMenusForViewport();
2586         System.err.println("Failed to restore view " + view.getTitle()
2587                 + " to split frame");
2588       }
2589     }
2590
2591     /*
2592      * Gather back into tabbed views as flagged.
2593      */
2594     for (SplitFrame sf : gatherTo)
2595     {
2596       Desktop.instance.gatherViews(sf);
2597     }
2598
2599     splitFrameCandidates.clear();
2600   }
2601
2602   /**
2603    * Construct and display one SplitFrame holding DNA and protein alignments.
2604    *
2605    * @param dnaFrame
2606    * @param proteinFrame
2607    * @return
2608    */
2609   protected SplitFrame createSplitFrame(AlignFrame dnaFrame,
2610           AlignFrame proteinFrame)
2611   {
2612     SplitFrame splitFrame = new SplitFrame(dnaFrame, proteinFrame);
2613     String title = MessageManager.getString("label.linked_view_title");
2614     int width = (int) dnaFrame.getBounds().getWidth();
2615     int height = (int) (dnaFrame.getBounds().getHeight()
2616             + proteinFrame.getBounds().getHeight() + 50);
2617
2618     /*
2619      * SplitFrame location is saved to both enclosed frames
2620      */
2621     splitFrame.setLocation(dnaFrame.getX(), dnaFrame.getY());
2622     Desktop.addInternalFrame(splitFrame, title, width, height);
2623
2624     /*
2625      * And compute cDNA consensus (couldn't do earlier with consensus as
2626      * mappings were not yet present)
2627      */
2628     proteinFrame.viewport.alignmentChanged(proteinFrame.alignPanel);
2629
2630     return splitFrame;
2631   }
2632
2633   /**
2634    * check errorMessage for a valid error message and raise an error box in the
2635    * GUI or write the current errorMessage to stderr and then clear the error
2636    * state.
2637    */
2638   protected void reportErrors()
2639   {
2640     reportErrors(false);
2641   }
2642
2643   protected void reportErrors(final boolean saving)
2644   {
2645     if (errorMessage != null)
2646     {
2647       final String finalErrorMessage = errorMessage;
2648       if (raiseGUI)
2649       {
2650         javax.swing.SwingUtilities.invokeLater(new Runnable()
2651         {
2652           @Override
2653           public void run()
2654           {
2655             JvOptionPane
2656                     .showInternalMessageDialog(Desktop.desktop,
2657                             finalErrorMessage, "Error "
2658                                     + (saving ? "saving" : "loading")
2659                                     + " Jalview file",
2660                             JvOptionPane.WARNING_MESSAGE);
2661           }
2662         });
2663       }
2664       else
2665       {
2666         System.err.println("Problem loading Jalview file: " + errorMessage);
2667       }
2668     }
2669     errorMessage = null;
2670   }
2671
2672   Map<String, String> alreadyLoadedPDB = new HashMap<String, String>();
2673
2674   /**
2675    * when set, local views will be updated from view stored in JalviewXML
2676    * Currently (28th Sep 2008) things will go horribly wrong in vamsas document
2677    * sync if this is set to true.
2678    */
2679   private final boolean updateLocalViews = false;
2680
2681   /**
2682    * Returns the path to a temporary file holding the PDB file for the given PDB
2683    * id. The first time of asking, searches for a file of that name in the
2684    * Jalview project jar, and copies it to a new temporary file. Any repeat
2685    * requests just return the path to the file previously created.
2686    *
2687    * @param jprovider
2688    * @param pdbId
2689    * @return
2690    */
2691   String loadPDBFile(jarInputStreamProvider jprovider, String pdbId,
2692           String origFile)
2693   {
2694     if (alreadyLoadedPDB.containsKey(pdbId))
2695     {
2696       return alreadyLoadedPDB.get(pdbId).toString();
2697     }
2698
2699     String tempFile = copyJarEntry(jprovider, pdbId, "jalview_pdb",
2700             origFile);
2701     if (tempFile != null)
2702     {
2703       alreadyLoadedPDB.put(pdbId, tempFile);
2704     }
2705     return tempFile;
2706   }
2707
2708   /**
2709    * Copies the jar entry of given name to a new temporary file and returns the
2710    * path to the file, or null if the entry is not found.
2711    *
2712    * @param jprovider
2713    * @param jarEntryName
2714    * @param prefix
2715    *          a prefix for the temporary file name, must be at least three
2716    *          characters long
2717    * @param origFile
2718    *          null or original file - so new file can be given the same suffix
2719    *          as the old one
2720    * @return
2721    */
2722   protected String copyJarEntry(jarInputStreamProvider jprovider,
2723           String jarEntryName, String prefix, String origFile)
2724   {
2725     BufferedReader in = null;
2726     PrintWriter out = null;
2727     String suffix = ".tmp";
2728     if (origFile == null)
2729     {
2730       origFile = jarEntryName;
2731     }
2732     int sfpos = origFile.lastIndexOf(".");
2733     if (sfpos > -1 && sfpos < (origFile.length() - 3))
2734     {
2735       suffix = "." + origFile.substring(sfpos + 1);
2736     }
2737     try
2738     {
2739       JarInputStream jin = jprovider.getJarInputStream();
2740       /*
2741        * if (jprovider.startsWith("http://")) { jin = new JarInputStream(new
2742        * URL(jprovider).openStream()); } else { jin = new JarInputStream(new
2743        * FileInputStream(jprovider)); }
2744        */
2745
2746       JarEntry entry = null;
2747       do
2748       {
2749         entry = jin.getNextJarEntry();
2750       } while (entry != null && !entry.getName().equals(jarEntryName));
2751       if (entry != null)
2752       {
2753         in = new BufferedReader(new InputStreamReader(jin, UTF_8));
2754         File outFile = File.createTempFile(prefix, suffix);
2755         outFile.deleteOnExit();
2756         out = new PrintWriter(new FileOutputStream(outFile));
2757         String data;
2758
2759         while ((data = in.readLine()) != null)
2760         {
2761           out.println(data);
2762         }
2763         out.flush();
2764         String t = outFile.getAbsolutePath();
2765         return t;
2766       }
2767       else
2768       {
2769         warn("Couldn't find entry in Jalview Jar for " + jarEntryName);
2770       }
2771     } catch (Exception ex)
2772     {
2773       ex.printStackTrace();
2774     } finally
2775     {
2776       if (in != null)
2777       {
2778         try
2779         {
2780           in.close();
2781         } catch (IOException e)
2782         {
2783           // ignore
2784         }
2785       }
2786       if (out != null)
2787       {
2788         out.close();
2789       }
2790     }
2791
2792     return null;
2793   }
2794
2795   private class JvAnnotRow
2796   {
2797     public JvAnnotRow(int i, AlignmentAnnotation jaa)
2798     {
2799       order = i;
2800       template = jaa;
2801     }
2802
2803     /**
2804      * persisted version of annotation row from which to take vis properties
2805      */
2806     public jalview.datamodel.AlignmentAnnotation template;
2807
2808     /**
2809      * original position of the annotation row in the alignment
2810      */
2811     public int order;
2812   }
2813
2814   /**
2815    * Load alignment frame from jalview XML DOM object
2816    *
2817    * @param object
2818    *          DOM
2819    * @param file
2820    *          filename source string
2821    * @param loadTreesAndStructures
2822    *          when false only create Viewport
2823    * @param jprovider
2824    *          data source provider
2825    * @return alignment frame created from view stored in DOM
2826    */
2827   AlignFrame loadFromObject(JalviewModel object, String file,
2828           boolean loadTreesAndStructures, jarInputStreamProvider jprovider)
2829   {
2830     SequenceSet vamsasSet = object.getVamsasModel().getSequenceSet(0);
2831     Sequence[] vamsasSeq = vamsasSet.getSequence();
2832
2833     JalviewModelSequence jms = object.getJalviewModelSequence();
2834
2835     Viewport view = (jms.getViewportCount() > 0) ? jms.getViewport(0)
2836             : null;
2837
2838     // ////////////////////////////////
2839     // LOAD SEQUENCES
2840
2841     List<SequenceI> hiddenSeqs = null;
2842
2843     List<SequenceI> tmpseqs = new ArrayList<SequenceI>();
2844
2845     boolean multipleView = false;
2846     SequenceI referenceseqForView = null;
2847     JSeq[] jseqs = object.getJalviewModelSequence().getJSeq();
2848     int vi = 0; // counter in vamsasSeq array
2849     for (int i = 0; i < jseqs.length; i++)
2850     {
2851       String seqId = jseqs[i].getId();
2852
2853       SequenceI tmpSeq = seqRefIds.get(seqId);
2854       if (tmpSeq != null)
2855       {
2856         if (!incompleteSeqs.containsKey(seqId))
2857         {
2858           // may not need this check, but keep it for at least 2.9,1 release
2859           if (tmpSeq.getStart() != jseqs[i].getStart()
2860                   || tmpSeq.getEnd() != jseqs[i].getEnd())
2861           {
2862             System.err
2863                     .println("Warning JAL-2154 regression: updating start/end for sequence "
2864                             + tmpSeq.toString() + " to " + jseqs[i]);
2865           }
2866         }
2867         else
2868         {
2869           incompleteSeqs.remove(seqId);
2870         }
2871         if (vamsasSeq.length > vi && vamsasSeq[vi].getId().equals(seqId))
2872         {
2873           // most likely we are reading a dataset XML document so
2874           // update from vamsasSeq section of XML for this sequence
2875           tmpSeq.setName(vamsasSeq[vi].getName());
2876           tmpSeq.setDescription(vamsasSeq[vi].getDescription());
2877           tmpSeq.setSequence(vamsasSeq[vi].getSequence());
2878           vi++;
2879         }
2880         else
2881         {
2882           // reading multiple views, so vamsasSeq set is a subset of JSeq
2883           multipleView = true;
2884         }
2885         tmpSeq.setStart(jseqs[i].getStart());
2886         tmpSeq.setEnd(jseqs[i].getEnd());
2887         tmpseqs.add(tmpSeq);
2888       }
2889       else
2890       {
2891         tmpSeq = new jalview.datamodel.Sequence(vamsasSeq[vi].getName(),
2892                 vamsasSeq[vi].getSequence());
2893         tmpSeq.setDescription(vamsasSeq[vi].getDescription());
2894         tmpSeq.setStart(jseqs[i].getStart());
2895         tmpSeq.setEnd(jseqs[i].getEnd());
2896         tmpSeq.setVamsasId(uniqueSetSuffix + seqId);
2897         seqRefIds.put(vamsasSeq[vi].getId(), tmpSeq);
2898         tmpseqs.add(tmpSeq);
2899         vi++;
2900       }
2901
2902       if (jseqs[i].hasViewreference() && jseqs[i].getViewreference())
2903       {
2904         referenceseqForView = tmpseqs.get(tmpseqs.size() - 1);
2905       }
2906
2907       if (jseqs[i].getHidden())
2908       {
2909         if (hiddenSeqs == null)
2910         {
2911           hiddenSeqs = new ArrayList<SequenceI>();
2912         }
2913
2914         hiddenSeqs.add(tmpSeq);
2915       }
2916     }
2917
2918     // /
2919     // Create the alignment object from the sequence set
2920     // ///////////////////////////////
2921     SequenceI[] orderedSeqs = tmpseqs
2922             .toArray(new SequenceI[tmpseqs.size()]);
2923
2924     AlignmentI al = null;
2925     // so we must create or recover the dataset alignment before going further
2926     // ///////////////////////////////
2927     if (vamsasSet.getDatasetId() == null || vamsasSet.getDatasetId() == "")
2928     {
2929       // older jalview projects do not have a dataset - so creat alignment and
2930       // dataset
2931       al = new Alignment(orderedSeqs);
2932       al.setDataset(null);
2933     }
2934     else
2935     {
2936       boolean isdsal = object.getJalviewModelSequence().getViewportCount() == 0;
2937       if (isdsal)
2938       {
2939         // we are importing a dataset record, so
2940         // recover reference to an alignment already materialsed as dataset
2941         al = getDatasetFor(vamsasSet.getDatasetId());
2942       }
2943       if (al == null)
2944       {
2945         // materialse the alignment
2946         al = new Alignment(orderedSeqs);
2947       }
2948       if (isdsal)
2949       {
2950         addDatasetRef(vamsasSet.getDatasetId(), al);
2951       }
2952
2953       // finally, verify all data in vamsasSet is actually present in al
2954       // passing on flag indicating if it is actually a stored dataset
2955       recoverDatasetFor(vamsasSet, al, isdsal);
2956     }
2957
2958     if (referenceseqForView != null)
2959     {
2960       al.setSeqrep(referenceseqForView);
2961     }
2962     // / Add the alignment properties
2963     for (int i = 0; i < vamsasSet.getSequenceSetPropertiesCount(); i++)
2964     {
2965       SequenceSetProperties ssp = vamsasSet.getSequenceSetProperties(i);
2966       al.setProperty(ssp.getKey(), ssp.getValue());
2967     }
2968
2969     // ///////////////////////////////
2970
2971     Hashtable pdbloaded = new Hashtable(); // TODO nothing writes to this??
2972     if (!multipleView)
2973     {
2974       // load sequence features, database references and any associated PDB
2975       // structures for the alignment
2976       //
2977       // prior to 2.10, this part would only be executed the first time a
2978       // sequence was encountered, but not afterwards.
2979       // now, for 2.10 projects, this is also done if the xml doc includes
2980       // dataset sequences not actually present in any particular view.
2981       //
2982       for (int i = 0; i < vamsasSeq.length; i++)
2983       {
2984         if (jseqs[i].getFeaturesCount() > 0)
2985         {
2986           Features[] features = jseqs[i].getFeatures();
2987           for (int f = 0; f < features.length; f++)
2988           {
2989             jalview.datamodel.SequenceFeature sf = new jalview.datamodel.SequenceFeature(
2990                     features[f].getType(), features[f].getDescription(),
2991                     features[f].getStatus(), features[f].getBegin(),
2992                     features[f].getEnd(), features[f].getFeatureGroup());
2993
2994             sf.setScore(features[f].getScore());
2995             for (int od = 0; od < features[f].getOtherDataCount(); od++)
2996             {
2997               OtherData keyValue = features[f].getOtherData(od);
2998               if (keyValue.getKey().startsWith("LINK"))
2999               {
3000                 sf.addLink(keyValue.getValue());
3001               }
3002               else
3003               {
3004                 sf.setValue(keyValue.getKey(), keyValue.getValue());
3005               }
3006
3007             }
3008             // adds feature to datasequence's feature set (since Jalview 2.10)
3009             al.getSequenceAt(i).addSequenceFeature(sf);
3010           }
3011         }
3012         if (vamsasSeq[i].getDBRefCount() > 0)
3013         {
3014           // adds dbrefs to datasequence's set (since Jalview 2.10)
3015           addDBRefs(
3016                   al.getSequenceAt(i).getDatasetSequence() == null ? al.getSequenceAt(i)
3017                           : al.getSequenceAt(i).getDatasetSequence(),
3018                   vamsasSeq[i]);
3019         }
3020         if (jseqs[i].getPdbidsCount() > 0)
3021         {
3022           Pdbids[] ids = jseqs[i].getPdbids();
3023           for (int p = 0; p < ids.length; p++)
3024           {
3025             jalview.datamodel.PDBEntry entry = new jalview.datamodel.PDBEntry();
3026             entry.setId(ids[p].getId());
3027             if (ids[p].getType() != null)
3028             {
3029               if (PDBEntry.Type.getType(ids[p].getType()) != null)
3030               {
3031                 entry.setType(PDBEntry.Type.getType(ids[p].getType()));
3032               }
3033               else
3034               {
3035                 entry.setType(PDBEntry.Type.FILE);
3036               }
3037             }
3038             // jprovider is null when executing 'New View'
3039             if (ids[p].getFile() != null && jprovider != null)
3040             {
3041               if (!pdbloaded.containsKey(ids[p].getFile()))
3042               {
3043                 entry.setFile(loadPDBFile(jprovider, ids[p].getId(),
3044                         ids[p].getFile()));
3045               }
3046               else
3047               {
3048                 entry.setFile(pdbloaded.get(ids[p].getId()).toString());
3049               }
3050             }
3051             if (ids[p].getPdbentryItem() != null)
3052             {
3053               for (PdbentryItem item : ids[p].getPdbentryItem())
3054               {
3055                 for (Property pr : item.getProperty())
3056                 {
3057                   entry.setProperty(pr.getName(), pr.getValue());
3058                 }
3059               }
3060             }
3061             StructureSelectionManager.getStructureSelectionManager(
3062                     Desktop.instance).registerPDBEntry(entry);
3063             // adds PDBEntry to datasequence's set (since Jalview 2.10)
3064             if (al.getSequenceAt(i).getDatasetSequence() != null)
3065             {
3066               al.getSequenceAt(i).getDatasetSequence().addPDBId(entry);
3067             }
3068             else
3069             {
3070               al.getSequenceAt(i).addPDBId(entry);
3071             }
3072           }
3073         }
3074       }
3075     } // end !multipleview
3076
3077     // ///////////////////////////////
3078     // LOAD SEQUENCE MAPPINGS
3079
3080     if (vamsasSet.getAlcodonFrameCount() > 0)
3081     {
3082       // TODO Potentially this should only be done once for all views of an
3083       // alignment
3084       AlcodonFrame[] alc = vamsasSet.getAlcodonFrame();
3085       for (int i = 0; i < alc.length; i++)
3086       {
3087         AlignedCodonFrame cf = new AlignedCodonFrame();
3088         if (alc[i].getAlcodMapCount() > 0)
3089         {
3090           AlcodMap[] maps = alc[i].getAlcodMap();
3091           for (int m = 0; m < maps.length; m++)
3092           {
3093             SequenceI dnaseq = seqRefIds.get(maps[m].getDnasq());
3094             // Load Mapping
3095             jalview.datamodel.Mapping mapping = null;
3096             // attach to dna sequence reference.
3097             if (maps[m].getMapping() != null)
3098             {
3099               mapping = addMapping(maps[m].getMapping());
3100               if (dnaseq != null && mapping.getTo() != null)
3101               {
3102                 cf.addMap(dnaseq, mapping.getTo(), mapping.getMap());
3103               }
3104               else
3105               {
3106                 // defer to later
3107                 frefedSequence.add(newAlcodMapRef(maps[m].getDnasq(), cf,
3108                         mapping));
3109               }
3110             }
3111           }
3112           al.addCodonFrame(cf);
3113         }
3114       }
3115     }
3116
3117     // ////////////////////////////////
3118     // LOAD ANNOTATIONS
3119     List<JvAnnotRow> autoAlan = new ArrayList<JvAnnotRow>();
3120
3121     /*
3122      * store any annotations which forward reference a group's ID
3123      */
3124     Map<String, List<AlignmentAnnotation>> groupAnnotRefs = new Hashtable<String, List<AlignmentAnnotation>>();
3125
3126     if (vamsasSet.getAnnotationCount() > 0)
3127     {
3128       Annotation[] an = vamsasSet.getAnnotation();
3129
3130       for (int i = 0; i < an.length; i++)
3131       {
3132         Annotation annotation = an[i];
3133
3134         /**
3135          * test if annotation is automatically calculated for this view only
3136          */
3137         boolean autoForView = false;
3138         if (annotation.getLabel().equals("Quality")
3139                 || annotation.getLabel().equals("Conservation")
3140                 || annotation.getLabel().equals("Consensus"))
3141         {
3142           // Kludge for pre 2.5 projects which lacked the autocalculated flag
3143           autoForView = true;
3144           if (!annotation.hasAutoCalculated())
3145           {
3146             annotation.setAutoCalculated(true);
3147           }
3148         }
3149         if (autoForView
3150                 || (annotation.hasAutoCalculated() && annotation
3151                         .isAutoCalculated()))
3152         {
3153           // remove ID - we don't recover annotation from other views for
3154           // view-specific annotation
3155           annotation.setId(null);
3156         }
3157
3158         // set visiblity for other annotation in this view
3159         String annotationId = annotation.getId();
3160         if (annotationId != null && annotationIds.containsKey(annotationId))
3161         {
3162           AlignmentAnnotation jda = annotationIds.get(annotationId);
3163           // in principle Visible should always be true for annotation displayed
3164           // in multiple views
3165           if (annotation.hasVisible())
3166           {
3167             jda.visible = annotation.getVisible();
3168           }
3169
3170           al.addAnnotation(jda);
3171
3172           continue;
3173         }
3174         // Construct new annotation from model.
3175         AnnotationElement[] ae = annotation.getAnnotationElement();
3176         jalview.datamodel.Annotation[] anot = null;
3177         java.awt.Color firstColour = null;
3178         int anpos;
3179         if (!annotation.getScoreOnly())
3180         {
3181           anot = new jalview.datamodel.Annotation[al.getWidth()];
3182           for (int aa = 0; aa < ae.length && aa < anot.length; aa++)
3183           {
3184             anpos = ae[aa].getPosition();
3185
3186             if (anpos >= anot.length)
3187             {
3188               continue;
3189             }
3190
3191             anot[anpos] = new jalview.datamodel.Annotation(
3192
3193             ae[aa].getDisplayCharacter(), ae[aa].getDescription(),
3194                     (ae[aa].getSecondaryStructure() == null || ae[aa]
3195                             .getSecondaryStructure().length() == 0) ? ' '
3196                             : ae[aa].getSecondaryStructure().charAt(0),
3197                     ae[aa].getValue()
3198
3199             );
3200             // JBPNote: Consider verifying dataflow for IO of secondary
3201             // structure annotation read from Stockholm files
3202             // this was added to try to ensure that
3203             // if (anot[ae[aa].getPosition()].secondaryStructure>' ')
3204             // {
3205             // anot[ae[aa].getPosition()].displayCharacter = "";
3206             // }
3207             anot[anpos].colour = new java.awt.Color(ae[aa].getColour());
3208             if (firstColour == null)
3209             {
3210               firstColour = anot[anpos].colour;
3211             }
3212           }
3213         }
3214         jalview.datamodel.AlignmentAnnotation jaa = null;
3215
3216         if (annotation.getGraph())
3217         {
3218           float llim = 0, hlim = 0;
3219           // if (autoForView || an[i].isAutoCalculated()) {
3220           // hlim=11f;
3221           // }
3222           jaa = new jalview.datamodel.AlignmentAnnotation(
3223                   annotation.getLabel(), annotation.getDescription(), anot,
3224                   llim, hlim, annotation.getGraphType());
3225
3226           jaa.graphGroup = annotation.getGraphGroup();
3227           jaa._linecolour = firstColour;
3228           if (annotation.getThresholdLine() != null)
3229           {
3230             jaa.setThreshold(new jalview.datamodel.GraphLine(annotation
3231                     .getThresholdLine().getValue(), annotation
3232                     .getThresholdLine().getLabel(), new java.awt.Color(
3233                     annotation.getThresholdLine().getColour())));
3234
3235           }
3236           if (autoForView || annotation.isAutoCalculated())
3237           {
3238             // Hardwire the symbol display line to ensure that labels for
3239             // histograms are displayed
3240             jaa.hasText = true;
3241           }
3242         }
3243         else
3244         {
3245           jaa = new jalview.datamodel.AlignmentAnnotation(an[i].getLabel(),
3246                   an[i].getDescription(), anot);
3247           jaa._linecolour = firstColour;
3248         }
3249         // register new annotation
3250         if (an[i].getId() != null)
3251         {
3252           annotationIds.put(an[i].getId(), jaa);
3253           jaa.annotationId = an[i].getId();
3254         }
3255         // recover sequence association
3256         String sequenceRef = an[i].getSequenceRef();
3257         if (sequenceRef != null)
3258         {
3259           // from 2.9 sequenceRef is to sequence id (JAL-1781)
3260           SequenceI sequence = seqRefIds.get(sequenceRef);
3261           if (sequence == null)
3262           {
3263             // in pre-2.9 projects sequence ref is to sequence name
3264             sequence = al.findName(sequenceRef);
3265           }
3266           if (sequence != null)
3267           {
3268             jaa.createSequenceMapping(sequence, 1, true);
3269             sequence.addAlignmentAnnotation(jaa);
3270           }
3271         }
3272         // and make a note of any group association
3273         if (an[i].getGroupRef() != null && an[i].getGroupRef().length() > 0)
3274         {
3275           List<jalview.datamodel.AlignmentAnnotation> aal = groupAnnotRefs
3276                   .get(an[i].getGroupRef());
3277           if (aal == null)
3278           {
3279             aal = new ArrayList<jalview.datamodel.AlignmentAnnotation>();
3280             groupAnnotRefs.put(an[i].getGroupRef(), aal);
3281           }
3282           aal.add(jaa);
3283         }
3284
3285         if (an[i].hasScore())
3286         {
3287           jaa.setScore(an[i].getScore());
3288         }
3289         if (an[i].hasVisible())
3290         {
3291           jaa.visible = an[i].getVisible();
3292         }
3293
3294         if (an[i].hasCentreColLabels())
3295         {
3296           jaa.centreColLabels = an[i].getCentreColLabels();
3297         }
3298
3299         if (an[i].hasScaleColLabels())
3300         {
3301           jaa.scaleColLabel = an[i].getScaleColLabels();
3302         }
3303         if (an[i].hasAutoCalculated() && an[i].isAutoCalculated())
3304         {
3305           // newer files have an 'autoCalculated' flag and store calculation
3306           // state in viewport properties
3307           jaa.autoCalculated = true; // means annotation will be marked for
3308           // update at end of load.
3309         }
3310         if (an[i].hasGraphHeight())
3311         {
3312           jaa.graphHeight = an[i].getGraphHeight();
3313         }
3314         if (an[i].hasBelowAlignment())
3315         {
3316           jaa.belowAlignment = an[i].isBelowAlignment();
3317         }
3318         jaa.setCalcId(an[i].getCalcId());
3319         if (an[i].getPropertyCount() > 0)
3320         {
3321           for (jalview.schemabinding.version2.Property prop : an[i]
3322                   .getProperty())
3323           {
3324             jaa.setProperty(prop.getName(), prop.getValue());
3325           }
3326         }
3327         if (jaa.autoCalculated)
3328         {
3329           autoAlan.add(new JvAnnotRow(i, jaa));
3330         }
3331         else
3332         // if (!autoForView)
3333         {
3334           // add autocalculated group annotation and any user created annotation
3335           // for the view
3336           al.addAnnotation(jaa);
3337         }
3338       }
3339     }
3340     // ///////////////////////
3341     // LOAD GROUPS
3342     // Create alignment markup and styles for this view
3343     if (jms.getJGroupCount() > 0)
3344     {
3345       JGroup[] groups = jms.getJGroup();
3346       boolean addAnnotSchemeGroup = false;
3347       for (int i = 0; i < groups.length; i++)
3348       {
3349         JGroup jGroup = groups[i];
3350         ColourSchemeI cs = null;
3351         if (jGroup.getColour() != null)
3352         {
3353           if (jGroup.getColour().startsWith("ucs"))
3354           {
3355             cs = getUserColourScheme(jms, jGroup.getColour());
3356           }
3357           else if (jGroup.getColour().equals("AnnotationColourGradient")
3358                   && jGroup.getAnnotationColours() != null)
3359           {
3360             addAnnotSchemeGroup = true;
3361           }
3362           else
3363           {
3364             cs = ColourSchemeProperty.getColourScheme(al, jGroup.getColour());
3365           }
3366         }
3367         int pidThreshold = jGroup.getPidThreshold();
3368
3369         Vector<SequenceI> seqs = new Vector<SequenceI>();
3370
3371         for (int s = 0; s < jGroup.getSeqCount(); s++)
3372         {
3373           String seqId = jGroup.getSeq(s) + "";
3374           SequenceI ts = seqRefIds.get(seqId);
3375
3376           if (ts != null)
3377           {
3378             seqs.addElement(ts);
3379           }
3380         }
3381
3382         if (seqs.size() < 1)
3383         {
3384           continue;
3385         }
3386
3387         SequenceGroup sg = new SequenceGroup(seqs, jGroup.getName(), cs,
3388                 jGroup.getDisplayBoxes(), jGroup.getDisplayText(),
3389                 jGroup.getColourText(), jGroup.getStart(), jGroup.getEnd());
3390         sg.getGroupColourScheme().setThreshold(pidThreshold, true);
3391         sg.getGroupColourScheme().setConservationInc(jGroup.getConsThreshold());
3392         sg.setOutlineColour(new java.awt.Color(jGroup.getOutlineColour()));
3393
3394         sg.textColour = new java.awt.Color(jGroup.getTextCol1());
3395         sg.textColour2 = new java.awt.Color(jGroup.getTextCol2());
3396         sg.setShowNonconserved(jGroup.hasShowUnconserved() ? jGroup
3397                 .isShowUnconserved() : false);
3398         sg.thresholdTextColour = jGroup.getTextColThreshold();
3399         if (jGroup.hasShowConsensusHistogram())
3400         {
3401           sg.setShowConsensusHistogram(jGroup.isShowConsensusHistogram());
3402         }
3403         ;
3404         if (jGroup.hasShowSequenceLogo())
3405         {
3406           sg.setshowSequenceLogo(jGroup.isShowSequenceLogo());
3407         }
3408         if (jGroup.hasNormaliseSequenceLogo())
3409         {
3410           sg.setNormaliseSequenceLogo(jGroup.isNormaliseSequenceLogo());
3411         }
3412         if (jGroup.hasIgnoreGapsinConsensus())
3413         {
3414           sg.setIgnoreGapsConsensus(jGroup.getIgnoreGapsinConsensus());
3415         }
3416         if (jGroup.getConsThreshold() != 0)
3417         {
3418           Conservation c = new Conservation("All", sg.getSequences(null),
3419                   0, sg.getWidth() - 1);
3420           c.calculate();
3421           c.verdict(false, 25);
3422           sg.cs.setConservation(c);
3423         }
3424
3425         if (jGroup.getId() != null && groupAnnotRefs.size() > 0)
3426         {
3427           // re-instate unique group/annotation row reference
3428           List<AlignmentAnnotation> jaal = groupAnnotRefs.get(jGroup
3429                   .getId());
3430           if (jaal != null)
3431           {
3432             for (AlignmentAnnotation jaa : jaal)
3433             {
3434               jaa.groupRef = sg;
3435               if (jaa.autoCalculated)
3436               {
3437                 // match up and try to set group autocalc alignment row for this
3438                 // annotation
3439                 if (jaa.label.startsWith("Consensus for "))
3440                 {
3441                   sg.setConsensus(jaa);
3442                 }
3443                 // match up and try to set group autocalc alignment row for this
3444                 // annotation
3445                 if (jaa.label.startsWith("Conservation for "))
3446                 {
3447                   sg.setConservationRow(jaa);
3448                 }
3449               }
3450             }
3451           }
3452         }
3453         al.addGroup(sg);
3454         if (addAnnotSchemeGroup)
3455         {
3456           // reconstruct the annotation colourscheme
3457           sg.setColourScheme(constructAnnotationColour(
3458                   jGroup.getAnnotationColours(), null, al, jms, false));
3459         }
3460       }
3461     }
3462     if (view == null)
3463     {
3464       // only dataset in this model, so just return.
3465       return null;
3466     }
3467     // ///////////////////////////////
3468     // LOAD VIEWPORT
3469
3470     // If we just load in the same jar file again, the sequenceSetId
3471     // will be the same, and we end up with multiple references
3472     // to the same sequenceSet. We must modify this id on load
3473     // so that each load of the file gives a unique id
3474     String uniqueSeqSetId = view.getSequenceSetId() + uniqueSetSuffix;
3475     String viewId = (view.getId() == null ? null : view.getId()
3476             + uniqueSetSuffix);
3477     AlignFrame af = null;
3478     AlignViewport av = null;
3479     // now check to see if we really need to create a new viewport.
3480     if (multipleView && viewportsAdded.size() == 0)
3481     {
3482       // We recovered an alignment for which a viewport already exists.
3483       // TODO: fix up any settings necessary for overlaying stored state onto
3484       // state recovered from another document. (may not be necessary).
3485       // we may need a binding from a viewport in memory to one recovered from
3486       // XML.
3487       // and then recover its containing af to allow the settings to be applied.
3488       // TODO: fix for vamsas demo
3489       System.err
3490               .println("About to recover a viewport for existing alignment: Sequence set ID is "
3491                       + uniqueSeqSetId);
3492       Object seqsetobj = retrieveExistingObj(uniqueSeqSetId);
3493       if (seqsetobj != null)
3494       {
3495         if (seqsetobj instanceof String)
3496         {
3497           uniqueSeqSetId = (String) seqsetobj;
3498           System.err
3499                   .println("Recovered extant sequence set ID mapping for ID : New Sequence set ID is "
3500                           + uniqueSeqSetId);
3501         }
3502         else
3503         {
3504           System.err
3505                   .println("Warning : Collision between sequence set ID string and existing jalview object mapping.");
3506         }
3507
3508       }
3509     }
3510     /**
3511      * indicate that annotation colours are applied across all groups (pre
3512      * Jalview 2.8.1 behaviour)
3513      */
3514     boolean doGroupAnnColour = Jalview2XML.isVersionStringLaterThan(
3515             "2.8.1", object.getVersion());
3516
3517     AlignmentPanel ap = null;
3518     boolean isnewview = true;
3519     if (viewId != null)
3520     {
3521       // Check to see if this alignment already has a view id == viewId
3522       jalview.gui.AlignmentPanel views[] = Desktop
3523               .getAlignmentPanels(uniqueSeqSetId);
3524       if (views != null && views.length > 0)
3525       {
3526         for (int v = 0; v < views.length; v++)
3527         {
3528           if (views[v].av.getViewId().equalsIgnoreCase(viewId))
3529           {
3530             // recover the existing alignpanel, alignframe, viewport
3531             af = views[v].alignFrame;
3532             av = views[v].av;
3533             ap = views[v];
3534             // TODO: could even skip resetting view settings if we don't want to
3535             // change the local settings from other jalview processes
3536             isnewview = false;
3537           }
3538         }
3539       }
3540     }
3541
3542     if (isnewview)
3543     {
3544       af = loadViewport(file, jseqs, hiddenSeqs, al, jms, view,
3545               uniqueSeqSetId, viewId, autoAlan);
3546       av = af.viewport;
3547       ap = af.alignPanel;
3548     }
3549
3550     /*
3551      * Load any trees, PDB structures and viewers
3552      *
3553      * Not done if flag is false (when this method is used for New View)
3554      */
3555     if (loadTreesAndStructures)
3556     {
3557       loadTrees(jms, view, af, av, ap);
3558       loadPDBStructures(jprovider, jseqs, af, ap);
3559       loadRnaViewers(jprovider, jseqs, ap);
3560     }
3561     // and finally return.
3562     return af;
3563   }
3564
3565   /**
3566    * Instantiate and link any saved RNA (Varna) viewers. The state of the Varna
3567    * panel is restored from separate jar entries, two (gapped and trimmed) per
3568    * sequence and secondary structure.
3569    *
3570    * Currently each viewer shows just one sequence and structure (gapped and
3571    * trimmed), however this method is designed to support multiple sequences or
3572    * structures in viewers if wanted in future.
3573    *
3574    * @param jprovider
3575    * @param jseqs
3576    * @param ap
3577    */
3578   private void loadRnaViewers(jarInputStreamProvider jprovider,
3579           JSeq[] jseqs, AlignmentPanel ap)
3580   {
3581     /*
3582      * scan the sequences for references to viewers; create each one the first
3583      * time it is referenced, add Rna models to existing viewers
3584      */
3585     for (JSeq jseq : jseqs)
3586     {
3587       for (int i = 0; i < jseq.getRnaViewerCount(); i++)
3588       {
3589         RnaViewer viewer = jseq.getRnaViewer(i);
3590         AppVarna appVarna = findOrCreateVarnaViewer(viewer,
3591                 uniqueSetSuffix, ap);
3592
3593         for (int j = 0; j < viewer.getSecondaryStructureCount(); j++)
3594         {
3595           SecondaryStructure ss = viewer.getSecondaryStructure(j);
3596           SequenceI seq = seqRefIds.get(jseq.getId());
3597           AlignmentAnnotation ann = this.annotationIds.get(ss
3598                   .getAnnotationId());
3599
3600           /*
3601            * add the structure to the Varna display (with session state copied
3602            * from the jar to a temporary file)
3603            */
3604           boolean gapped = ss.isGapped();
3605           String rnaTitle = ss.getTitle();
3606           String sessionState = ss.getViewerState();
3607           String tempStateFile = copyJarEntry(jprovider, sessionState,
3608                   "varna", null);
3609           RnaModel rna = new RnaModel(rnaTitle, ann, seq, null, gapped);
3610           appVarna.addModelSession(rna, rnaTitle, tempStateFile);
3611         }
3612         appVarna.setInitialSelection(viewer.getSelectedRna());
3613       }
3614     }
3615   }
3616
3617   /**
3618    * Locate and return an already instantiated matching AppVarna, or create one
3619    * if not found
3620    *
3621    * @param viewer
3622    * @param viewIdSuffix
3623    * @param ap
3624    * @return
3625    */
3626   protected AppVarna findOrCreateVarnaViewer(RnaViewer viewer,
3627           String viewIdSuffix, AlignmentPanel ap)
3628   {
3629     /*
3630      * on each load a suffix is appended to the saved viewId, to avoid conflicts
3631      * if load is repeated
3632      */
3633     String postLoadId = viewer.getViewId() + viewIdSuffix;
3634     for (JInternalFrame frame : getAllFrames())
3635     {
3636       if (frame instanceof AppVarna)
3637       {
3638         AppVarna varna = (AppVarna) frame;
3639         if (postLoadId.equals(varna.getViewId()))
3640         {
3641           // this viewer is already instantiated
3642           // could in future here add ap as another 'parent' of the
3643           // AppVarna window; currently just 1-to-many
3644           return varna;
3645         }
3646       }
3647     }
3648
3649     /*
3650      * viewer not found - make it
3651      */
3652     RnaViewerModel model = new RnaViewerModel(postLoadId,
3653             viewer.getTitle(), viewer.getXpos(), viewer.getYpos(),
3654             viewer.getWidth(), viewer.getHeight(),
3655             viewer.getDividerLocation());
3656     AppVarna varna = new AppVarna(model, ap);
3657
3658     return varna;
3659   }
3660
3661   /**
3662    * Load any saved trees
3663    *
3664    * @param jms
3665    * @param view
3666    * @param af
3667    * @param av
3668    * @param ap
3669    */
3670   protected void loadTrees(JalviewModelSequence jms, Viewport view,
3671           AlignFrame af, AlignViewport av, AlignmentPanel ap)
3672   {
3673     // TODO result of automated refactoring - are all these parameters needed?
3674     try
3675     {
3676       for (int t = 0; t < jms.getTreeCount(); t++)
3677       {
3678
3679         Tree tree = jms.getTree(t);
3680
3681         TreePanel tp = (TreePanel) retrieveExistingObj(tree.getId());
3682         if (tp == null)
3683         {
3684           tp = af.ShowNewickTree(
3685                   new jalview.io.NewickFile(tree.getNewick()),
3686                   tree.getTitle(), tree.getWidth(), tree.getHeight(),
3687                   tree.getXpos(), tree.getYpos());
3688           if (tree.getId() != null)
3689           {
3690             // perhaps bind the tree id to something ?
3691           }
3692         }
3693         else
3694         {
3695           // update local tree attributes ?
3696           // TODO: should check if tp has been manipulated by user - if so its
3697           // settings shouldn't be modified
3698           tp.setTitle(tree.getTitle());
3699           tp.setBounds(new Rectangle(tree.getXpos(), tree.getYpos(), tree
3700                   .getWidth(), tree.getHeight()));
3701           tp.av = av; // af.viewport; // TODO: verify 'associate with all
3702           // views'
3703           // works still
3704           tp.treeCanvas.av = av; // af.viewport;
3705           tp.treeCanvas.ap = ap; // af.alignPanel;
3706
3707         }
3708         if (tp == null)
3709         {
3710           warn("There was a problem recovering stored Newick tree: \n"
3711                   + tree.getNewick());
3712           continue;
3713         }
3714
3715         tp.fitToWindow.setState(tree.getFitToWindow());
3716         tp.fitToWindow_actionPerformed(null);
3717
3718         if (tree.getFontName() != null)
3719         {
3720           tp.setTreeFont(new java.awt.Font(tree.getFontName(), tree
3721                   .getFontStyle(), tree.getFontSize()));
3722         }
3723         else
3724         {
3725           tp.setTreeFont(new java.awt.Font(view.getFontName(), view
3726                   .getFontStyle(), tree.getFontSize()));
3727         }
3728
3729         tp.showPlaceholders(tree.getMarkUnlinked());
3730         tp.showBootstrap(tree.getShowBootstrap());
3731         tp.showDistances(tree.getShowDistances());
3732
3733         tp.treeCanvas.threshold = tree.getThreshold();
3734
3735         if (tree.getCurrentTree())
3736         {
3737           af.viewport.setCurrentTree(tp.getTree());
3738         }
3739       }
3740
3741     } catch (Exception ex)
3742     {
3743       ex.printStackTrace();
3744     }
3745   }
3746
3747   /**
3748    * Load and link any saved structure viewers.
3749    *
3750    * @param jprovider
3751    * @param jseqs
3752    * @param af
3753    * @param ap
3754    */
3755   protected void loadPDBStructures(jarInputStreamProvider jprovider,
3756           JSeq[] jseqs, AlignFrame af, AlignmentPanel ap)
3757   {
3758     /*
3759      * Run through all PDB ids on the alignment, and collect mappings between
3760      * distinct view ids and all sequences referring to that view.
3761      */
3762     Map<String, StructureViewerModel> structureViewers = new LinkedHashMap<String, StructureViewerModel>();
3763
3764     for (int i = 0; i < jseqs.length; i++)
3765     {
3766       if (jseqs[i].getPdbidsCount() > 0)
3767       {
3768         Pdbids[] ids = jseqs[i].getPdbids();
3769         for (int p = 0; p < ids.length; p++)
3770         {
3771           final int structureStateCount = ids[p].getStructureStateCount();
3772           for (int s = 0; s < structureStateCount; s++)
3773           {
3774             // check to see if we haven't already created this structure view
3775             final StructureState structureState = ids[p]
3776                     .getStructureState(s);
3777             String sviewid = (structureState.getViewId() == null) ? null
3778                     : structureState.getViewId() + uniqueSetSuffix;
3779             jalview.datamodel.PDBEntry jpdb = new jalview.datamodel.PDBEntry();
3780             // Originally : ids[p].getFile()
3781             // : TODO: verify external PDB file recovery still works in normal
3782             // jalview project load
3783             jpdb.setFile(loadPDBFile(jprovider, ids[p].getId(),
3784                     ids[p].getFile()));
3785             jpdb.setId(ids[p].getId());
3786
3787             int x = structureState.getXpos();
3788             int y = structureState.getYpos();
3789             int width = structureState.getWidth();
3790             int height = structureState.getHeight();
3791
3792             // Probably don't need to do this anymore...
3793             // Desktop.desktop.getComponentAt(x, y);
3794             // TODO: NOW: check that this recovers the PDB file correctly.
3795             String pdbFile = loadPDBFile(jprovider, ids[p].getId(),
3796                     ids[p].getFile());
3797             jalview.datamodel.SequenceI seq = seqRefIds.get(jseqs[i]
3798                     .getId() + "");
3799             if (sviewid == null)
3800             {
3801               sviewid = "_jalview_pre2_4_" + x + "," + y + "," + width
3802                       + "," + height;
3803             }
3804             if (!structureViewers.containsKey(sviewid))
3805             {
3806               structureViewers.put(sviewid,
3807                       new StructureViewerModel(x, y, width, height, false,
3808                               false, true, structureState.getViewId(),
3809                               structureState.getType()));
3810               // Legacy pre-2.7 conversion JAL-823 :
3811               // do not assume any view has to be linked for colour by
3812               // sequence
3813             }
3814
3815             // assemble String[] { pdb files }, String[] { id for each
3816             // file }, orig_fileloc, SequenceI[][] {{ seqs_file 1 }, {
3817             // seqs_file 2}, boolean[] {
3818             // linkAlignPanel,superposeWithAlignpanel}} from hash
3819             StructureViewerModel jmoldat = structureViewers.get(sviewid);
3820             jmoldat.setAlignWithPanel(jmoldat.isAlignWithPanel()
3821                     | (structureState.hasAlignwithAlignPanel() ? structureState
3822                             .getAlignwithAlignPanel() : false));
3823
3824             /*
3825              * Default colour by linked panel to false if not specified (e.g.
3826              * for pre-2.7 projects)
3827              */
3828             boolean colourWithAlignPanel = jmoldat.isColourWithAlignPanel();
3829             colourWithAlignPanel |= (structureState
3830                     .hasColourwithAlignPanel() ? structureState
3831                     .getColourwithAlignPanel() : false);
3832             jmoldat.setColourWithAlignPanel(colourWithAlignPanel);
3833
3834             /*
3835              * Default colour by viewer to true if not specified (e.g. for
3836              * pre-2.7 projects)
3837              */
3838             boolean colourByViewer = jmoldat.isColourByViewer();
3839             colourByViewer &= structureState.hasColourByJmol() ? structureState
3840                     .getColourByJmol() : true;
3841             jmoldat.setColourByViewer(colourByViewer);
3842
3843             if (jmoldat.getStateData().length() < structureState
3844                     .getContent().length())
3845             {
3846               {
3847                 jmoldat.setStateData(structureState.getContent());
3848               }
3849             }
3850             if (ids[p].getFile() != null)
3851             {
3852               File mapkey = new File(ids[p].getFile());
3853               StructureData seqstrmaps = jmoldat.getFileData().get(mapkey);
3854               if (seqstrmaps == null)
3855               {
3856                 jmoldat.getFileData().put(
3857                         mapkey,
3858                         seqstrmaps = jmoldat.new StructureData(pdbFile,
3859                                 ids[p].getId()));
3860               }
3861               if (!seqstrmaps.getSeqList().contains(seq))
3862               {
3863                 seqstrmaps.getSeqList().add(seq);
3864                 // TODO and chains?
3865               }
3866             }
3867             else
3868             {
3869               errorMessage = ("The Jmol views in this project were imported\nfrom an older version of Jalview.\nPlease review the sequence colour associations\nin the Colour by section of the Jmol View menu.\n\nIn the case of problems, see note at\nhttp://issues.jalview.org/browse/JAL-747");
3870               warn(errorMessage);
3871             }
3872           }
3873         }
3874       }
3875     }
3876     // Instantiate the associated structure views
3877     for (Entry<String, StructureViewerModel> entry : structureViewers
3878             .entrySet())
3879     {
3880       try
3881       {
3882         createOrLinkStructureViewer(entry, af, ap, jprovider);
3883       } catch (Exception e)
3884       {
3885         System.err.println("Error loading structure viewer: "
3886                 + e.getMessage());
3887         // failed - try the next one
3888       }
3889     }
3890   }
3891
3892   /**
3893    *
3894    * @param viewerData
3895    * @param af
3896    * @param ap
3897    * @param jprovider
3898    */
3899   protected void createOrLinkStructureViewer(
3900           Entry<String, StructureViewerModel> viewerData, AlignFrame af,
3901           AlignmentPanel ap, jarInputStreamProvider jprovider)
3902   {
3903     final StructureViewerModel stateData = viewerData.getValue();
3904
3905     /*
3906      * Search for any viewer windows already open from other alignment views
3907      * that exactly match the stored structure state
3908      */
3909     StructureViewerBase comp = findMatchingViewer(viewerData);
3910
3911     if (comp != null)
3912     {
3913       linkStructureViewer(ap, comp, stateData);
3914       return;
3915     }
3916
3917     /*
3918      * From 2.9: stateData.type contains JMOL or CHIMERA, data is in jar entry
3919      * "viewer_"+stateData.viewId
3920      */
3921     if (ViewerType.CHIMERA.toString().equals(stateData.getType()))
3922     {
3923       createChimeraViewer(viewerData, af, jprovider);
3924     }
3925     else
3926     {
3927       /*
3928        * else Jmol (if pre-2.9, stateData contains JMOL state string)
3929        */
3930       createJmolViewer(viewerData, af, jprovider);
3931     }
3932   }
3933
3934   /**
3935    * Create a new Chimera viewer.
3936    *
3937    * @param data
3938    * @param af
3939    * @param jprovider
3940    */
3941   protected void createChimeraViewer(
3942           Entry<String, StructureViewerModel> viewerData, AlignFrame af,
3943           jarInputStreamProvider jprovider)
3944   {
3945     StructureViewerModel data = viewerData.getValue();
3946     String chimeraSessionFile = data.getStateData();
3947
3948     /*
3949      * Copy Chimera session from jar entry "viewer_"+viewId to a temporary file
3950      *
3951      * NB this is the 'saved' viewId as in the project file XML, _not_ the
3952      * 'uniquified' sviewid used to reconstruct the viewer here
3953      */
3954     String viewerJarEntryName = getViewerJarEntryName(data.getViewId());
3955     chimeraSessionFile = copyJarEntry(jprovider, viewerJarEntryName,
3956             "chimera", null);
3957
3958     Set<Entry<File, StructureData>> fileData = data.getFileData()
3959             .entrySet();
3960     List<PDBEntry> pdbs = new ArrayList<PDBEntry>();
3961     List<SequenceI[]> allseqs = new ArrayList<SequenceI[]>();
3962     for (Entry<File, StructureData> pdb : fileData)
3963     {
3964       String filePath = pdb.getValue().getFilePath();
3965       String pdbId = pdb.getValue().getPdbId();
3966       // pdbs.add(new PDBEntry(filePath, pdbId));
3967       pdbs.add(new PDBEntry(pdbId, null, PDBEntry.Type.PDB, filePath));
3968       final List<SequenceI> seqList = pdb.getValue().getSeqList();
3969       SequenceI[] seqs = seqList.toArray(new SequenceI[seqList.size()]);
3970       allseqs.add(seqs);
3971     }
3972
3973     boolean colourByChimera = data.isColourByViewer();
3974     boolean colourBySequence = data.isColourWithAlignPanel();
3975
3976     // TODO use StructureViewer as a factory here, see JAL-1761
3977     final PDBEntry[] pdbArray = pdbs.toArray(new PDBEntry[pdbs.size()]);
3978     final SequenceI[][] seqsArray = allseqs.toArray(new SequenceI[allseqs
3979             .size()][]);
3980     String newViewId = viewerData.getKey();
3981
3982     ChimeraViewFrame cvf = new ChimeraViewFrame(chimeraSessionFile,
3983             af.alignPanel, pdbArray, seqsArray, colourByChimera,
3984             colourBySequence, newViewId);
3985     cvf.setSize(data.getWidth(), data.getHeight());
3986     cvf.setLocation(data.getX(), data.getY());
3987   }
3988
3989   /**
3990    * Create a new Jmol window. First parse the Jmol state to translate filenames
3991    * loaded into the view, and record the order in which files are shown in the
3992    * Jmol view, so we can add the sequence mappings in same order.
3993    *
3994    * @param viewerData
3995    * @param af
3996    * @param jprovider
3997    */
3998   protected void createJmolViewer(
3999           final Entry<String, StructureViewerModel> viewerData,
4000           AlignFrame af, jarInputStreamProvider jprovider)
4001   {
4002     final StructureViewerModel svattrib = viewerData.getValue();
4003     String state = svattrib.getStateData();
4004
4005     /*
4006      * Pre-2.9: state element value is the Jmol state string
4007      *
4008      * 2.9+: @type is "JMOL", state data is in a Jar file member named "viewer_"
4009      * + viewId
4010      */
4011     if (ViewerType.JMOL.toString().equals(svattrib.getType()))
4012     {
4013       state = readJarEntry(jprovider,
4014               getViewerJarEntryName(svattrib.getViewId()));
4015     }
4016
4017     List<String> pdbfilenames = new ArrayList<String>();
4018     List<SequenceI[]> seqmaps = new ArrayList<SequenceI[]>();
4019     List<String> pdbids = new ArrayList<String>();
4020     StringBuilder newFileLoc = new StringBuilder(64);
4021     int cp = 0, ncp, ecp;
4022     Map<File, StructureData> oldFiles = svattrib.getFileData();
4023     while ((ncp = state.indexOf("load ", cp)) > -1)
4024     {
4025       do
4026       {
4027         // look for next filename in load statement
4028         newFileLoc.append(state.substring(cp,
4029                 ncp = (state.indexOf("\"", ncp + 1) + 1)));
4030         String oldfilenam = state.substring(ncp,
4031                 ecp = state.indexOf("\"", ncp));
4032         // recover the new mapping data for this old filename
4033         // have to normalize filename - since Jmol and jalview do
4034         // filename
4035         // translation differently.
4036         StructureData filedat = oldFiles.get(new File(oldfilenam));
4037         if (filedat == null)
4038         {
4039           String reformatedOldFilename = oldfilenam.replaceAll("/", "\\\\");
4040           filedat = oldFiles.get(new File(reformatedOldFilename));
4041         }
4042         newFileLoc.append(Platform.escapeString(filedat.getFilePath()));
4043         pdbfilenames.add(filedat.getFilePath());
4044         pdbids.add(filedat.getPdbId());
4045         seqmaps.add(filedat.getSeqList().toArray(new SequenceI[0]));
4046         newFileLoc.append("\"");
4047         cp = ecp + 1; // advance beyond last \" and set cursor so we can
4048                       // look for next file statement.
4049       } while ((ncp = state.indexOf("/*file*/", cp)) > -1);
4050     }
4051     if (cp > 0)
4052     {
4053       // just append rest of state
4054       newFileLoc.append(state.substring(cp));
4055     }
4056     else
4057     {
4058       System.err.print("Ignoring incomplete Jmol state for PDB ids: ");
4059       newFileLoc = new StringBuilder(state);
4060       newFileLoc.append("; load append ");
4061       for (File id : oldFiles.keySet())
4062       {
4063         // add this and any other pdb files that should be present in
4064         // the viewer
4065         StructureData filedat = oldFiles.get(id);
4066         newFileLoc.append(filedat.getFilePath());
4067         pdbfilenames.add(filedat.getFilePath());
4068         pdbids.add(filedat.getPdbId());
4069         seqmaps.add(filedat.getSeqList().toArray(new SequenceI[0]));
4070         newFileLoc.append(" \"");
4071         newFileLoc.append(filedat.getFilePath());
4072         newFileLoc.append("\"");
4073
4074       }
4075       newFileLoc.append(";");
4076     }
4077
4078     if (newFileLoc.length() == 0)
4079     {
4080       return;
4081     }
4082     int histbug = newFileLoc.indexOf("history = ");
4083     if (histbug > -1)
4084     {
4085       /*
4086        * change "history = [true|false];" to "history = [1|0];"
4087        */
4088       histbug += 10;
4089       int diff = histbug == -1 ? -1 : newFileLoc.indexOf(";", histbug);
4090       String val = (diff == -1) ? null : newFileLoc
4091               .substring(histbug, diff);
4092       if (val != null && val.length() >= 4)
4093       {
4094         if (val.contains("e")) // eh? what can it be?
4095         {
4096           if (val.trim().equals("true"))
4097           {
4098             val = "1";
4099           }
4100           else
4101           {
4102             val = "0";
4103           }
4104           newFileLoc.replace(histbug, diff, val);
4105         }
4106       }
4107     }
4108
4109     final String[] pdbf = pdbfilenames.toArray(new String[pdbfilenames
4110             .size()]);
4111     final String[] id = pdbids.toArray(new String[pdbids.size()]);
4112     final SequenceI[][] sq = seqmaps
4113             .toArray(new SequenceI[seqmaps.size()][]);
4114     final String fileloc = newFileLoc.toString();
4115     final String sviewid = viewerData.getKey();
4116     final AlignFrame alf = af;
4117     final Rectangle rect = new Rectangle(svattrib.getX(), svattrib.getY(),
4118             svattrib.getWidth(), svattrib.getHeight());
4119     try
4120     {
4121       javax.swing.SwingUtilities.invokeAndWait(new Runnable()
4122       {
4123         @Override
4124         public void run()
4125         {
4126           JalviewStructureDisplayI sview = null;
4127           try
4128           {
4129             sview = new StructureViewer(alf.alignPanel
4130                     .getStructureSelectionManager()).createView(
4131                     StructureViewer.ViewerType.JMOL, pdbf, id, sq,
4132                     alf.alignPanel, svattrib, fileloc, rect, sviewid);
4133             addNewStructureViewer(sview);
4134           } catch (OutOfMemoryError ex)
4135           {
4136             new OOMWarning("restoring structure view for PDB id " + id,
4137                     (OutOfMemoryError) ex.getCause());
4138             if (sview != null && sview.isVisible())
4139             {
4140               sview.closeViewer(false);
4141               sview.setVisible(false);
4142               sview.dispose();
4143             }
4144           }
4145         }
4146       });
4147     } catch (InvocationTargetException ex)
4148     {
4149       warn("Unexpected error when opening Jmol view.", ex);
4150
4151     } catch (InterruptedException e)
4152     {
4153       // e.printStackTrace();
4154     }
4155
4156   }
4157
4158   /**
4159    * Generates a name for the entry in the project jar file to hold state
4160    * information for a structure viewer
4161    *
4162    * @param viewId
4163    * @return
4164    */
4165   protected String getViewerJarEntryName(String viewId)
4166   {
4167     return VIEWER_PREFIX + viewId;
4168   }
4169
4170   /**
4171    * Returns any open frame that matches given structure viewer data. The match
4172    * is based on the unique viewId, or (for older project versions) the frame's
4173    * geometry.
4174    *
4175    * @param viewerData
4176    * @return
4177    */
4178   protected StructureViewerBase findMatchingViewer(
4179           Entry<String, StructureViewerModel> viewerData)
4180   {
4181     final String sviewid = viewerData.getKey();
4182     final StructureViewerModel svattrib = viewerData.getValue();
4183     StructureViewerBase comp = null;
4184     JInternalFrame[] frames = getAllFrames();
4185     for (JInternalFrame frame : frames)
4186     {
4187       if (frame instanceof StructureViewerBase)
4188       {
4189         /*
4190          * Post jalview 2.4 schema includes structure view id
4191          */
4192         if (sviewid != null
4193                 && ((StructureViewerBase) frame).getViewId()
4194                         .equals(sviewid))
4195         {
4196           comp = (StructureViewerBase) frame;
4197           break; // break added in 2.9
4198         }
4199         /*
4200          * Otherwise test for matching position and size of viewer frame
4201          */
4202         else if (frame.getX() == svattrib.getX()
4203                 && frame.getY() == svattrib.getY()
4204                 && frame.getHeight() == svattrib.getHeight()
4205                 && frame.getWidth() == svattrib.getWidth())
4206         {
4207           comp = (StructureViewerBase) frame;
4208           // no break in faint hope of an exact match on viewId
4209         }
4210       }
4211     }
4212     return comp;
4213   }
4214
4215   /**
4216    * Link an AlignmentPanel to an existing structure viewer.
4217    *
4218    * @param ap
4219    * @param viewer
4220    * @param oldFiles
4221    * @param useinViewerSuperpos
4222    * @param usetoColourbyseq
4223    * @param viewerColouring
4224    */
4225   protected void linkStructureViewer(AlignmentPanel ap,
4226           StructureViewerBase viewer, StructureViewerModel stateData)
4227   {
4228     // NOTE: if the jalview project is part of a shared session then
4229     // view synchronization should/could be done here.
4230
4231     final boolean useinViewerSuperpos = stateData.isAlignWithPanel();
4232     final boolean usetoColourbyseq = stateData.isColourWithAlignPanel();
4233     final boolean viewerColouring = stateData.isColourByViewer();
4234     Map<File, StructureData> oldFiles = stateData.getFileData();
4235
4236     /*
4237      * Add mapping for sequences in this view to an already open viewer
4238      */
4239     final AAStructureBindingModel binding = viewer.getBinding();
4240     for (File id : oldFiles.keySet())
4241     {
4242       // add this and any other pdb files that should be present in the
4243       // viewer
4244       StructureData filedat = oldFiles.get(id);
4245       String pdbFile = filedat.getFilePath();
4246       SequenceI[] seq = filedat.getSeqList().toArray(new SequenceI[0]);
4247       binding.getSsm().setMapping(seq, null, pdbFile, DataSourceType.FILE);
4248       binding.addSequenceForStructFile(pdbFile, seq);
4249     }
4250     // and add the AlignmentPanel's reference to the view panel
4251     viewer.addAlignmentPanel(ap);
4252     if (useinViewerSuperpos)
4253     {
4254       viewer.useAlignmentPanelForSuperposition(ap);
4255     }
4256     else
4257     {
4258       viewer.excludeAlignmentPanelForSuperposition(ap);
4259     }
4260     if (usetoColourbyseq)
4261     {
4262       viewer.useAlignmentPanelForColourbyseq(ap, !viewerColouring);
4263     }
4264     else
4265     {
4266       viewer.excludeAlignmentPanelForColourbyseq(ap);
4267     }
4268   }
4269
4270   /**
4271    * Get all frames within the Desktop.
4272    *
4273    * @return
4274    */
4275   protected JInternalFrame[] getAllFrames()
4276   {
4277     JInternalFrame[] frames = null;
4278     // TODO is this necessary - is it safe - risk of hanging?
4279     do
4280     {
4281       try
4282       {
4283         frames = Desktop.desktop.getAllFrames();
4284       } catch (ArrayIndexOutOfBoundsException e)
4285       {
4286         // occasional No such child exceptions are thrown here...
4287         try
4288         {
4289           Thread.sleep(10);
4290         } catch (InterruptedException f)
4291         {
4292         }
4293       }
4294     } while (frames == null);
4295     return frames;
4296   }
4297
4298   /**
4299    * Answers true if 'version' is equal to or later than 'supported', where each
4300    * is formatted as major/minor versions like "2.8.3" or "2.3.4b1" for bugfix
4301    * changes. Development and test values for 'version' are leniently treated
4302    * i.e. answer true.
4303    *
4304    * @param supported
4305    *          - minimum version we are comparing against
4306    * @param version
4307    *          - version of data being processsed
4308    * @return
4309    */
4310   public static boolean isVersionStringLaterThan(String supported,
4311           String version)
4312   {
4313     if (supported == null || version == null
4314             || version.equalsIgnoreCase("DEVELOPMENT BUILD")
4315             || version.equalsIgnoreCase("Test")
4316             || version.equalsIgnoreCase("AUTOMATED BUILD"))
4317     {
4318       System.err.println("Assuming project file with "
4319               + (version == null ? "null" : version)
4320               + " is compatible with Jalview version " + supported);
4321       return true;
4322     }
4323     else
4324     {
4325       return StringUtils.compareVersions(version, supported, "b") >= 0;
4326     }
4327   }
4328
4329   Vector<JalviewStructureDisplayI> newStructureViewers = null;
4330
4331   protected void addNewStructureViewer(JalviewStructureDisplayI sview)
4332   {
4333     if (newStructureViewers != null)
4334     {
4335       sview.getBinding().setFinishedLoadingFromArchive(false);
4336       newStructureViewers.add(sview);
4337     }
4338   }
4339
4340   protected void setLoadingFinishedForNewStructureViewers()
4341   {
4342     if (newStructureViewers != null)
4343     {
4344       for (JalviewStructureDisplayI sview : newStructureViewers)
4345       {
4346         sview.getBinding().setFinishedLoadingFromArchive(true);
4347       }
4348       newStructureViewers.clear();
4349       newStructureViewers = null;
4350     }
4351   }
4352
4353   AlignFrame loadViewport(String file, JSeq[] JSEQ,
4354           List<SequenceI> hiddenSeqs, AlignmentI al,
4355           JalviewModelSequence jms, Viewport view, String uniqueSeqSetId,
4356           String viewId, List<JvAnnotRow> autoAlan)
4357   {
4358     AlignFrame af = null;
4359     af = new AlignFrame(al, view.getWidth(), view.getHeight(),
4360             uniqueSeqSetId, viewId);
4361
4362     af.setFileName(file, FileFormat.Jalview);
4363
4364     for (int i = 0; i < JSEQ.length; i++)
4365     {
4366       af.viewport.setSequenceColour(af.viewport.getAlignment()
4367               .getSequenceAt(i), new java.awt.Color(JSEQ[i].getColour()));
4368     }
4369
4370     if (al.hasSeqrep())
4371     {
4372       af.getViewport().setColourByReferenceSeq(true);
4373       af.getViewport().setDisplayReferenceSeq(true);
4374     }
4375
4376     af.viewport.setGatherViewsHere(view.getGatheredViews());
4377
4378     if (view.getSequenceSetId() != null)
4379     {
4380       AlignmentViewport av = viewportsAdded.get(uniqueSeqSetId);
4381
4382       af.viewport.setSequenceSetId(uniqueSeqSetId);
4383       if (av != null)
4384       {
4385         // propagate shared settings to this new view
4386         af.viewport.setHistoryList(av.getHistoryList());
4387         af.viewport.setRedoList(av.getRedoList());
4388       }
4389       else
4390       {
4391         viewportsAdded.put(uniqueSeqSetId, af.viewport);
4392       }
4393       // TODO: check if this method can be called repeatedly without
4394       // side-effects if alignpanel already registered.
4395       PaintRefresher.Register(af.alignPanel, uniqueSeqSetId);
4396     }
4397     // apply Hidden regions to view.
4398     if (hiddenSeqs != null)
4399     {
4400       for (int s = 0; s < JSEQ.length; s++)
4401       {
4402         SequenceGroup hidden = new SequenceGroup();
4403         boolean isRepresentative = false;
4404         for (int r = 0; r < JSEQ[s].getHiddenSequencesCount(); r++)
4405         {
4406           isRepresentative = true;
4407           SequenceI sequenceToHide = al.getSequenceAt(JSEQ[s]
4408                   .getHiddenSequences(r));
4409           hidden.addSequence(sequenceToHide, false);
4410           // remove from hiddenSeqs list so we don't try to hide it twice
4411           hiddenSeqs.remove(sequenceToHide);
4412         }
4413         if (isRepresentative)
4414         {
4415           SequenceI representativeSequence = al.getSequenceAt(s);
4416           hidden.addSequence(representativeSequence, false);
4417           af.viewport.hideRepSequences(representativeSequence, hidden);
4418         }
4419       }
4420
4421       SequenceI[] hseqs = hiddenSeqs.toArray(new SequenceI[hiddenSeqs
4422               .size()]);
4423       af.viewport.hideSequence(hseqs);
4424
4425     }
4426     // recover view properties and display parameters
4427     if (view.getViewName() != null)
4428     {
4429       af.viewport.viewName = view.getViewName();
4430       af.setInitialTabVisible();
4431     }
4432     af.setBounds(view.getXpos(), view.getYpos(), view.getWidth(),
4433             view.getHeight());
4434
4435     af.viewport.setShowAnnotation(view.getShowAnnotation());
4436     af.viewport.setAbovePIDThreshold(view.getPidSelected());
4437     af.viewport.setThreshold(view.getPidThreshold());
4438
4439     af.viewport.setColourText(view.getShowColourText());
4440
4441     af.viewport.setConservationSelected(view.getConservationSelected());
4442     af.viewport.setIncrement(view.getConsThreshold());
4443     af.viewport.setShowJVSuffix(view.getShowFullId());
4444     af.viewport.setRightAlignIds(view.getRightAlignIds());
4445     af.viewport.setFont(
4446             new java.awt.Font(view.getFontName(), view.getFontStyle(), view
4447                     .getFontSize()), true);
4448     ViewStyleI vs = af.viewport.getViewStyle();
4449     vs.setScaleProteinAsCdna(view.isScaleProteinAsCdna());
4450     af.viewport.setViewStyle(vs);
4451     // TODO: allow custom charWidth/Heights to be restored by updating them
4452     // after setting font - which means set above to false
4453     af.viewport.setRenderGaps(view.getRenderGaps());
4454     af.viewport.setWrapAlignment(view.getWrapAlignment());
4455     af.viewport.setShowAnnotation(view.getShowAnnotation());
4456
4457     af.viewport.setShowBoxes(view.getShowBoxes());
4458
4459     af.viewport.setShowText(view.getShowText());
4460
4461     af.viewport.setTextColour(new java.awt.Color(view.getTextCol1()));
4462     af.viewport.setTextColour2(new java.awt.Color(view.getTextCol2()));
4463     af.viewport.setThresholdTextColour(view.getTextColThreshold());
4464     af.viewport.setShowUnconserved(view.hasShowUnconserved() ? view
4465             .isShowUnconserved() : false);
4466     af.viewport.getRanges().setStartRes(view.getStartRes());
4467     af.viewport.getRanges().setStartSeq(view.getStartSeq());
4468     af.alignPanel.updateLayout();
4469     ColourSchemeI cs = null;
4470     // apply colourschemes
4471     if (view.getBgColour() != null)
4472     {
4473       if (view.getBgColour().startsWith("ucs"))
4474       {
4475         cs = getUserColourScheme(jms, view.getBgColour());
4476       }
4477       else if (view.getBgColour().startsWith("Annotation"))
4478       {
4479         AnnotationColours viewAnnColour = view.getAnnotationColours();
4480         cs = constructAnnotationColour(viewAnnColour, af, al, jms, true);
4481
4482         // annpos
4483
4484       }
4485       else
4486       {
4487         cs = ColourSchemeProperty.getColourScheme(al, view.getBgColour());
4488       }
4489     }
4490
4491     af.viewport.setGlobalColourScheme(cs);
4492     af.viewport.getResidueShading().setThreshold(
4493             view.getPidThreshold(), true);
4494     af.viewport.getResidueShading().setConsensus(
4495             af.viewport.getSequenceConsensusHash());
4496     af.viewport.setColourAppliesToAllGroups(false);
4497
4498     if (view.getConservationSelected() && cs != null)
4499     {
4500       af.viewport.getResidueShading().setConservationInc(
4501               view.getConsThreshold());
4502     }
4503
4504     af.changeColour(cs);
4505
4506     af.viewport.setColourAppliesToAllGroups(true);
4507
4508     af.viewport.setShowSequenceFeatures(view.getShowSequenceFeatures());
4509
4510     if (view.hasCentreColumnLabels())
4511     {
4512       af.viewport.setCentreColumnLabels(view.getCentreColumnLabels());
4513     }
4514     if (view.hasIgnoreGapsinConsensus())
4515     {
4516       af.viewport.setIgnoreGapsConsensus(view.getIgnoreGapsinConsensus(),
4517               null);
4518     }
4519     if (view.hasFollowHighlight())
4520     {
4521       af.viewport.setFollowHighlight(view.getFollowHighlight());
4522     }
4523     if (view.hasFollowSelection())
4524     {
4525       af.viewport.followSelection = view.getFollowSelection();
4526     }
4527     if (view.hasShowConsensusHistogram())
4528     {
4529       af.viewport.setShowConsensusHistogram(view
4530               .getShowConsensusHistogram());
4531     }
4532     else
4533     {
4534       af.viewport.setShowConsensusHistogram(true);
4535     }
4536     if (view.hasShowSequenceLogo())
4537     {
4538       af.viewport.setShowSequenceLogo(view.getShowSequenceLogo());
4539     }
4540     else
4541     {
4542       af.viewport.setShowSequenceLogo(false);
4543     }
4544     if (view.hasNormaliseSequenceLogo())
4545     {
4546       af.viewport.setNormaliseSequenceLogo(view.getNormaliseSequenceLogo());
4547     }
4548     if (view.hasShowDbRefTooltip())
4549     {
4550       af.viewport.setShowDBRefs(view.getShowDbRefTooltip());
4551     }
4552     if (view.hasShowNPfeatureTooltip())
4553     {
4554       af.viewport.setShowNPFeats(view.hasShowNPfeatureTooltip());
4555     }
4556     if (view.hasShowGroupConsensus())
4557     {
4558       af.viewport.setShowGroupConsensus(view.getShowGroupConsensus());
4559     }
4560     else
4561     {
4562       af.viewport.setShowGroupConsensus(false);
4563     }
4564     if (view.hasShowGroupConservation())
4565     {
4566       af.viewport.setShowGroupConservation(view.getShowGroupConservation());
4567     }
4568     else
4569     {
4570       af.viewport.setShowGroupConservation(false);
4571     }
4572
4573     // recover featre settings
4574     if (jms.getFeatureSettings() != null)
4575     {
4576       FeaturesDisplayed fdi;
4577       af.viewport.setFeaturesDisplayed(fdi = new FeaturesDisplayed());
4578       String[] renderOrder = new String[jms.getFeatureSettings()
4579               .getSettingCount()];
4580       Map<String, FeatureColourI> featureColours = new Hashtable<String, FeatureColourI>();
4581       Map<String, Float> featureOrder = new Hashtable<String, Float>();
4582
4583       for (int fs = 0; fs < jms.getFeatureSettings().getSettingCount(); fs++)
4584       {
4585         Setting setting = jms.getFeatureSettings().getSetting(fs);
4586         if (setting.hasMincolour())
4587         {
4588           FeatureColourI gc = setting.hasMin() ? new FeatureColour(
4589                   new Color(setting.getMincolour()), new Color(
4590                           setting.getColour()), setting.getMin(),
4591                   setting.getMax()) : new FeatureColour(new Color(
4592                   setting.getMincolour()), new Color(setting.getColour()),
4593                   0, 1);
4594           if (setting.hasThreshold())
4595           {
4596             gc.setThreshold(setting.getThreshold());
4597             int threshstate = setting.getThreshstate();
4598             // -1 = None, 0 = Below, 1 = Above threshold
4599             if (threshstate == 0)
4600             {
4601               gc.setBelowThreshold(true);
4602             }
4603             else if (threshstate == 1)
4604             {
4605               gc.setAboveThreshold(true);
4606             }
4607           }
4608           gc.setAutoScaled(true); // default
4609           if (setting.hasAutoScale())
4610           {
4611             gc.setAutoScaled(setting.getAutoScale());
4612           }
4613           if (setting.hasColourByLabel())
4614           {
4615             gc.setColourByLabel(setting.getColourByLabel());
4616           }
4617           // and put in the feature colour table.
4618           featureColours.put(setting.getType(), gc);
4619         }
4620         else
4621         {
4622           featureColours.put(setting.getType(), new FeatureColour(
4623                   new Color(setting.getColour())));
4624         }
4625         renderOrder[fs] = setting.getType();
4626         if (setting.hasOrder())
4627         {
4628           featureOrder.put(setting.getType(), setting.getOrder());
4629         }
4630         else
4631         {
4632           featureOrder.put(setting.getType(), new Float(fs
4633                   / jms.getFeatureSettings().getSettingCount()));
4634         }
4635         if (setting.getDisplay())
4636         {
4637           fdi.setVisible(setting.getType());
4638         }
4639       }
4640       Map<String, Boolean> fgtable = new Hashtable<String, Boolean>();
4641       for (int gs = 0; gs < jms.getFeatureSettings().getGroupCount(); gs++)
4642       {
4643         Group grp = jms.getFeatureSettings().getGroup(gs);
4644         fgtable.put(grp.getName(), new Boolean(grp.getDisplay()));
4645       }
4646       // FeatureRendererSettings frs = new FeatureRendererSettings(renderOrder,
4647       // fgtable, featureColours, jms.getFeatureSettings().hasTransparency() ?
4648       // jms.getFeatureSettings().getTransparency() : 0.0, featureOrder);
4649       FeatureRendererSettings frs = new FeatureRendererSettings(
4650               renderOrder, fgtable, featureColours, 1.0f, featureOrder);
4651       af.alignPanel.getSeqPanel().seqCanvas.getFeatureRenderer()
4652               .transferSettings(frs);
4653
4654     }
4655
4656     if (view.getHiddenColumnsCount() > 0)
4657     {
4658       for (int c = 0; c < view.getHiddenColumnsCount(); c++)
4659       {
4660         af.viewport.hideColumns(view.getHiddenColumns(c).getStart(), view
4661                 .getHiddenColumns(c).getEnd() // +1
4662                 );
4663       }
4664     }
4665     if (view.getCalcIdParam() != null)
4666     {
4667       for (CalcIdParam calcIdParam : view.getCalcIdParam())
4668       {
4669         if (calcIdParam != null)
4670         {
4671           if (recoverCalcIdParam(calcIdParam, af.viewport))
4672           {
4673           }
4674           else
4675           {
4676             warn("Couldn't recover parameters for "
4677                     + calcIdParam.getCalcId());
4678           }
4679         }
4680       }
4681     }
4682     af.setMenusFromViewport(af.viewport);
4683     af.setTitle(view.getTitle());
4684     // TODO: we don't need to do this if the viewport is aready visible.
4685     /*
4686      * Add the AlignFrame to the desktop (it may be 'gathered' later), unless it
4687      * has a 'cdna/protein complement' view, in which case save it in order to
4688      * populate a SplitFrame once all views have been read in.
4689      */
4690     String complementaryViewId = view.getComplementId();
4691     if (complementaryViewId == null)
4692     {
4693       Desktop.addInternalFrame(af, view.getTitle(), view.getWidth(),
4694               view.getHeight());
4695       // recompute any autoannotation
4696       af.alignPanel.updateAnnotation(false, true);
4697       reorderAutoannotation(af, al, autoAlan);
4698       af.alignPanel.alignmentChanged();
4699     }
4700     else
4701     {
4702       splitFrameCandidates.put(view, af);
4703     }
4704     return af;
4705   }
4706
4707   /**
4708    * Reads saved data to restore Colour by Annotation settings
4709    *
4710    * @param viewAnnColour
4711    * @param af
4712    * @param al
4713    * @param jms
4714    * @param checkGroupAnnColour
4715    * @return
4716    */
4717   private ColourSchemeI constructAnnotationColour(
4718           AnnotationColours viewAnnColour, AlignFrame af, AlignmentI al,
4719           JalviewModelSequence jms, boolean checkGroupAnnColour)
4720   {
4721     boolean propagateAnnColour = false;
4722     AlignmentI annAlignment = af != null ? af.viewport.getAlignment() : al;
4723     if (checkGroupAnnColour && al.getGroups() != null
4724             && al.getGroups().size() > 0)
4725     {
4726       // pre 2.8.1 behaviour
4727       // check to see if we should transfer annotation colours
4728       propagateAnnColour = true;
4729       for (SequenceGroup sg : al.getGroups())
4730       {
4731         if (sg.getColourScheme() instanceof AnnotationColourGradient)
4732         {
4733           propagateAnnColour = false;
4734         }
4735       }
4736     }
4737
4738     /*
4739      * 2.10.2- : saved annotationId is AlignmentAnnotation.annotationId
4740      */
4741     String annotationId = viewAnnColour.getAnnotation();
4742     AlignmentAnnotation matchedAnnotation = annotationIds.get(annotationId);
4743
4744     /*
4745      * pre 2.10.2: saved annotationId is AlignmentAnnotation.label
4746      */
4747     if (matchedAnnotation == null && annAlignment.getAlignmentAnnotation() != null)
4748     {
4749       for (int i = 0; i < annAlignment.getAlignmentAnnotation().length; i++)
4750       {
4751         if (annotationId
4752                 .equals(annAlignment.getAlignmentAnnotation()[i].label))
4753         {
4754           matchedAnnotation = annAlignment.getAlignmentAnnotation()[i];
4755           break;
4756         }
4757       }
4758     }
4759     if (matchedAnnotation == null)
4760     {
4761       System.err.println("Failed to match annotation colour scheme for "
4762               + annotationId);
4763       return null;
4764     }
4765     if (matchedAnnotation.getThreshold() == null)
4766     {
4767       matchedAnnotation.setThreshold(new GraphLine(viewAnnColour.getThreshold(),
4768               "Threshold", Color.black));
4769     }
4770
4771     AnnotationColourGradient cs = null;
4772     if (viewAnnColour.getColourScheme().equals("None"))
4773     {
4774       cs = new AnnotationColourGradient(matchedAnnotation, new Color(
4775               viewAnnColour.getMinColour()), new Color(
4776               viewAnnColour.getMaxColour()),
4777               viewAnnColour.getAboveThreshold());
4778     }
4779     else if (viewAnnColour.getColourScheme().startsWith("ucs"))
4780     {
4781       cs = new AnnotationColourGradient(matchedAnnotation, getUserColourScheme(
4782               jms, viewAnnColour.getColourScheme()),
4783               viewAnnColour.getAboveThreshold());
4784     }
4785     else
4786     {
4787       cs = new AnnotationColourGradient(matchedAnnotation,
4788               ColourSchemeProperty.getColourScheme(al,
4789                       viewAnnColour.getColourScheme()),
4790               viewAnnColour.getAboveThreshold());
4791     }
4792
4793     boolean perSequenceOnly = viewAnnColour.isPerSequence();
4794     boolean useOriginalColours = viewAnnColour.isPredefinedColours();
4795     cs.setSeqAssociated(perSequenceOnly);
4796     cs.setPredefinedColours(useOriginalColours);
4797
4798     if (propagateAnnColour && al.getGroups() != null)
4799     {
4800       // Also use these settings for all the groups
4801       for (int g = 0; g < al.getGroups().size(); g++)
4802       {
4803         SequenceGroup sg = al.getGroups().get(g);
4804         if (sg.getGroupColourScheme() == null)
4805         {
4806           continue;
4807         }
4808
4809         AnnotationColourGradient groupScheme = new AnnotationColourGradient(
4810                 matchedAnnotation, sg.getColourScheme(),
4811                 viewAnnColour.getAboveThreshold());
4812         sg.setColourScheme(groupScheme);
4813         groupScheme.setSeqAssociated(perSequenceOnly);
4814         groupScheme.setPredefinedColours(useOriginalColours);
4815       }
4816     }
4817     return cs;
4818   }
4819
4820   private void reorderAutoannotation(AlignFrame af, AlignmentI al,
4821           List<JvAnnotRow> autoAlan)
4822   {
4823     // copy over visualization settings for autocalculated annotation in the
4824     // view
4825     if (al.getAlignmentAnnotation() != null)
4826     {
4827       /**
4828        * Kludge for magic autoannotation names (see JAL-811)
4829        */
4830       String[] magicNames = new String[] { "Consensus", "Quality",
4831           "Conservation" };
4832       JvAnnotRow nullAnnot = new JvAnnotRow(-1, null);
4833       Hashtable<String, JvAnnotRow> visan = new Hashtable<String, JvAnnotRow>();
4834       for (String nm : magicNames)
4835       {
4836         visan.put(nm, nullAnnot);
4837       }
4838       for (JvAnnotRow auan : autoAlan)
4839       {
4840         visan.put(auan.template.label
4841                 + (auan.template.getCalcId() == null ? "" : "\t"
4842                         + auan.template.getCalcId()), auan);
4843       }
4844       int hSize = al.getAlignmentAnnotation().length;
4845       List<JvAnnotRow> reorder = new ArrayList<JvAnnotRow>();
4846       // work through any autoCalculated annotation already on the view
4847       // removing it if it should be placed in a different location on the
4848       // annotation panel.
4849       List<String> remains = new ArrayList<String>(visan.keySet());
4850       for (int h = 0; h < hSize; h++)
4851       {
4852         jalview.datamodel.AlignmentAnnotation jalan = al
4853                 .getAlignmentAnnotation()[h];
4854         if (jalan.autoCalculated)
4855         {
4856           String k;
4857           JvAnnotRow valan = visan.get(k = jalan.label);
4858           if (jalan.getCalcId() != null)
4859           {
4860             valan = visan.get(k = jalan.label + "\t" + jalan.getCalcId());
4861           }
4862
4863           if (valan != null)
4864           {
4865             // delete the auto calculated row from the alignment
4866             al.deleteAnnotation(jalan, false);
4867             remains.remove(k);
4868             hSize--;
4869             h--;
4870             if (valan != nullAnnot)
4871             {
4872               if (jalan != valan.template)
4873               {
4874                 // newly created autoannotation row instance
4875                 // so keep a reference to the visible annotation row
4876                 // and copy over all relevant attributes
4877                 if (valan.template.graphHeight >= 0)
4878
4879                 {
4880                   jalan.graphHeight = valan.template.graphHeight;
4881                 }
4882                 jalan.visible = valan.template.visible;
4883               }
4884               reorder.add(new JvAnnotRow(valan.order, jalan));
4885             }
4886           }
4887         }
4888       }
4889       // Add any (possibly stale) autocalculated rows that were not appended to
4890       // the view during construction
4891       for (String other : remains)
4892       {
4893         JvAnnotRow othera = visan.get(other);
4894         if (othera != nullAnnot && othera.template.getCalcId() != null
4895                 && othera.template.getCalcId().length() > 0)
4896         {
4897           reorder.add(othera);
4898         }
4899       }
4900       // now put the automatic annotation in its correct place
4901       int s = 0, srt[] = new int[reorder.size()];
4902       JvAnnotRow[] rws = new JvAnnotRow[reorder.size()];
4903       for (JvAnnotRow jvar : reorder)
4904       {
4905         rws[s] = jvar;
4906         srt[s++] = jvar.order;
4907       }
4908       reorder.clear();
4909       jalview.util.QuickSort.sort(srt, rws);
4910       // and re-insert the annotation at its correct position
4911       for (JvAnnotRow jvar : rws)
4912       {
4913         al.addAnnotation(jvar.template, jvar.order);
4914       }
4915       af.alignPanel.adjustAnnotationHeight();
4916     }
4917   }
4918
4919   Hashtable skipList = null;
4920
4921   /**
4922    * TODO remove this method
4923    *
4924    * @param view
4925    * @return AlignFrame bound to sequenceSetId from view, if one exists. private
4926    *         AlignFrame getSkippedFrame(Viewport view) { if (skipList==null) {
4927    *         throw new Error("Implementation Error. No skipList defined for this
4928    *         Jalview2XML instance."); } return (AlignFrame)
4929    *         skipList.get(view.getSequenceSetId()); }
4930    */
4931
4932   /**
4933    * Check if the Jalview view contained in object should be skipped or not.
4934    *
4935    * @param object
4936    * @return true if view's sequenceSetId is a key in skipList
4937    */
4938   private boolean skipViewport(JalviewModel object)
4939   {
4940     if (skipList == null)
4941     {
4942       return false;
4943     }
4944     String id;
4945     if (skipList.containsKey(id = object.getJalviewModelSequence()
4946             .getViewport()[0].getSequenceSetId()))
4947     {
4948       if (Cache.log != null && Cache.log.isDebugEnabled())
4949       {
4950         Cache.log.debug("Skipping seuqence set id " + id);
4951       }
4952       return true;
4953     }
4954     return false;
4955   }
4956
4957   public void addToSkipList(AlignFrame af)
4958   {
4959     if (skipList == null)
4960     {
4961       skipList = new Hashtable();
4962     }
4963     skipList.put(af.getViewport().getSequenceSetId(), af);
4964   }
4965
4966   public void clearSkipList()
4967   {
4968     if (skipList != null)
4969     {
4970       skipList.clear();
4971       skipList = null;
4972     }
4973   }
4974
4975   private void recoverDatasetFor(SequenceSet vamsasSet, AlignmentI al,
4976           boolean ignoreUnrefed)
4977   {
4978     jalview.datamodel.AlignmentI ds = getDatasetFor(vamsasSet
4979             .getDatasetId());
4980     Vector dseqs = null;
4981     if (ds == null)
4982     {
4983       // create a list of new dataset sequences
4984       dseqs = new Vector();
4985     }
4986     for (int i = 0, iSize = vamsasSet.getSequenceCount(); i < iSize; i++)
4987     {
4988       Sequence vamsasSeq = vamsasSet.getSequence(i);
4989       ensureJalviewDatasetSequence(vamsasSeq, ds, dseqs, ignoreUnrefed, i);
4990     }
4991     // create a new dataset
4992     if (ds == null)
4993     {
4994       SequenceI[] dsseqs = new SequenceI[dseqs.size()];
4995       dseqs.copyInto(dsseqs);
4996       ds = new jalview.datamodel.Alignment(dsseqs);
4997       debug("Created new dataset " + vamsasSet.getDatasetId()
4998               + " for alignment " + System.identityHashCode(al));
4999       addDatasetRef(vamsasSet.getDatasetId(), ds);
5000     }
5001     // set the dataset for the newly imported alignment.
5002     if (al.getDataset() == null && !ignoreUnrefed)
5003     {
5004       al.setDataset(ds);
5005     }
5006   }
5007
5008   /**
5009    *
5010    * @param vamsasSeq
5011    *          sequence definition to create/merge dataset sequence for
5012    * @param ds
5013    *          dataset alignment
5014    * @param dseqs
5015    *          vector to add new dataset sequence to
5016    * @param ignoreUnrefed
5017    *          - when true, don't create new sequences from vamsasSeq if it's id
5018    *          doesn't already have an asssociated Jalview sequence.
5019    * @param vseqpos
5020    *          - used to reorder the sequence in the alignment according to the
5021    *          vamsasSeq array ordering, to preserve ordering of dataset
5022    */
5023   private void ensureJalviewDatasetSequence(Sequence vamsasSeq,
5024           AlignmentI ds, Vector dseqs, boolean ignoreUnrefed, int vseqpos)
5025   {
5026     // JBP TODO: Check this is called for AlCodonFrames to support recovery of
5027     // xRef Codon Maps
5028     SequenceI sq = seqRefIds.get(vamsasSeq.getId());
5029     boolean reorder = false;
5030     SequenceI dsq = null;
5031     if (sq != null && sq.getDatasetSequence() != null)
5032     {
5033       dsq = sq.getDatasetSequence();
5034     }
5035     else
5036     {
5037       reorder = true;
5038     }
5039     if (sq == null && ignoreUnrefed)
5040     {
5041       return;
5042     }
5043     String sqid = vamsasSeq.getDsseqid();
5044     if (dsq == null)
5045     {
5046       // need to create or add a new dataset sequence reference to this sequence
5047       if (sqid != null)
5048       {
5049         dsq = seqRefIds.get(sqid);
5050       }
5051       // check again
5052       if (dsq == null)
5053       {
5054         // make a new dataset sequence
5055         dsq = sq.createDatasetSequence();
5056         if (sqid == null)
5057         {
5058           // make up a new dataset reference for this sequence
5059           sqid = seqHash(dsq);
5060         }
5061         dsq.setVamsasId(uniqueSetSuffix + sqid);
5062         seqRefIds.put(sqid, dsq);
5063         if (ds == null)
5064         {
5065           if (dseqs != null)
5066           {
5067             dseqs.addElement(dsq);
5068           }
5069         }
5070         else
5071         {
5072           ds.addSequence(dsq);
5073         }
5074       }
5075       else
5076       {
5077         if (sq != dsq)
5078         { // make this dataset sequence sq's dataset sequence
5079           sq.setDatasetSequence(dsq);
5080           // and update the current dataset alignment
5081           if (ds == null)
5082           {
5083             if (dseqs != null)
5084             {
5085               if (!dseqs.contains(dsq))
5086               {
5087                 dseqs.add(dsq);
5088               }
5089             }
5090             else
5091             {
5092               if (ds.findIndex(dsq) < 0)
5093               {
5094                 ds.addSequence(dsq);
5095               }
5096             }
5097           }
5098         }
5099       }
5100     }
5101     // TODO: refactor this as a merge dataset sequence function
5102     // now check that sq (the dataset sequence) sequence really is the union of
5103     // all references to it
5104     // boolean pre = sq.getStart() < dsq.getStart();
5105     // boolean post = sq.getEnd() > dsq.getEnd();
5106     // if (pre || post)
5107     if (sq != dsq)
5108     {
5109       // StringBuffer sb = new StringBuffer();
5110       String newres = jalview.analysis.AlignSeq.extractGaps(
5111               jalview.util.Comparison.GapChars, sq.getSequenceAsString());
5112       if (!newres.equalsIgnoreCase(dsq.getSequenceAsString())
5113               && newres.length() > dsq.getLength())
5114       {
5115         // Update with the longer sequence.
5116         synchronized (dsq)
5117         {
5118           /*
5119            * if (pre) { sb.insert(0, newres .substring(0, dsq.getStart() -
5120            * sq.getStart())); dsq.setStart(sq.getStart()); } if (post) {
5121            * sb.append(newres.substring(newres.length() - sq.getEnd() -
5122            * dsq.getEnd())); dsq.setEnd(sq.getEnd()); }
5123            */
5124           dsq.setSequence(newres);
5125         }
5126         // TODO: merges will never happen if we 'know' we have the real dataset
5127         // sequence - this should be detected when id==dssid
5128         System.err
5129                 .println("DEBUG Notice:  Merged dataset sequence (if you see this often, post at http://issues.jalview.org/browse/JAL-1474)"); // ("
5130         // + (pre ? "prepended" : "") + " "
5131         // + (post ? "appended" : ""));
5132       }
5133     }
5134     else
5135     {
5136       // sequence refs are identical. We may need to update the existing dataset
5137       // alignment with this one, though.
5138       if (ds != null && dseqs == null)
5139       {
5140         int opos = ds.findIndex(dsq);
5141         SequenceI tseq = null;
5142         if (opos != -1 && vseqpos != opos)
5143         {
5144           // remove from old position
5145           ds.deleteSequence(dsq);
5146         }
5147         if (vseqpos < ds.getHeight())
5148         {
5149           if (vseqpos != opos)
5150           {
5151             // save sequence at destination position
5152             tseq = ds.getSequenceAt(vseqpos);
5153             ds.replaceSequenceAt(vseqpos, dsq);
5154             ds.addSequence(tseq);
5155           }
5156         }
5157         else
5158         {
5159           ds.addSequence(dsq);
5160         }
5161       }
5162     }
5163   }
5164
5165   /*
5166    * TODO use AlignmentI here and in related methods - needs
5167    * AlignmentI.getDataset() changed to return AlignmentI instead of Alignment
5168    */
5169   Hashtable<String, AlignmentI> datasetIds = null;
5170
5171   IdentityHashMap<AlignmentI, String> dataset2Ids = null;
5172
5173   private AlignmentI getDatasetFor(String datasetId)
5174   {
5175     if (datasetIds == null)
5176     {
5177       datasetIds = new Hashtable<String, AlignmentI>();
5178       return null;
5179     }
5180     if (datasetIds.containsKey(datasetId))
5181     {
5182       return datasetIds.get(datasetId);
5183     }
5184     return null;
5185   }
5186
5187   private void addDatasetRef(String datasetId, AlignmentI dataset)
5188   {
5189     if (datasetIds == null)
5190     {
5191       datasetIds = new Hashtable<String, AlignmentI>();
5192     }
5193     datasetIds.put(datasetId, dataset);
5194   }
5195
5196   /**
5197    * make a new dataset ID for this jalview dataset alignment
5198    *
5199    * @param dataset
5200    * @return
5201    */
5202   private String getDatasetIdRef(AlignmentI dataset)
5203   {
5204     if (dataset.getDataset() != null)
5205     {
5206       warn("Serious issue!  Dataset Object passed to getDatasetIdRef is not a Jalview DATASET alignment...");
5207     }
5208     String datasetId = makeHashCode(dataset, null);
5209     if (datasetId == null)
5210     {
5211       // make a new datasetId and record it
5212       if (dataset2Ids == null)
5213       {
5214         dataset2Ids = new IdentityHashMap<AlignmentI, String>();
5215       }
5216       else
5217       {
5218         datasetId = dataset2Ids.get(dataset);
5219       }
5220       if (datasetId == null)
5221       {
5222         datasetId = "ds" + dataset2Ids.size() + 1;
5223         dataset2Ids.put(dataset, datasetId);
5224       }
5225     }
5226     return datasetId;
5227   }
5228
5229   private void addDBRefs(SequenceI datasetSequence, Sequence sequence)
5230   {
5231     for (int d = 0; d < sequence.getDBRefCount(); d++)
5232     {
5233       DBRef dr = sequence.getDBRef(d);
5234       jalview.datamodel.DBRefEntry entry = new jalview.datamodel.DBRefEntry(
5235               sequence.getDBRef(d).getSource(), sequence.getDBRef(d)
5236                       .getVersion(), sequence.getDBRef(d).getAccessionId());
5237       if (dr.getMapping() != null)
5238       {
5239         entry.setMap(addMapping(dr.getMapping()));
5240       }
5241       datasetSequence.addDBRef(entry);
5242     }
5243   }
5244
5245   private jalview.datamodel.Mapping addMapping(Mapping m)
5246   {
5247     SequenceI dsto = null;
5248     // Mapping m = dr.getMapping();
5249     int fr[] = new int[m.getMapListFromCount() * 2];
5250     Enumeration f = m.enumerateMapListFrom();
5251     for (int _i = 0; f.hasMoreElements(); _i += 2)
5252     {
5253       MapListFrom mf = (MapListFrom) f.nextElement();
5254       fr[_i] = mf.getStart();
5255       fr[_i + 1] = mf.getEnd();
5256     }
5257     int fto[] = new int[m.getMapListToCount() * 2];
5258     f = m.enumerateMapListTo();
5259     for (int _i = 0; f.hasMoreElements(); _i += 2)
5260     {
5261       MapListTo mf = (MapListTo) f.nextElement();
5262       fto[_i] = mf.getStart();
5263       fto[_i + 1] = mf.getEnd();
5264     }
5265     jalview.datamodel.Mapping jmap = new jalview.datamodel.Mapping(dsto,
5266             fr, fto, (int) m.getMapFromUnit(), (int) m.getMapToUnit());
5267     if (m.getMappingChoice() != null)
5268     {
5269       MappingChoice mc = m.getMappingChoice();
5270       if (mc.getDseqFor() != null)
5271       {
5272         String dsfor = "" + mc.getDseqFor();
5273         if (seqRefIds.containsKey(dsfor))
5274         {
5275           /**
5276            * recover from hash
5277            */
5278           jmap.setTo(seqRefIds.get(dsfor));
5279         }
5280         else
5281         {
5282           frefedSequence.add(newMappingRef(dsfor, jmap));
5283         }
5284       }
5285       else
5286       {
5287         /**
5288          * local sequence definition
5289          */
5290         Sequence ms = mc.getSequence();
5291         SequenceI djs = null;
5292         String sqid = ms.getDsseqid();
5293         if (sqid != null && sqid.length() > 0)
5294         {
5295           /*
5296            * recover dataset sequence
5297            */
5298           djs = seqRefIds.get(sqid);
5299         }
5300         else
5301         {
5302           System.err
5303                   .println("Warning - making up dataset sequence id for DbRef sequence map reference");
5304           sqid = ((Object) ms).toString(); // make up a new hascode for
5305           // undefined dataset sequence hash
5306           // (unlikely to happen)
5307         }
5308
5309         if (djs == null)
5310         {
5311           /**
5312            * make a new dataset sequence and add it to refIds hash
5313            */
5314           djs = new jalview.datamodel.Sequence(ms.getName(),
5315                   ms.getSequence());
5316           djs.setStart(jmap.getMap().getToLowest());
5317           djs.setEnd(jmap.getMap().getToHighest());
5318           djs.setVamsasId(uniqueSetSuffix + sqid);
5319           jmap.setTo(djs);
5320           incompleteSeqs.put(sqid, djs);
5321           seqRefIds.put(sqid, djs);
5322
5323         }
5324         jalview.bin.Cache.log.debug("about to recurse on addDBRefs.");
5325         addDBRefs(djs, ms);
5326
5327       }
5328     }
5329     return (jmap);
5330
5331   }
5332
5333   public jalview.gui.AlignmentPanel copyAlignPanel(AlignmentPanel ap,
5334           boolean keepSeqRefs)
5335   {
5336     initSeqRefs();
5337     JalviewModel jm = saveState(ap, null, null, null);
5338
5339     if (!keepSeqRefs)
5340     {
5341       clearSeqRefs();
5342       jm.getJalviewModelSequence().getViewport(0).setSequenceSetId(null);
5343     }
5344     else
5345     {
5346       uniqueSetSuffix = "";
5347       jm.getJalviewModelSequence().getViewport(0).setId(null); // we don't
5348       // overwrite the
5349       // view we just
5350       // copied
5351     }
5352     if (this.frefedSequence == null)
5353     {
5354       frefedSequence = new Vector();
5355     }
5356
5357     viewportsAdded.clear();
5358
5359     AlignFrame af = loadFromObject(jm, null, false, null);
5360     af.alignPanels.clear();
5361     af.closeMenuItem_actionPerformed(true);
5362
5363     /*
5364      * if(ap.av.getAlignment().getAlignmentAnnotation()!=null) { for(int i=0;
5365      * i<ap.av.getAlignment().getAlignmentAnnotation().length; i++) {
5366      * if(!ap.av.getAlignment().getAlignmentAnnotation()[i].autoCalculated) {
5367      * af.alignPanel.av.getAlignment().getAlignmentAnnotation()[i] =
5368      * ap.av.getAlignment().getAlignmentAnnotation()[i]; } } }
5369      */
5370
5371     return af.alignPanel;
5372   }
5373
5374   /**
5375    * flag indicating if hashtables should be cleared on finalization TODO this
5376    * flag may not be necessary
5377    */
5378   private final boolean _cleartables = true;
5379
5380   private Hashtable jvids2vobj;
5381
5382   /*
5383    * (non-Javadoc)
5384    *
5385    * @see java.lang.Object#finalize()
5386    */
5387   @Override
5388   protected void finalize() throws Throwable
5389   {
5390     // really make sure we have no buried refs left.
5391     if (_cleartables)
5392     {
5393       clearSeqRefs();
5394     }
5395     this.seqRefIds = null;
5396     this.seqsToIds = null;
5397     super.finalize();
5398   }
5399
5400   private void warn(String msg)
5401   {
5402     warn(msg, null);
5403   }
5404
5405   private void warn(String msg, Exception e)
5406   {
5407     if (Cache.log != null)
5408     {
5409       if (e != null)
5410       {
5411         Cache.log.warn(msg, e);
5412       }
5413       else
5414       {
5415         Cache.log.warn(msg);
5416       }
5417     }
5418     else
5419     {
5420       System.err.println("Warning: " + msg);
5421       if (e != null)
5422       {
5423         e.printStackTrace();
5424       }
5425     }
5426   }
5427
5428   private void debug(String string)
5429   {
5430     debug(string, null);
5431   }
5432
5433   private void debug(String msg, Exception e)
5434   {
5435     if (Cache.log != null)
5436     {
5437       if (e != null)
5438       {
5439         Cache.log.debug(msg, e);
5440       }
5441       else
5442       {
5443         Cache.log.debug(msg);
5444       }
5445     }
5446     else
5447     {
5448       System.err.println("Warning: " + msg);
5449       if (e != null)
5450       {
5451         e.printStackTrace();
5452       }
5453     }
5454   }
5455
5456   /**
5457    * set the object to ID mapping tables used to write/recover objects and XML
5458    * ID strings for the jalview project. If external tables are provided then
5459    * finalize and clearSeqRefs will not clear the tables when the Jalview2XML
5460    * object goes out of scope. - also populates the datasetIds hashtable with
5461    * alignment objects containing dataset sequences
5462    *
5463    * @param vobj2jv
5464    *          Map from ID strings to jalview datamodel
5465    * @param jv2vobj
5466    *          Map from jalview datamodel to ID strings
5467    *
5468    *
5469    */
5470   public void setObjectMappingTables(Hashtable vobj2jv,
5471           IdentityHashMap jv2vobj)
5472   {
5473     this.jv2vobj = jv2vobj;
5474     this.vobj2jv = vobj2jv;
5475     Iterator ds = jv2vobj.keySet().iterator();
5476     String id;
5477     while (ds.hasNext())
5478     {
5479       Object jvobj = ds.next();
5480       id = jv2vobj.get(jvobj).toString();
5481       if (jvobj instanceof jalview.datamodel.Alignment)
5482       {
5483         if (((jalview.datamodel.Alignment) jvobj).getDataset() == null)
5484         {
5485           addDatasetRef(id, (jalview.datamodel.Alignment) jvobj);
5486         }
5487       }
5488       else if (jvobj instanceof jalview.datamodel.Sequence)
5489       {
5490         // register sequence object so the XML parser can recover it.
5491         if (seqRefIds == null)
5492         {
5493           seqRefIds = new HashMap<String, SequenceI>();
5494         }
5495         if (seqsToIds == null)
5496         {
5497           seqsToIds = new IdentityHashMap<SequenceI, String>();
5498         }
5499         seqRefIds.put(jv2vobj.get(jvobj).toString(), (SequenceI) jvobj);
5500         seqsToIds.put((SequenceI) jvobj, id);
5501       }
5502       else if (jvobj instanceof jalview.datamodel.AlignmentAnnotation)
5503       {
5504         String anid;
5505         AlignmentAnnotation jvann = (AlignmentAnnotation) jvobj;
5506         annotationIds.put(anid = jv2vobj.get(jvobj).toString(), jvann);
5507         if (jvann.annotationId == null)
5508         {
5509           jvann.annotationId = anid;
5510         }
5511         if (!jvann.annotationId.equals(anid))
5512         {
5513           // TODO verify that this is the correct behaviour
5514           this.warn("Overriding Annotation ID for " + anid
5515                   + " from different id : " + jvann.annotationId);
5516           jvann.annotationId = anid;
5517         }
5518       }
5519       else if (jvobj instanceof String)
5520       {
5521         if (jvids2vobj == null)
5522         {
5523           jvids2vobj = new Hashtable();
5524           jvids2vobj.put(jvobj, jv2vobj.get(jvobj).toString());
5525         }
5526       }
5527       else
5528       {
5529         Cache.log.debug("Ignoring " + jvobj.getClass() + " (ID = " + id);
5530       }
5531     }
5532   }
5533
5534   /**
5535    * set the uniqueSetSuffix used to prefix/suffix object IDs for jalview
5536    * objects created from the project archive. If string is null (default for
5537    * construction) then suffix will be set automatically.
5538    *
5539    * @param string
5540    */
5541   public void setUniqueSetSuffix(String string)
5542   {
5543     uniqueSetSuffix = string;
5544
5545   }
5546
5547   /**
5548    * uses skipList2 as the skipList for skipping views on sequence sets
5549    * associated with keys in the skipList
5550    *
5551    * @param skipList2
5552    */
5553   public void setSkipList(Hashtable skipList2)
5554   {
5555     skipList = skipList2;
5556   }
5557
5558   /**
5559    * Reads the jar entry of given name and returns its contents, or null if the
5560    * entry is not found.
5561    *
5562    * @param jprovider
5563    * @param jarEntryName
5564    * @return
5565    */
5566   protected String readJarEntry(jarInputStreamProvider jprovider,
5567           String jarEntryName)
5568   {
5569     String result = null;
5570     BufferedReader in = null;
5571
5572     try
5573     {
5574       /*
5575        * Reopen the jar input stream and traverse its entries to find a matching
5576        * name
5577        */
5578       JarInputStream jin = jprovider.getJarInputStream();
5579       JarEntry entry = null;
5580       do
5581       {
5582         entry = jin.getNextJarEntry();
5583       } while (entry != null && !entry.getName().equals(jarEntryName));
5584
5585       if (entry != null)
5586       {
5587         StringBuilder out = new StringBuilder(256);
5588         in = new BufferedReader(new InputStreamReader(jin, UTF_8));
5589         String data;
5590
5591         while ((data = in.readLine()) != null)
5592         {
5593           out.append(data);
5594         }
5595         result = out.toString();
5596       }
5597       else
5598       {
5599         warn("Couldn't find entry in Jalview Jar for " + jarEntryName);
5600       }
5601     } catch (Exception ex)
5602     {
5603       ex.printStackTrace();
5604     } finally
5605     {
5606       if (in != null)
5607       {
5608         try
5609         {
5610           in.close();
5611         } catch (IOException e)
5612         {
5613           // ignore
5614         }
5615       }
5616     }
5617
5618     return result;
5619   }
5620
5621   /**
5622    * Returns an incrementing counter (0, 1, 2...)
5623    *
5624    * @return
5625    */
5626   private synchronized int nextCounter()
5627   {
5628     return counter++;
5629   }
5630 }