src/jalview/gui/Jalview2XML_V1.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.binding.Annotation;
  25 import jalview.binding.AnnotationElement;
  26 import jalview.binding.Features;
  27 import jalview.binding.JGroup;
  28 import jalview.binding.JSeq;
  29 import jalview.binding.JalviewModel;
  30 import jalview.binding.JalviewModelSequence;
  31 import jalview.binding.Pdbids;
  32 import jalview.binding.Sequence;
  33 import jalview.binding.SequenceSet;
  34 import jalview.binding.Setting;
  35 import jalview.binding.Tree;
  36 import jalview.binding.UserColours;
  37 import jalview.binding.Viewport;
  38 import jalview.datamodel.PDBEntry;
  39 import jalview.io.FileFormat;
  40 import jalview.schemes.ColourSchemeI;
  41 import jalview.schemes.ColourSchemeProperty;
  42 import jalview.structure.StructureSelectionManager;
  43 import jalview.util.MessageManager;
  44 import jalview.util.jarInputStreamProvider;
  45 import jalview.viewmodel.seqfeatures.FeatureRendererSettings;
  46
  47 import java.io.InputStreamReader;
  48 import java.io.Reader;
  49 import java.net.UnknownHostException;
  50 import java.util.Hashtable;
  51 import java.util.Vector;
  52 import java.util.jar.JarEntry;
  53 import java.util.jar.JarInputStream;
  54
  55 import javax.swing.JOptionPane;
  56
  57 /**
  58  * DOCUMENT ME!
  59  *
  60  * @author $author$
  61  * @version $Revision$
  62  */
  63 public class Jalview2XML_V1
  64 {
  65   boolean raiseGUI = true;
  66
  67   public Jalview2XML_V1()
  68   {
  69
  70   };
  71
  72   public Jalview2XML_V1(boolean raiseGUI)
  73   {
  74     this.raiseGUI = raiseGUI;
  75   };
  76
  77   jalview.schemes.UserColourScheme GetUserColourScheme(
  78           JalviewModelSequence jms, String id)
  79   {
  80     UserColours[] uc = jms.getUserColours();
  81     UserColours colours = null;
  82
  83     for (int i = 0; i < uc.length; i++)
  84     {
  85       if (uc[i].getId().equals(id))
  86       {
  87         colours = uc[i];
  88
  89         break;
  90       }
  91     }
  92
  93     int csize = colours.getUserColourScheme().getColourCount();
  94     java.awt.Color[] newColours = new java.awt.Color[csize];
  95
  96     for (int i = 0; i < csize; i++)
  97     {
  98       newColours[i] = new java.awt.Color(Integer.parseInt(colours
  99               .getUserColourScheme().getColour(i).getRGB(), 16));
 100     }
 101
 102     return new jalview.schemes.UserColourScheme(newColours);
 103   }
 104
 105   /**
 106    * DOCUMENT ME!
 107    *
 108    * @param file
 109    *          DOCUMENT ME!
 110    */
 111   public AlignFrame LoadJalviewAlign(final jarInputStreamProvider jprovider)
 112   {
 113     final String file = jprovider.getFilename();
 114     jalview.gui.AlignFrame af = null;
 115
 116     try
 117     {
 118       JarInputStream jin = null;
 119       JarEntry jarentry = null;
 120       int entryCount = 1;
 121
 122       do
 123       {
 124         jin = jprovider.getJarInputStream();
 125
 126         for (int i = 0; i < entryCount; i++)
 127         {
 128           jarentry = jin.getNextJarEntry();
 129         }
 130
 131         if (jarentry != null)
 132         {
 133           entryCount++;
 134           if (jarentry.getName().endsWith(".xml"))
 135           {
 136             Reader in = new InputStreamReader(jin, "UTF-8");
 137             JalviewModel object = new JalviewModel();
 138
 139             object = object.unmarshal(in);
 140
 141             af = LoadFromObject(object, file);
 142           }
 143         }
 144         jin.close();
 145       } while (jarentry != null);
 146     } catch (final UnknownHostException ex)
 147     {
 148       ex.printStackTrace();
 149       if (raiseGUI)
 150       {
 151         javax.swing.SwingUtilities.invokeLater(new Runnable()
 152         {
 153           @Override
 154           public void run()
 155           {
 156
 157             System.err.println("Couldn't locate Jalview XML file : " + ex
 158                     + "\n");
 159             JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 160                     MessageManager.formatMessage("label.couldnt_locate",
 161                             new String[] { file }), MessageManager
 162                             .getString("label.url_not_found"),
 163                     JvOptionPane.WARNING_MESSAGE);
 164           }
 165         });
 166       }
 167       ;
 168     } catch (Exception ex)
 169     {
 170       System.err.println("Exception whilst loading jalview XML file : ");
 171       ex.printStackTrace();
 172       if (raiseGUI)
 173       {
 174         javax.swing.SwingUtilities.invokeLater(new Runnable()
 175         {
 176           @Override
 177           public void run()
 178           {
 179
 180             JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 181                     MessageManager.formatMessage(
 182                             "label.error_loading_file_params", new String[]
 183                             { file }), MessageManager
 184                             .getString("label.error_loading_jalview_file"),
 185                     JvOptionPane.WARNING_MESSAGE);
 186           }
 187         });
 188       }
 189     }
 190
 191     return af;
 192   }
 193
 194   AlignFrame LoadFromObject(JalviewModel object, String file)
 195   {
 196     Vector seqids = new Vector();
 197     SequenceSet vamsasSet = object.getVamsasModel().getSequenceSet(0);
 198     Sequence[] vamsasSeq = vamsasSet.getSequence();
 199
 200     JalviewModelSequence jms = object.getJalviewModelSequence();
 201
 202     // ////////////////////////////////
 203     // LOAD SEQUENCES
 204     jalview.datamodel.Sequence[] jseqs = new jalview.datamodel.Sequence[vamsasSeq.length];
 205     JSeq[] JSEQ = object.getJalviewModelSequence().getJSeq();
 206     for (int i = 0; i < vamsasSeq.length; i++)
 207     {
 208       jseqs[i] = new jalview.datamodel.Sequence(vamsasSeq[i].getName(),
 209               vamsasSeq[i].getSequence());
 210       jseqs[i].setStart(JSEQ[i].getStart());
 211       jseqs[i].setEnd(JSEQ[i].getEnd());
 212       seqids.add(jseqs[i]);
 213     }
 214
 215     // /SequenceFeatures are added to the DatasetSequence,
 216     // so we must create the dataset before loading features
 217     // ///////////////////////////////
 218     jalview.datamodel.Alignment al = new jalview.datamodel.Alignment(jseqs);
 219     al.setDataset(null);
 220     // ///////////////////////////////
 221
 222     for (int i = 0; i < vamsasSeq.length; i++)
 223     {
 224       if (JSEQ[i].getFeaturesCount() > 0)
 225       {
 226         Features[] features = JSEQ[i].getFeatures();
 227         for (int f = 0; f < features.length; f++)
 228         {
 229           jalview.datamodel.SequenceFeature sf = new jalview.datamodel.SequenceFeature(
 230                   features[f].getType(), features[f].getDescription(),
 231                   features[f].getStatus(), features[f].getBegin(),
 232                   features[f].getEnd(), null);
 233
 234           al.getSequenceAt(i).getDatasetSequence().addSequenceFeature(sf);
 235         }
 236       }
 237       if (JSEQ[i].getPdbidsCount() > 0)
 238       {
 239         Pdbids[] ids = JSEQ[i].getPdbids();
 240         for (int p = 0; p < ids.length; p++)
 241         {
 242           jalview.datamodel.PDBEntry entry = new jalview.datamodel.PDBEntry();
 243           entry.setId(ids[p].getId());
 244           if (ids[p].getType() != null)
 245           {
 246             if (ids[p].getType().equalsIgnoreCase("PDB"))
 247             {
 248               entry.setType(PDBEntry.Type.PDB);
 249             }
 250             else
 251             {
 252               entry.setType(PDBEntry.Type.FILE);
 253             }
 254           }
 255           al.getSequenceAt(i).getDatasetSequence().addPDBId(entry);
 256           StructureSelectionManager.getStructureSelectionManager(
 257                   Desktop.instance).registerPDBEntry(entry);
 258         }
 259
 260       }
 261     }
 262
 263     // ///////////////////////////////
 264     // ////////////////////////////////
 265     // LOAD ANNOTATIONS
 266     if (vamsasSet.getAnnotation() != null)
 267     {
 268       Annotation[] an = vamsasSet.getAnnotation();
 269
 270       for (int i = 0; i < an.length; i++)
 271       {
 272         AnnotationElement[] ae = an[i].getAnnotationElement();
 273         jalview.datamodel.Annotation[] anot = new jalview.datamodel.Annotation[al
 274                 .getWidth()];
 275
 276         for (int aa = 0; aa < ae.length; aa++)
 277         {
 278           anot[ae[aa].getPosition()] = new jalview.datamodel.Annotation(
 279                   ae[aa].getDisplayCharacter(), ae[aa].getDescription(),
 280                   ae[aa].getSecondaryStructure().charAt(0),
 281                   ae[aa].getValue());
 282         }
 283
 284         jalview.datamodel.AlignmentAnnotation jaa = null;
 285
 286         if (an[i].getGraph())
 287         {
 288           jaa = new jalview.datamodel.AlignmentAnnotation(an[i].getLabel(),
 289                   an[i].getDescription(), anot, 0, 0,
 290                   jalview.datamodel.AlignmentAnnotation.BAR_GRAPH);
 291         }
 292         else
 293         {
 294           jaa = new jalview.datamodel.AlignmentAnnotation(an[i].getLabel(),
 295                   an[i].getDescription(), anot);
 296         }
 297
 298         al.addAnnotation(jaa);
 299       }
 300     }
 301
 302     // ///////////////////////////////
 303     // LOAD VIEWPORT
 304     Viewport[] views = jms.getViewport();
 305     Viewport view = views[0]; // DEAL WITH MULTIPLE VIEWPORTS LATER
 306
 307     AlignFrame af = new AlignFrame(al, view.getWidth(), view.getHeight());
 308
 309     af.setFileName(file, FileFormat.Jalview);
 310
 311     for (int i = 0; i < JSEQ.length; i++)
 312     {
 313       af.viewport.setSequenceColour(af.viewport.getAlignment()
 314               .getSequenceAt(i), new java.awt.Color(JSEQ[i].getColour()));
 315     }
 316
 317     // af.changeColour() );
 318     // ///////////////////////
 319     // LOAD GROUPS
 320     if (jms.getJGroupCount() > 0)
 321     {
 322       JGroup[] groups = jms.getJGroup();
 323
 324       for (int i = 0; i < groups.length; i++)
 325       {
 326         ColourSchemeI cs = null;
 327
 328         if (groups[i].getColour() != null)
 329         {
 330           if (groups[i].getColour().startsWith("ucs"))
 331           {
 332             cs = GetUserColourScheme(jms, groups[i].getColour());
 333           }
 334           else
 335           {
 336             cs = ColourSchemeProperty.getColour(al, groups[i].getColour());
 337           }
 338
 339           if (cs != null)
 340           {
 341             cs.setThreshold(groups[i].getPidThreshold(), true);
 342           }
 343
 344         }
 345
 346         Vector seqs = new Vector();
 347         int[] ids = groups[i].getSeq();
 348
 349         for (int s = 0; s < ids.length; s++)
 350         {
 351           seqs.addElement(seqids.elementAt(ids[s]));
 352         }
 353
 354         jalview.datamodel.SequenceGroup sg = new jalview.datamodel.SequenceGroup(
 355                 seqs, groups[i].getName(), cs, groups[i].getDisplayBoxes(),
 356                 groups[i].getDisplayText(), groups[i].getColourText(),
 357                 groups[i].getStart(), groups[i].getEnd());
 358
 359         sg.setOutlineColour(new java.awt.Color(groups[i].getOutlineColour()));
 360
 361         if (groups[i].getConsThreshold() != 0)
 362         {
 363           Conservation c = new Conservation("All", sg.getSequences(null),
 364                   0, sg.getWidth() - 1);
 365           c.calculate();
 366           c.verdict(false, 25);
 367           sg.cs.setConservation(c);
 368         }
 369
 370         al.addGroup(sg);
 371       }
 372     }
 373
 374     af.setBounds(view.getXpos(), view.getYpos(), view.getWidth(),
 375             view.getHeight());
 376     af.viewport.setStartRes(view.getStartRes());
 377     af.viewport.setStartSeq(view.getStartSeq());
 378     af.viewport.setShowAnnotation(view.getShowAnnotation());
 379     af.viewport.setAbovePIDThreshold(view.getPidSelected());
 380     af.viewport.setColourText(view.getShowColourText());
 381     af.viewport.setConservationSelected(view.getConservationSelected());
 382     af.viewport.setShowJVSuffix(view.getShowFullId());
 383     af.viewport.setFont(
 384             new java.awt.Font(view.getFontName(), view.getFontStyle(), view
 385                     .getFontSize()), true);
 386
 387     af.viewport.setRenderGaps(view.getRenderGaps());
 388     af.viewport.setWrapAlignment(view.getWrapAlignment());
 389
 390     af.viewport.setShowAnnotation(view.isShowAnnotation());
 391     af.viewport.setShowBoxes(view.getShowBoxes());
 392     af.viewport.setShowText(view.getShowText());
 393
 394     ColourSchemeI cs = null;
 395
 396     if (view.getBgColour() != null)
 397     {
 398       if (view.getBgColour().startsWith("ucs"))
 399       {
 400         cs = GetUserColourScheme(jms, view.getBgColour());
 401       }
 402       else
 403       {
 404         cs = ColourSchemeProperty.getColour(al, view.getBgColour());
 405       }
 406
 407       if (cs != null)
 408       {
 409         cs.setThreshold(view.getPidThreshold(), true);
 410         cs.setConsensus(af.viewport.getSequenceConsensusHash());
 411       }
 412     }
 413
 414     af.viewport.setGlobalColourScheme(cs);
 415     af.viewport.setColourAppliesToAllGroups(false);
 416     af.alignPanel.updateLayout();
 417     af.changeColour(cs);
 418     if (view.getConservationSelected() && cs != null)
 419     {
 420       cs.setConservationInc(view.getConsThreshold());
 421     }
 422
 423     af.viewport.setColourAppliesToAllGroups(true);
 424     af.viewport.setShowSequenceFeatures(view.getShowSequenceFeatures());
 425
 426     if (jms.getFeatureSettings() != null)
 427     {
 428       Hashtable featuresDisplayed = new Hashtable();
 429       Hashtable featureColours = new Hashtable();
 430       String[] renderOrder = new String[jms.getFeatureSettings()
 431               .getSettingCount()];
 432       for (int fs = 0; fs < jms.getFeatureSettings().getSettingCount(); fs++)
 433       {
 434         Setting setting = jms.getFeatureSettings().getSetting(fs);
 435
 436         featureColours.put(setting.getType(),
 437                 new java.awt.Color(setting.getColour()));
 438
 439         renderOrder[fs] = setting.getType();
 440
 441         if (setting.getDisplay())
 442         {
 443           featuresDisplayed.put(setting.getType(),
 444                   new Integer(setting.getColour()));
 445         }
 446       }
 447       FeatureRendererSettings frs = new FeatureRendererSettings(
 448               renderOrder, new Hashtable(), featureColours, 1.0f, null);
 449       af.alignPanel.getSeqPanel().seqCanvas.getFeatureRenderer()
 450               .transferSettings(frs);
 451     }
 452
 453     af.setMenusFromViewport(af.viewport);
 454
 455     Desktop.addInternalFrame(af, view.getTitle(), view.getWidth(),
 456             view.getHeight());
 457
 458     // LOAD TREES
 459     // /////////////////////////////////////
 460     if (jms.getTreeCount() > 0)
 461     {
 462       try
 463       {
 464         for (int t = 0; t < jms.getTreeCount(); t++)
 465         {
 466
 467           Tree tree = jms.getTree(t);
 468
 469           TreePanel tp = af.ShowNewickTree(
 470                   new jalview.io.NewickFile(tree.getNewick()),
 471                   tree.getTitle(), tree.getWidth(), tree.getHeight(),
 472                   tree.getXpos(), tree.getYpos());
 473
 474           tp.fitToWindow.setState(tree.getFitToWindow());
 475           tp.fitToWindow_actionPerformed(null);
 476
 477           if (tree.getFontName() != null)
 478           {
 479             tp.setTreeFont(new java.awt.Font(tree.getFontName(), tree
 480                     .getFontStyle(), tree.getFontSize()));
 481           }
 482           else
 483           {
 484             tp.setTreeFont(new java.awt.Font(view.getFontName(), view
 485                     .getFontStyle(), tree.getFontSize()));
 486           }
 487
 488           tp.showPlaceholders(tree.getMarkUnlinked());
 489           tp.showBootstrap(tree.getShowBootstrap());
 490           tp.showDistances(tree.getShowDistances());
 491
 492           tp.treeCanvas.threshold = tree.getThreshold();
 493
 494           if (tree.getCurrentTree())
 495           {
 496             af.viewport.setCurrentTree(tp.getTree());
 497           }
 498         }
 499
 500       } catch (Exception ex)
 501       {
 502         ex.printStackTrace();
 503       }
 504
 505     }
 506
 507     return af;
 508   }
 509 }