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