src/jalview/io/vamsas/Tree.java

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