1 package jalview.ext.archaeopteryx;
3 import jalview.analysis.TreeBuilder;
4 import jalview.datamodel.SequenceI;
5 import jalview.ext.forester.ForesterMatrix;
6 import jalview.ext.treeviewer.ExternalTreeBuilderI;
7 import jalview.ext.treeviewer.ExternalTreeI;
8 import jalview.ext.treeviewer.ExternalTreeNodeI;
9 import jalview.util.MappingUtils;
10 import jalview.util.MessageManager;
12 import java.util.HashMap;
15 import org.forester.evoinference.matrix.distance.DistanceMatrix;
16 import org.forester.phylogeny.Phylogeny;
17 import org.forester.phylogeny.PhylogenyNode;
20 * Class for converting trees made in Jalview (through TreeBuilder) to trees
21 * compatible with Forester (Phylogeny objects).
23 * Note that this currently demands a 1:1 relationship between tree nodes and
24 * the sequences used for generating them.
26 * @author kjvanderheide
29 public class AptxTreeBuilder
30 implements ExternalTreeBuilderI
32 protected final SequenceI[] sequences;
34 protected final DistanceMatrix distances;
36 protected final TreeBuilder jalviewTree;
38 public String treeTitle;
40 private final ExternalTreeI aptxTree;
42 private ExternalTreeNodeI rootNode;
44 private final Map<SequenceI, ExternalTreeNodeI> alignmentWithNodes;
46 private final Map<ExternalTreeNodeI, SequenceI> nodesWithAlignment;
48 public AptxTreeBuilder(final TreeBuilder calculatedTree)
50 jalviewTree = calculatedTree;
51 sequences = jalviewTree.getSequences();
52 distances = ForesterMatrix.convertJalviewToForester(
53 jalviewTree.getDistances(), sequences);
55 aptxTree = new Tree(new Phylogeny());
56 rootNode = new TreeNode(new PhylogenyNode());
58 int amountOfSequences = distances.getSize();
59 alignmentWithNodes = new HashMap<>(amountOfSequences);
60 nodesWithAlignment = new HashMap<>(amountOfSequences);
66 public ExternalTreeI buildTree(final ExternalTreeNodeI treeRoot)
82 public ExternalTreeI buildTree()
85 for (SequenceI sequence : sequences)
88 ExternalTreeNodeI sequenceNode = new TreeNode(
89 new PhylogenyNode(sequence.getName()));
91 sequenceNode.setSequence(sequence);
93 MappingUtils.putWithDuplicationCheck(nodesWithAlignment,
94 sequenceNode, sequence);
95 MappingUtils.putWithDuplicationCheck(alignmentWithNodes,
96 sequence, sequenceNode);
97 rootNode.addAsChild(sequenceNode);
101 aptxTree.setRoot(rootNode);
103 treeTitle = generateTreeName();
104 aptxTree.setTreeName(treeTitle);
111 public Map<SequenceI, ExternalTreeNodeI> getAlignmentBoundNodes()
113 return alignmentWithNodes;
117 public Map<ExternalTreeNodeI, SequenceI> getNodesBoundAlignment()
119 return nodesWithAlignment;
124 * Formats a localised title for the tree panel, like
126 * Neighbour Joining Using BLOSUM62
128 * For a tree loaded from file, just uses the file name
133 public String generateTreeName() // Move this and add selection region to the
134 // title when applicable
136 if (treeTitle != null) // will currently never happen, loaded tree file will
137 // take a different path
144 * i18n description of Neighbour Joining or Average Distance method
146 String treecalcnm = MessageManager
147 .getString("label.tree_calc_" + jalviewTree.getClass()
148 .getSimpleName().substring(0, 2).toLowerCase());
150 * short score model name (long description can be too long)
152 String smn = jalviewTree.getScoreModel().getName();
155 * put them together as <method> Using <model>
157 final String ttl = MessageManager
158 .formatMessage("label.treecalc_title", treecalcnm, smn);