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