src/jalview/io/vamsas/Tree.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.io.vamsas;
  19
  20 import java.io.IOException;
  21 import java.util.Enumeration;
  22 import java.util.Hashtable;
  23 import java.util.List;
  24 import java.util.Vector;
  25
  26 import jalview.analysis.NJTree;
  27 import jalview.bin.Cache;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.datamodel.AlignmentView;
  30 import jalview.datamodel.BinaryNode;
  31 import jalview.datamodel.SeqCigar;
  32 import jalview.datamodel.Sequence;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.datamodel.SequenceNode;
  35 import jalview.gui.AlignViewport;
  36 import jalview.gui.TreePanel;
  37 import jalview.io.NewickFile;
  38 import jalview.io.VamsasAppDatastore;
  39 import uk.ac.vamsas.client.Vobject;
  40 import uk.ac.vamsas.objects.core.AlignmentSequence;
  41 import uk.ac.vamsas.objects.core.Entry;
  42 import uk.ac.vamsas.objects.core.Input;
  43 import uk.ac.vamsas.objects.core.Newick;
  44 import uk.ac.vamsas.objects.core.Param;
  45 import uk.ac.vamsas.objects.core.Provenance;
  46 import uk.ac.vamsas.objects.core.Seg;
  47 import uk.ac.vamsas.objects.core.Treenode;
  48 import uk.ac.vamsas.objects.core.Vref;
  49
  50 public class Tree extends DatastoreItem
  51 {
  52   AlignmentI jal;
  53
  54   TreePanel tp;
  55
  56   uk.ac.vamsas.objects.core.Tree tree;
  57
  58   uk.ac.vamsas.objects.core.Alignment alignment; // may be null => dataset or
  59
  60   // other kind of tree
  61   private NewickFile ntree;
  62
  63   private String title;
  64
  65   private AlignmentView inputData = null;
  66
  67   public static void updateFrom(VamsasAppDatastore datastore,
  68           jalview.gui.AlignFrame alignFrame,
  69           uk.ac.vamsas.objects.core.Tree vtree)
  70   {
  71     Tree toTree = new Tree(datastore, alignFrame, vtree);
  72   }
  73
  74   public Tree(VamsasAppDatastore datastore,
  75           jalview.gui.AlignFrame alignFrame,
  76           uk.ac.vamsas.objects.core.Tree vtree)
  77   {
  78     super(datastore, vtree, TreePanel.class);
  79     doJvUpdate();
  80   }
  81
  82   private NewickFile getNtree() throws IOException
  83   {
  84     return new jalview.io.NewickFile(tree.getNewick(0).getContent());
  85   }
  86
  87   public Tree(VamsasAppDatastore datastore, TreePanel tp2, AlignmentI jal2,
  88           uk.ac.vamsas.objects.core.Alignment alignment2)
  89   {
  90     super(datastore, tp2, uk.ac.vamsas.objects.core.Tree.class);
  91
  92     jal = jal2;
  93     tp = (TreePanel) jvobj;
  94     alignment = alignment2;
  95
  96     tree = (uk.ac.vamsas.objects.core.Tree) vobj;
  97     doSync();
  98   }
  99
 100   /*
 101    * (non-Javadoc)
 102    *
 103    * @see jalview.io.vamsas.DatastoreItem#addFromDocument()
 104    */
 105   @Override
 106   public void addFromDocument()
 107   {
 108     tree = (uk.ac.vamsas.objects.core.Tree) vobj; // vtree;
 109     TreePanel tp = (TreePanel) jvobj; // getvObj2jv(tree);
 110     // make a new tree
 111     Object[] idata = recoverInputData(tree.getProvenance());
 112     try
 113     {
 114       if (idata != null && idata[0] != null)
 115       {
 116         inputData = (AlignmentView) idata[0];
 117       }
 118       ntree = getNtree();
 119       title = tree.getNewick(0).getTitle();
 120       if (title == null || title.length() == 0)
 121       {
 122         title = tree.getTitle(); // hack!!!!
 123       }
 124     } catch (Exception e)
 125     {
 126       Cache.log.warn("Problems parsing treefile '"
 127               + tree.getNewick(0).getContent() + "'", e);
 128     }
 129   }
 130
 131   /*
 132    * (non-Javadoc)
 133    *
 134    * @see jalview.io.vamsas.DatastoreItem#conflict()
 135    */
 136   @Override
 137   public void conflict()
 138   {
 139     Cache.log
 140             .info("Update (with conflict) from vamsas document to alignment associated tree not implemented yet.");
 141   }
 142
 143   /*
 144    * (non-Javadoc)
 145    *
 146    * @see jalview.io.vamsas.DatastoreItem#update()
 147    */
 148   @Override
 149   public void updateToDoc()
 150   {
 151     if (isModifiable(tree.getModifiable()))
 152     {
 153       // synchronize(); // update();
 154       // verify any changes.
 155       log.info("TODO: Update tree in document from jalview.");
 156     }
 157     else
 158     {
 159       // handle conflict
 160       log.info("TODO: Add the locally modified tree in Jalview as a new tree in document, leaving locked tree unchanged.");
 161     }
 162   }
 163
 164   /*
 165    * (non-Javadoc)
 166    *
 167    * @see jalview.io.vamsas.DatastoreItem#updateFromDoc()
 168    */
 169   @Override
 170   public void updateFromDoc()
 171   {
 172     // should probably just open a new tree panel in the same place as the old
 173     // one
 174     // TODO: Tree.updateFromDoc
 175     /*
 176      * TreePanel tp = (TreePanel) jvobj; // getvObj2jv(tree);
 177      *
 178      * // make a new tree Object[] idata =
 179      * recoverInputData(tree.getProvenance()); try { if (idata != null &&
 180      * idata[0] != null) { inputData = (AlignmentView) idata[0]; } ntree =
 181      * getNtree(); title = tree.getNewick(0).getTitle(); if (title == null ||
 182      * title.length() == 0) { title = tree.getTitle(); // hack!!!! } } catch
 183      * (Exception e) { Cache.log.warn("Problems parsing treefile '" +
 184      * tree.getNewick(0).getContent() + "'", e); }
 185      */
 186     log.debug("Update the local tree in jalview from the document.");
 187
 188     if (isModifiable(tree.getModifiable()))
 189     {
 190       // synchronize(); // update();
 191       // verify any changes.
 192       log.debug("Update tree in document from jalview.");
 193     }
 194     else
 195     {
 196       // handle conflict
 197       log.debug("Add modified jalview tree as new tree in document.");
 198     }
 199   }
 200
 201   /**
 202    * correctly creates provenance for trees calculated on an alignment by
 203    * jalview.
 204    *
 205    * @param jal
 206    * @param tp
 207    * @return
 208    */
 209   private Provenance makeTreeProvenance(AlignmentI jal, TreePanel tp)
 210   {
 211     Cache.log.debug("Making Tree provenance for " + tp.getTitle());
 212     Provenance prov = new Provenance();
 213     prov.addEntry(new Entry());
 214     prov.getEntry(0).setAction("imported " + tp.getTitle());
 215     prov.getEntry(0).setUser(provEntry.getUser());
 216     prov.getEntry(0).setApp(provEntry.getApp());
 217     prov.getEntry(0).setDate(provEntry.getDate());
 218     if (tp.getTree().hasOriginalSequenceData())
 219     {
 220       Input vInput = new Input();
 221       // LATER: check to see if tree input data is contained in this alignment -
 222       // or just correctly resolve the tree's seqData to the correct alignment
 223       // in
 224       // the document.
 225       Vector alsqrefs = getjv2vObjs(findAlignmentSequences(jal,
 226               tp.getTree().seqData.getSequences()));
 227       Object[] alsqs = new Object[alsqrefs.size()];
 228       alsqrefs.copyInto(alsqs);
 229       vInput.setObjRef(alsqs);
 230       // now create main provenance data
 231       prov.getEntry(0).setAction("created " + tp.getTitle());
 232       prov.getEntry(0).addInput(vInput);
 233       // jalview's special input parameter for distance matrix calculations
 234       vInput.setName("jalview:seqdist"); // TODO: settle on appropriate name.
 235       prov.getEntry(0).addParam(new Param());
 236       prov.getEntry(0).getParam(0).setName("treeType");
 237       prov.getEntry(0).getParam(0).setType("utf8");
 238       prov.getEntry(0).getParam(0).setContent("NJ"); // TODO: type of tree is a
 239       // general parameter
 240       int ranges[] = tp.getTree().seqData.getVisibleContigs();
 241       // VisibleContigs are with respect to alignment coordinates. Still need
 242       // offsets
 243       int start = tp.getTree().seqData.getAlignmentOrigin();
 244       for (int r = 0; r < ranges.length; r += 2)
 245       {
 246         Seg visSeg = new Seg();
 247         visSeg.setStart(1 + start + ranges[r]);
 248         visSeg.setEnd(start + ranges[r + 1]);
 249         visSeg.setInclusive(true);
 250         vInput.addSeg(visSeg);
 251       }
 252     }
 253     Cache.log.debug("Finished Tree provenance for " + tp.getTitle());
 254     return prov;
 255   }
 256
 257   /**
 258    * look up SeqCigars in an existing alignment.
 259    *
 260    * @param jal
 261    * @param sequences
 262    * @return vector of alignment sequences in order of SeqCigar array (but
 263    *         missing unfound seqcigars)
 264    */
 265   private Vector findAlignmentSequences(AlignmentI jal, SeqCigar[] sequences)
 266   {
 267     SeqCigar[] tseqs = new SeqCigar[sequences.length];
 268     System.arraycopy(sequences, 0, tseqs, 0, sequences.length);
 269     Vector alsq = new Vector();
 270     List<SequenceI> jalsqs;
 271     synchronized (jalsqs=jal.getSequences())
 272     {for (SequenceI asq:jalsqs)
 273     {
 274       for (int t = 0; t < sequences.length; t++)
 275       {
 276         if (tseqs[t] != null
 277                 && (tseqs[t].getRefSeq() == asq || tseqs[t].getRefSeq() == asq
 278                         .getDatasetSequence()))
 279         // && tseqs[t].getStart()>=asq.getStart() &&
 280         // tseqs[t].getEnd()<=asq.getEnd())
 281         {
 282           tseqs[t] = null;
 283           alsq.add(asq);
 284         }
 285       }
 286     }}
 287     if (alsq.size() < sequences.length)
 288       Cache.log
 289               .warn("Not recovered all alignment sequences for given set of input sequence CIGARS");
 290     return alsq;
 291   }
 292
 293   /**
 294    *
 295    * Update jalview newick representation with TreeNode map
 296    *
 297    * @param tp
 298    *          the treepanel that this tree is bound to.
 299    */
 300   public void UpdateSequenceTreeMap(TreePanel tp)
 301   {
 302     if (tp == null || tree == null)
 303       return;
 304     Vector leaves = new Vector();
 305     if (tp.getTree() == null)
 306     {
 307       Cache.log.warn("Not updating SequenceTreeMap for "
 308               + tree.getVorbaId());
 309       return;
 310     }
 311     tp.getTree().findLeaves(tp.getTree().getTopNode(), leaves);
 312     Treenode[] tn = tree.getTreenode(); // todo: select nodes for this
 313     // particular tree
 314     int sz = tn.length;
 315     int i = 0;
 316
 317     while (i < sz)
 318     {
 319       Treenode node = tn[i++];
 320       BinaryNode mappednode = findNodeSpec(node.getNodespec(), leaves);
 321       if (mappednode != null && mappednode instanceof SequenceNode)
 322       {
 323         SequenceNode leaf = (SequenceNode) mappednode;
 324         // check if we can make the specified association
 325         Object jvseq = null;
 326         int vrf = 0, refv = 0;
 327         while (jvseq == null && vrf < node.getVrefCount())
 328         {
 329           if (refv < node.getVref(vrf).getRefsCount())
 330           {
 331             Object noderef = node.getVref(vrf).getRefs(refv++);
 332             if (noderef instanceof AlignmentSequence)
 333             {
 334               // we only make these kind of associations
 335               jvseq = getvObj2jv((Vobject) noderef);
 336             }
 337           }
 338           else
 339           {
 340             refv = 0;
 341             vrf++;
 342           }
 343         }
 344         if (jvseq instanceof SequenceI)
 345         {
 346           leaf.setElement(jvseq);
 347           leaf.setPlaceholder(false);
 348         }
 349         else
 350         {
 351           leaf.setPlaceholder(true);
 352           leaf.setElement(new Sequence(leaf.getName(), "THISISAPLACEHLDER"));
 353         }
 354       }
 355     }
 356   }
 357
 358   // / TODO: refactor to vamsas :start
 359   /**
 360    * construct treenode mappings for mapped sequences
 361    *
 362    * @param ntree
 363    * @param newick
 364    * @return
 365    */
 366   public Treenode[] makeTreeNodes(NJTree ntree, Newick newick)
 367   {
 368     Vector leaves = new Vector();
 369     ntree.findLeaves(ntree.getTopNode(), leaves);
 370     Vector tnv = new Vector();
 371     Enumeration l = leaves.elements();
 372     Hashtable nodespecs = new Hashtable();
 373     while (l.hasMoreElements())
 374     {
 375       jalview.datamodel.BinaryNode tnode = (jalview.datamodel.BinaryNode) l
 376               .nextElement();
 377       if (tnode instanceof jalview.datamodel.SequenceNode)
 378       {
 379         if (!((jalview.datamodel.SequenceNode) tnode).isPlaceholder())
 380         {
 381           Object assocseq = ((jalview.datamodel.SequenceNode) tnode)
 382                   .element();
 383           if (assocseq instanceof SequenceI)
 384           {
 385             Vobject vobj = this.getjv2vObj(assocseq);
 386             if (vobj != null)
 387             {
 388               Treenode node = new Treenode();
 389               if (newick.isRegisterable())
 390               {
 391                 this.cdoc.registerObject(newick);
 392                 node.addTreeId(newick);
 393               }
 394               node.setNodespec(makeNodeSpec(nodespecs, tnode));
 395               node.setName(tnode.getName());
 396               Vref vr = new Vref();
 397               vr.addRefs(vobj);
 398               node.addVref(vr);
 399               tnv.addElement(node);
 400             }
 401             else
 402             {
 403               System.err.println("WARNING: Unassociated treeNode "
 404                       + tnode.element().toString()
 405                       + " "
 406                       + ((tnode.getName() != null) ? " label "
 407                               + tnode.getName() : ""));
 408             }
 409           }
 410         }
 411       }
 412     }
 413     if (tnv.size() > 0)
 414     {
 415       Treenode[] tn = new Treenode[tnv.size()];
 416       tnv.copyInto(tn);
 417       return tn;
 418     }
 419     return new Treenode[]
 420     {};
 421   }
 422
 423   private String makeNodeSpec(Hashtable nodespecs,
 424           jalview.datamodel.BinaryNode tnode)
 425   {
 426     String nname = new String(tnode.getName());
 427     Integer nindx = (Integer) nodespecs.get(nname);
 428     if (nindx == null)
 429     {
 430       nindx = new Integer(1);
 431     }
 432     nname = nindx.toString() + " " + nname;
 433     return nname;
 434   }
 435
 436   /**
 437    * call to match up Treenode specs to NJTree parsed from document object.
 438    *
 439    * @param nodespec
 440    * @param leaves
 441    *          as returned from NJTree.findLeaves( .., ..) ..
 442    * @return
 443    */
 444   private jalview.datamodel.BinaryNode findNodeSpec(String nodespec,
 445           Vector leaves)
 446   {
 447     int occurence = -1;
 448     String nspec = nodespec.substring(nodespec.indexOf(' ') + 1);
 449     String oval = nodespec.substring(0, nodespec.indexOf(' '));
 450     try
 451     {
 452       occurence = new Integer(oval).intValue();
 453     } catch (Exception e)
 454     {
 455       System.err.println("Invalid nodespec '" + nodespec + "'");
 456       return null;
 457     }
 458     jalview.datamodel.BinaryNode bn = null;
 459
 460     int nocc = 0;
 461     Enumeration en = leaves.elements();
 462     while (en.hasMoreElements() && nocc < occurence)
 463     {
 464       bn = (jalview.datamodel.BinaryNode) en.nextElement();
 465       if (bn instanceof jalview.datamodel.SequenceNode
 466               && bn.getName().equals(nspec))
 467       {
 468         --occurence;
 469       }
 470       else
 471         bn = null;
 472     }
 473     return bn;
 474   }
 475
 476   // todo: end refactor to vamsas library
 477   /**
 478    * add jalview object to vamsas document
 479    *
 480    */
 481   @Override
 482   public void addToDocument()
 483   {
 484     tree = new uk.ac.vamsas.objects.core.Tree();
 485     bindjvvobj(tp, tree);
 486     tree.setTitle(tp.getTitle());
 487     Newick newick = new Newick();
 488     newick.setContent(tp.getTree().toString());
 489     newick.setTitle(tp.getTitle());
 490     tree.addNewick(newick);
 491     tree.setProvenance(makeTreeProvenance(jal, tp));
 492     tree.setTreenode(makeTreeNodes(tp.getTree(), newick));
 493
 494     alignment.addTree(tree);
 495   }
 496
 497   /**
 498    * note: this function assumes that all sequence and alignment objects
 499    * referenced in input data has already been associated with jalview objects.
 500    *
 501    * @param tp
 502    * @param alignFrame
 503    * @return Object[] { AlignmentView, AlignmentI - reference alignment for
 504    *         input }
 505    */
 506   public Object[] recoverInputData(Provenance tp)
 507   {
 508     AlignViewport javport = null;
 509     jalview.datamodel.AlignmentI jal = null;
 510     jalview.datamodel.CigarArray view = null;
 511     for (int pe = 0; pe < tp.getEntryCount(); pe++)
 512     {
 513       if (tp.getEntry(pe).getInputCount() > 0)
 514       {
 515         if (tp.getEntry(pe).getInputCount() > 1)
 516         {
 517           Cache.log
 518                   .warn("Ignoring additional input spec in provenance entry "
 519                           + tp.getEntry(pe).toString());
 520         }
 521         // LATER: deal sensibly with multiple inputs
 522         Input vInput = tp.getEntry(pe).getInput(0);
 523         // is this the whole alignment or a specific set of sequences ?
 524         if (vInput.getObjRefCount() == 0)
 525         {
 526           if (tree.getV_parent() != null
 527                   && tree.getV_parent() instanceof uk.ac.vamsas.objects.core.Alignment)
 528           {
 529             javport = getViewport(tree.getV_parent());
 530             jal = javport.getAlignment();
 531             view = javport.getAlignment().getCompactAlignment();
 532           }
 533         }
 534         else
 535         {
 536           // Explicit reference - to alignment, sequences or what.
 537           if (vInput.getObjRefCount() == 1
 538                   && vInput.getObjRef(0) instanceof uk.ac.vamsas.objects.core.Alignment)
 539           {
 540             // recover an AlignmentView for the input data
 541             javport = getViewport((Vobject) vInput.getObjRef(0));
 542             jal = javport.getAlignment();
 543             view = javport.getAlignment().getCompactAlignment();
 544           }
 545           else if (vInput.getObjRef(0) instanceof uk.ac.vamsas.objects.core.AlignmentSequence)
 546           {
 547             // recover an AlignmentView for the input data
 548             javport = getViewport(((Vobject) vInput.getObjRef(0))
 549                     .getV_parent());
 550             jal = javport.getAlignment();
 551             jalview.datamodel.SequenceI[] seqs = new jalview.datamodel.SequenceI[vInput
 552                     .getObjRefCount()];
 553             for (int i = 0, iSize = vInput.getObjRefCount(); i < iSize; i++)
 554             {
 555               SequenceI seq = (SequenceI) getvObj2jv((Vobject) vInput
 556                       .getObjRef(i));
 557               seqs[i] = seq;
 558             }
 559             view = new jalview.datamodel.Alignment(seqs)
 560                     .getCompactAlignment();
 561
 562           }
 563         }
 564         int from = 1, to = jal.getWidth();
 565         int offset = 0; // deleteRange modifies its frame of reference
 566         for (int r = 0, s = vInput.getSegCount(); r < s; r++)
 567         {
 568           Seg visSeg = vInput.getSeg(r);
 569           int se[] = getSegRange(visSeg, true); // jalview doesn't do
 570           // bidirection alignments yet.
 571           if (to < se[1])
 572           {
 573             Cache.log.warn("Ignoring invalid segment in InputData spec.");
 574           }
 575           else
 576           {
 577             if (se[0] > from)
 578             {
 579               view.deleteRange(offset + from - 1, offset + se[0] - 2);
 580               offset -= se[0] - from;
 581             }
 582             from = se[1] + 1;
 583           }
 584         }
 585         if (from < to)
 586         {
 587           view.deleteRange(offset + from - 1, offset + to - 1); // final
 588           // deletion -
 589           // TODO: check
 590           // off by
 591           // one for to
 592         }
 593         return new Object[]
 594         { new AlignmentView(view), jal };
 595       }
 596     }
 597     Cache.log
 598             .debug("Returning null for input data recovery from provenance.");
 599     return null;
 600   }
 601
 602   private AlignViewport getViewport(Vobject v_parent)
 603   {
 604     if (v_parent instanceof uk.ac.vamsas.objects.core.Alignment)
 605     {
 606       return datastore
 607               .findViewport((uk.ac.vamsas.objects.core.Alignment) v_parent);
 608     }
 609     return null;
 610   }
 611
 612   public NewickFile getNewickTree()
 613   {
 614     return ntree;
 615   }
 616
 617   public String getTitle()
 618   {
 619     return title;
 620   }
 621
 622   public AlignmentView getInputData()
 623   {
 624     return inputData;
 625   }
 626
 627   public boolean isValidTree()
 628   {
 629     try
 630     {
 631       if (ntree == null)
 632       {
 633         return false;
 634       }
 635       ntree.parse();
 636       if (ntree.getTree() != null)
 637       {
 638         ntree = getNtree();
 639       }
 640       return true;
 641     } catch (Exception e)
 642     {
 643       Cache.log.debug("Failed to parse newick tree string", e);
 644     }
 645     return false;
 646   }
 647 }