2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.io.vamsas;
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;
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;
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;
54 public class Tree extends DatastoreItem
60 uk.ac.vamsas.objects.core.Tree tree;
62 uk.ac.vamsas.objects.core.Alignment alignment; // may be null => dataset or
65 private NewickFile ntree;
69 private AlignmentView inputData = null;
71 public static void updateFrom(VamsasAppDatastore datastore,
72 jalview.gui.AlignFrame alignFrame,
73 uk.ac.vamsas.objects.core.Tree vtree)
75 Tree toTree = new Tree(datastore, alignFrame, vtree);
78 public Tree(VamsasAppDatastore datastore,
79 jalview.gui.AlignFrame alignFrame,
80 uk.ac.vamsas.objects.core.Tree vtree)
82 super(datastore, vtree, TreePanel.class);
86 private NewickFile getNtree() throws IOException
88 return new jalview.io.NewickFile(tree.getNewick(0).getContent());
91 public Tree(VamsasAppDatastore datastore, TreePanel tp2, AlignmentI jal2,
92 uk.ac.vamsas.objects.core.Alignment alignment2)
94 super(datastore, tp2, uk.ac.vamsas.objects.core.Tree.class);
97 tp = (TreePanel) jvobj;
98 alignment = alignment2;
100 tree = (uk.ac.vamsas.objects.core.Tree) vobj;
107 * @see jalview.io.vamsas.DatastoreItem#addFromDocument()
110 public void addFromDocument()
112 tree = (uk.ac.vamsas.objects.core.Tree) vobj; // vtree;
113 TreePanel tp = (TreePanel) jvobj; // getvObj2jv(tree);
115 Object[] idata = recoverInputData(tree.getProvenance());
118 if (idata != null && idata[0] != null)
120 inputData = (AlignmentView) idata[0];
123 title = tree.getNewick(0).getTitle();
124 if (title == null || title.length() == 0)
126 title = tree.getTitle(); // hack!!!!
128 } catch (Exception e)
130 Cache.log.warn("Problems parsing treefile '"
131 + tree.getNewick(0).getContent() + "'", e);
138 * @see jalview.io.vamsas.DatastoreItem#conflict()
141 public void conflict()
144 .info("Update (with conflict) from vamsas document to alignment associated tree not implemented yet.");
150 * @see jalview.io.vamsas.DatastoreItem#update()
153 public void updateToDoc()
155 if (isModifiable(tree.getModifiable()))
157 // synchronize(); // update();
158 // verify any changes.
159 log.info("TODO: Update tree in document from jalview.");
164 log.info("TODO: Add the locally modified tree in Jalview as a new tree in document, leaving locked tree unchanged.");
171 * @see jalview.io.vamsas.DatastoreItem#updateFromDoc()
174 public void updateFromDoc()
176 // should probably just open a new tree panel in the same place as the old
178 // TODO: Tree.updateFromDoc
180 * TreePanel tp = (TreePanel) jvobj; // getvObj2jv(tree);
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); }
190 log.debug("Update the local tree in jalview from the document.");
192 if (isModifiable(tree.getModifiable()))
194 // synchronize(); // update();
195 // verify any changes.
196 log.debug("Update tree in document from jalview.");
201 log.debug("Add modified jalview tree as new tree in document.");
206 * correctly creates provenance for trees calculated on an alignment by
213 private Provenance makeTreeProvenance(AlignmentI jal, TreePanel tp)
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())
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
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(NJTree.NEIGHBOUR_JOINING);
243 // TODO: type of tree is a general parameter
244 int ranges[] = tp.getTree().seqData.getVisibleContigs();
245 // VisibleContigs are with respect to alignment coordinates. Still need
247 int start = tp.getTree().seqData.getAlignmentOrigin();
248 for (int r = 0; r < ranges.length; r += 2)
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);
257 Cache.log.debug("Finished Tree provenance for " + tp.getTitle());
262 * look up SeqCigars in an existing alignment.
266 * @return vector of alignment sequences in order of SeqCigar array (but
267 * missing unfound seqcigars)
269 private Vector findAlignmentSequences(AlignmentI jal, SeqCigar[] sequences)
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())
277 for (SequenceI asq : jalsqs)
279 for (int t = 0; t < sequences.length; t++)
282 && (tseqs[t].getRefSeq() == asq || tseqs[t].getRefSeq() == asq
283 .getDatasetSequence()))
284 // && tseqs[t].getStart()>=asq.getStart() &&
285 // tseqs[t].getEnd()<=asq.getEnd())
293 if (alsq.size() < sequences.length)
296 .warn("Not recovered all alignment sequences for given set of input sequence CIGARS");
303 * Update jalview newick representation with TreeNode map
306 * the treepanel that this tree is bound to.
308 public void UpdateSequenceTreeMap(TreePanel tp)
310 if (tp == null || tree == null)
315 if (tp.getTree() == null)
317 Cache.log.warn("Not updating SequenceTreeMap for "
318 + tree.getVorbaId());
321 Vector<SequenceNode> leaves = tp.getTree().findLeaves(
322 tp.getTree().getTopNode());
323 Treenode[] tn = tree.getTreenode(); // todo: select nodes for this
330 Treenode node = tn[i++];
331 BinaryNode mappednode = findNodeSpec(node.getNodespec(), leaves);
332 if (mappednode != null && mappednode instanceof SequenceNode)
334 SequenceNode leaf = (SequenceNode) mappednode;
335 // check if we can make the specified association
337 int vrf = 0, refv = 0;
338 while (jvseq == null && vrf < node.getVrefCount())
340 if (refv < node.getVref(vrf).getRefsCount())
342 Object noderef = node.getVref(vrf).getRefs(refv++);
343 if (noderef instanceof AlignmentSequence)
345 // we only make these kind of associations
346 jvseq = getvObj2jv((Vobject) noderef);
355 if (jvseq instanceof SequenceI)
357 leaf.setElement(jvseq);
358 leaf.setPlaceholder(false);
362 leaf.setPlaceholder(true);
363 leaf.setElement(new Sequence(leaf.getName(), "THISISAPLACEHLDER"));
369 // / TODO: refactor to vamsas :start
371 * construct treenode mappings for mapped sequences
377 public Treenode[] makeTreeNodes(NJTree ntree, Newick newick)
379 Vector<SequenceNode> leaves = ntree.findLeaves(ntree.getTopNode());
380 Vector tnv = new Vector();
381 Enumeration l = leaves.elements();
382 Hashtable nodespecs = new Hashtable();
383 while (l.hasMoreElements())
385 jalview.datamodel.BinaryNode tnode = (jalview.datamodel.BinaryNode) l
387 if (tnode instanceof jalview.datamodel.SequenceNode)
389 if (!((jalview.datamodel.SequenceNode) tnode).isPlaceholder())
391 Object assocseq = ((jalview.datamodel.SequenceNode) tnode)
393 if (assocseq instanceof SequenceI)
395 Vobject vobj = this.getjv2vObj(assocseq);
398 Treenode node = new Treenode();
399 if (newick.isRegisterable())
401 this.cdoc.registerObject(newick);
402 node.addTreeId(newick);
404 node.setNodespec(makeNodeSpec(nodespecs, tnode));
405 node.setName(tnode.getName());
406 Vref vr = new Vref();
409 tnv.addElement(node);
413 System.err.println("WARNING: Unassociated treeNode "
414 + tnode.element().toString()
416 + ((tnode.getName() != null) ? " label "
417 + tnode.getName() : ""));
425 Treenode[] tn = new Treenode[tnv.size()];
429 return new Treenode[] {};
432 private String makeNodeSpec(Hashtable nodespecs,
433 jalview.datamodel.BinaryNode tnode)
435 String nname = new String(tnode.getName());
436 Integer nindx = (Integer) nodespecs.get(nname);
439 nindx = new Integer(1);
441 nname = nindx.toString() + " " + nname;
446 * call to match up Treenode specs to NJTree parsed from document object.
450 * as returned from NJTree.findLeaves( .., ..) ..
453 private jalview.datamodel.BinaryNode findNodeSpec(String nodespec,
457 String nspec = nodespec.substring(nodespec.indexOf(' ') + 1);
458 String oval = nodespec.substring(0, nodespec.indexOf(' '));
461 occurence = new Integer(oval).intValue();
462 } catch (Exception e)
464 System.err.println("Invalid nodespec '" + nodespec + "'");
467 jalview.datamodel.BinaryNode bn = null;
470 Enumeration en = leaves.elements();
471 while (en.hasMoreElements() && nocc < occurence)
473 bn = (jalview.datamodel.BinaryNode) en.nextElement();
474 if (bn instanceof jalview.datamodel.SequenceNode
475 && bn.getName().equals(nspec))
487 // todo: end refactor to vamsas library
489 * add jalview object to vamsas document
493 public void addToDocument()
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));
505 alignment.addTree(tree);
509 * note: this function assumes that all sequence and alignment objects
510 * referenced in input data has already been associated with jalview objects.
514 * @return Object[] { AlignmentView, AlignmentI - reference alignment for
517 public Object[] recoverInputData(Provenance tp)
519 AlignmentViewport javport = null;
520 jalview.datamodel.AlignmentI jal = null;
521 jalview.datamodel.CigarArray view = null;
522 for (int pe = 0; pe < tp.getEntryCount(); pe++)
524 if (tp.getEntry(pe).getInputCount() > 0)
526 if (tp.getEntry(pe).getInputCount() > 1)
529 .warn("Ignoring additional input spec in provenance entry "
530 + tp.getEntry(pe).toString());
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)
537 if (tree.getV_parent() != null
538 && tree.getV_parent() instanceof uk.ac.vamsas.objects.core.Alignment)
540 javport = getViewport(tree.getV_parent());
541 jal = javport.getAlignment();
542 view = javport.getAlignment().getCompactAlignment();
547 // Explicit reference - to alignment, sequences or what.
548 if (vInput.getObjRefCount() == 1
549 && vInput.getObjRef(0) instanceof uk.ac.vamsas.objects.core.Alignment)
551 // recover an AlignmentView for the input data
552 javport = getViewport((Vobject) vInput.getObjRef(0));
553 jal = javport.getAlignment();
554 view = javport.getAlignment().getCompactAlignment();
556 else if (vInput.getObjRef(0) instanceof uk.ac.vamsas.objects.core.AlignmentSequence)
558 // recover an AlignmentView for the input data
559 javport = getViewport(((Vobject) vInput.getObjRef(0))
561 jal = javport.getAlignment();
562 jalview.datamodel.SequenceI[] seqs = new jalview.datamodel.SequenceI[vInput
564 for (int i = 0, iSize = vInput.getObjRefCount(); i < iSize; i++)
566 SequenceI seq = (SequenceI) getvObj2jv((Vobject) vInput
570 view = new jalview.datamodel.Alignment(seqs)
571 .getCompactAlignment();
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++)
579 Seg visSeg = vInput.getSeg(r);
580 int se[] = getSegRange(visSeg, true); // jalview doesn't do
581 // bidirection alignments yet.
584 Cache.log.warn("Ignoring invalid segment in InputData spec.");
590 view.deleteRange(offset + from - 1, offset + se[0] - 2);
591 offset -= se[0] - from;
598 view.deleteRange(offset + from - 1, offset + to - 1); // final
604 return new Object[] { new AlignmentView(view), jal };
608 .debug("Returning null for input data recovery from provenance.");
612 private AlignmentViewport getViewport(Vobject v_parent)
614 if (v_parent instanceof uk.ac.vamsas.objects.core.Alignment)
617 .findViewport((uk.ac.vamsas.objects.core.Alignment) v_parent);
622 public NewickFile getNewickTree()
627 public String getTitle()
632 public AlignmentView getInputData()
637 public boolean isValidTree()
646 if (ntree.getTree() != null)
651 } catch (Exception e)
653 Cache.log.debug("Failed to parse newick tree string", e);