2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
5 // Copyright (C) 2008-2009 Christian M. Zmasek
6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
7 // Copyright (C) 2000-2001 Washington University School of Medicine
8 // and Howard Hughes Medical Institute
9 // Copyright (C) 2003-2007 Ethalinda K.S. Cannon
10 // All rights reserved
12 // This library is free software; you can redistribute it and/or
13 // modify it under the terms of the GNU Lesser General Public
14 // License as published by the Free Software Foundation; either
15 // version 2.1 of the License, or (at your option) any later version.
17 // This library is distributed in the hope that it will be useful,
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 // Lesser General Public License for more details.
22 // You should have received a copy of the GNU Lesser General Public
23 // License along with this library; if not, write to the Free Software
24 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 // Contact: phylosoft @ gmail . com
27 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
29 package org.forester.archaeopteryx;
31 import java.awt.Color;
32 import java.io.BufferedReader;
34 import java.io.FileReader;
35 import java.io.IOException;
36 import java.io.InputStreamReader;
38 import java.util.Arrays;
39 import java.util.Hashtable;
41 import java.util.SortedMap;
42 import java.util.StringTokenizer;
43 import java.util.TreeMap;
45 import org.forester.archaeopteryx.Options.CLADOGRAM_TYPE;
46 import org.forester.archaeopteryx.Options.NODE_LABEL_DIRECTION;
47 import org.forester.archaeopteryx.Options.OVERVIEW_PLACEMENT_TYPE;
48 import org.forester.archaeopteryx.Options.PHYLOGENY_GRAPHICS_TYPE;
49 import org.forester.io.parsers.nhx.NHXParser.TAXONOMY_EXTRACTION;
50 import org.forester.phylogeny.data.NodeDataField;
51 import org.forester.phylogeny.data.NodeVisualData;
52 import org.forester.phylogeny.data.NodeVisualData.NodeFill;
53 import org.forester.phylogeny.data.NodeVisualData.NodeShape;
54 import org.forester.util.ForesterUtil;
56 public final class Configuration {
58 public enum EXT_NODE_DATA_RETURN_ON {
59 BUFFER_ONLY, CONSOLE, WINODW;
63 CROSSPLATFORM, NATIVE, NIMBUS, UNKNOWN
69 final static String clickto_options[][] = {
70 { "Display Node Data", "display" }, { "Collapse/Uncollapse", "display" }, { "Root/Reroot", "display" },
71 { "Go to Sub-/Super-Tree", "display" }, { "Swap Descendants", "display" },
72 { "Colorize Node(s)", "display" }, { "Change Node Font(s)", "display" },
73 { "Colorize Subtree(s)", "display" }, { "Open Sequence DB", "display" }, { "Open PDB", "display" },
74 { "Open Taxonomy DB", "display" }, { "Launch BLAST", "display" }, { "Cut Subtree", "display" },
75 { "Copy Subtree", "display" }, { "Paste Subtree", "display" }, { "Delete Subtree/Node", "display" },
76 { "Add New Node", "display" }, { "Edit Node Data", "display" }, { "Sort Descendants", "display" },
77 { "List Node Data", "display" }, { "Select Node(s)", "display" } };
78 private final static String DEFAULT_SPECIES_COLORS[][] = {
79 { "BRAFL", "0x00FFFF" }, { "SPHGR", "0x9620F0" }, { "STRPU", "0x9620F0" }, { "CIOIN", "0xFF1CAE" },
80 { "CIOSA", "0xFF2CAE" }, { "BOVIN", "0x5C3317" }, { "CANFA", "0x8B2323" }, { "HUMAN", "0xFF2400" },
81 { "PANTR", "0xCC2400" }, { "MOUSE", "0xFF7F00" }, { "RAT", "0xFFEF00" }, { "MONDO", "0xEE9A49" },
82 { "ORNAN", "0xCD853F" }, { "XENLA", "0x6BAA23" }, { "XENTR", "0x6BAA23" }, { "CHICK", "0xFFC125" },
83 { "FUGRU", "0x0000FF" }, { "BRARE", "0x0000DD" }, { "DANRE", "0x0000BB" }, { "TETNG", "0x0000AA" },
84 { "ORYLA", "0x000088" }, { "GASAC", "0x000066" }, { "CAEEL", "0x666699" }, { "CAEBR", "0xB0B0B0" },
85 { "DROME", "0x663366" }, { "DROPS", "0x996699" }, { "APIME", "0x7A7700" }, { "AEDAE", "0x8C5900" },
86 { "TRICA", "0x918E00" }, { "NEMVE", "0x0066CC" }, { "HYDVU", "0x3399FF" }, { "LUBBA", "0xF7B5CB" },
87 { "GEOCY", "0xF5A0BD" }, { "AMPQE", "0x009966" }, { "SUBDO", "0xC790B9" }, { "MONBE", "0xFC0FC0" },
88 { "DICPU", "0xFFCC33" }, { "DICDI", "0xFFCC00" }, { "ENTHI", "0x5959AB" }, { "ARATH", "0x00FF00" },
89 { "POPTR", "0x006400" }, { "VITVI", "0x00CD00" }, { "GLYMA", "0x00FF7F" }, { "ORYSA", "0x008B00" },
90 { "ORYSJ", "0x008C00" }, { "SORBI", "0x00EE76" }, { "SELMO", "0x238E23" }, { "PHYPA", "0x09F911" },
91 { "OSTLU", "0x7FFF00" }, { "OSTTA", "0x7FFF00" }, { "OSTRC", "0x7FFF00" }, { "MICPU", "0x66CD00" },
92 { "MIC99", "0x66CD00" }, { "CHLRE", "0xB3EE3A" }, { "VOLCA", "0xC0FF3E" }, { "CHLSP", "0x6B8E23" },
93 { "CYAME", "0xD02090" }, { "YEAST", "0xAAAAAA" }, { "BACFR", "0xFF0000" }, { "BACTN", "0xFFFF00" },
94 { "MYXXD", "0x0000FF" }, { "STIAU", "0x00FFFF" }, { "BACOV", "0x8C5900" }, { "BACUN", "0x66CD00" },
95 { "PORGI", "0x918E00" } };
96 final static int display_node_data = 0;
97 final static int collapse_uncollapse = 1;
98 final static int reroot = 2;
99 final static int subtree = 3;
100 final static int swap = 4;
101 final static int color_node_font = 5;
102 final static int change_node_font = 6;
103 final static int color_subtree = 7;
104 final static int open_seq_web = 8;
105 final static int open_pdb_web = 9;
106 final static int open_tax_web = 10;
107 final static int blast = 11;
108 final static int cut_subtree = 12;
109 final static int copy_subtree = 13;
110 final static int paste_subtree = 14;
111 final static int delete_subtree_or_node = 15;
112 final static int add_new_node = 16;
113 final static int edit_node_data = 17;
114 final static int sort_descendents = 18;
115 final static int get_ext_desc_data = 19;
116 final static int select_nodes = 20;
117 // ------------------
119 // ------------------
120 final static String display_options[][] = {
121 { "Phylogram", "display", "?" }, { "Node Name", "display", "yes" }, { "Taxonomy Code", "display", "yes" },
122 { "Seq Annotations", "display", "no" }, { "Confidence Values", "display", "?" },
123 { "Node Events", "display", "?" }, { "Colorize by Taxonomy", "display", "no" },
124 { "Colorize by Sequence", "display", "no" }, { "Visual Styles/Branch Colors", "display", "no" },
125 { "Branch Widths", "display", "no" }, { "Domain Architectures", "display", "no" },
126 { "Binary Characters", "nodisplay", "no" }, { "Binary Char Counts", "nodisplay", "no" },
127 { "Seq Name", "display", "yes" }, { "Seq Accession", "display", "no" },
128 { "Show Internal Data", "display", "yes" }, { "Dyna Hide", "display", "yes" },
129 { "Taxonomy Scientific", "display", "yes" }, { "Taxonomy Common", "display", "no" },
130 { "Colorize by Annotation", "display", "no" }, { "Seq Symbol", "display", "yes" },
131 { "Rollover", "display", "yes" }, { "Relation Confidence", "nodisplay", "no" },
132 { "Vector Data", "nodisplay", "no" }, { "Taxonomy Images", "display", "no" },
133 { "Properties", "display", "no" }, { "Gene Name", "display", "yes" },
134 { "Multiple Seq Alignment", "display", "no" }, { "Branch Length Values", "display", "no" } };
135 final static int display_as_phylogram = 0;
136 final static int show_node_names = 1;
137 final static int show_tax_code = 2;
138 final static int show_annotation = 3;
139 final static int write_confidence_values = 4;
140 final static int write_events = 5;
141 final static int color_according_to_species = 6;
142 final static int color_according_to_sequence = 7;
143 final static int use_style = 8;
144 final static int width_branches = 9;
145 final static int show_domain_architectures = 10;
146 final static int show_binary_characters = 11;
147 final static int show_binary_character_counts = 12;
148 final static int show_seq_names = 13;
149 final static int show_sequence_acc = 14;
150 final static int display_internal_data = 15;
151 final static int dynamically_hide_data = 16;
152 final static int show_taxonomy_scientific_names = 17;
153 final static int show_taxonomy_common_names = 18;
154 final static int color_according_to_annotation = 19;
155 final static int show_seq_symbols = 20;
156 final static int node_data_popup = 21;
157 final static int show_relation_confidence = 22;
158 final static int show_vector_data = 23;
159 final static int show_taxonomy_images = 24;
160 final static int show_properties = 25;
161 final static int show_gene_names = 26;
162 final static int show_mol_seqs = 27;
163 final static int write_branch_length_values = 28;
164 static final String VALIDATE_AGAINST_PHYLOXML_XSD_SCHEMA = "validate_against_phyloxml_xsd_schema";
165 private static Hashtable<String, Color> _sequence_colors;
166 private static Hashtable<String, Color> _annotation_colors;
167 private static Hashtable<String, Color> _domain_colors;
168 private static Hashtable<String, Color> _species_colors;
169 private static String DEFAULT_FONT_FAMILY = "";
170 private static final int DEPRECATED = -2;
171 private static final String DISPLAY_COLOR_KEY = "display_color";
172 // ---------------------------
173 // Display options for trees
174 // ---------------------------
175 // ---------------------------------
176 // Pertaining to the config itself
177 // ---------------------------------
178 // Full path to config (may be URL)
179 String config_filename;
180 // This option is selected in the dropdown
181 int default_clickto = Configuration.display_node_data;
182 String default_config_filename = AptxConstants.DEFAULT_CONFIGURATION_FILE_NAME;
186 TreeColorSet tree_color_set;
190 TreeFontSet tree_font_set;
191 boolean verbose = AptxConstants.VERBOSE_DEFAULT;
192 private boolean _abbreviate_scientific_names = false;
193 private boolean _antialias_screen = true;
194 private boolean _background_color_gradient = false;
195 private String _base_font_family_name = "";
196 private int _base_font_size = -1;
197 private CLADOGRAM_TYPE _cladogram_type = AptxConstants.CLADOGRAM_TYPE_DEFAULT;
198 private boolean _color_labels_same_as_parent_branch = false;
199 private int _default_bootstrap_samples = -1;
200 private NodeFill _default_node_fill = NodeFill.SOLID;
201 private NodeShape _default_node_shape = NodeShape.RECTANGLE;
202 private short _default_node_shape_size = AptxConstants.DEFAULT_NODE_SHAPE_SIZE_DEFAULT;
203 private SortedMap<String, Color> _display_colors = null;
204 private boolean _display_sequence_relations = false;
205 private boolean _editable = true;
206 private NodeDataField _ext_desc_data_to_return = NodeDataField.UNKNOWN;
207 private EXT_NODE_DATA_RETURN_ON _ext_node_data_return_on = EXT_NODE_DATA_RETURN_ON.WINODW;
208 private int _frame_x_size;
209 private int _frame_y_size;
210 private Color _gui_background_color = AptxConstants.GUI_BACKGROUND_DEFAULT;
211 private Color _gui_button_background_color = AptxConstants.BUTTON_BACKGROUND_COLOR_DEFAULT;
212 private Color _gui_button_border_color = AptxConstants.BUTTON_BORDER_COLOR_DEFAULT;
213 private Color _gui_button_text_color = AptxConstants.BUTTON_TEXT_COLOR_DEFAULT;
214 private Color _gui_checkbox_and_button_active_color = AptxConstants.CHECKBOX_AND_BUTTON_ACTIVE_COLOR_DEFAULT;
215 private Color _gui_checkbox_text_color = AptxConstants.CHECKBOX_TEXT_COLOR_DEFAULT;
216 private Color _gui_menu_background_color = AptxConstants.MENU_BACKGROUND_COLOR_DEFAULT;
217 private Color _gui_menu_text_color = AptxConstants.MENU_TEXT_COLOR_DEFAULT;
218 private boolean _hide_controls_and_menus = false;
219 private boolean _internal_number_are_confidence_for_nh_parsing = false;
220 private String _label_for_get_ext_descendents_data = "";
221 private int _max_base_font_size = 20;
222 private boolean _midpoint_root = false;
223 private int _min_base_font_size = 2;
224 private double _min_confidence_value = Options.MIN_CONFIDENCE_DEFAULT;
225 private boolean _nh_parsing_replace_underscores = false;
226 private NODE_LABEL_DIRECTION _node_label_direction = NODE_LABEL_DIRECTION.HORIZONTAL;
227 private short _number_of_digits_after_comma_for_branch_length_values = AptxConstants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_BRANCH_LENGTH_VALUES_DEFAULT;
228 private short _number_of_digits_after_comma_for_confidence_values = AptxConstants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_CONFIDENCE_VALUES_DEFAULT;
229 private short _ov_max_height = 80;
230 private short _ov_max_width = 80;
231 private OVERVIEW_PLACEMENT_TYPE _ov_placement = OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT;
232 private File _path_to_local_fastme = null;
233 private File _path_to_local_mafft = null;
234 private File _path_to_local_raxml = null;
235 private PHYLOGENY_GRAPHICS_TYPE _phylogeny_graphics_type = PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR;
236 private float _print_line_width = AptxConstants.PDF_LINE_WIDTH_DEFAULT;
237 private boolean _show_annotation_ref_source = true;
238 private boolean _show_default_node_shapes_external = false;
239 private boolean _show_default_node_shapes_for_marked_nodes = false;
240 private boolean _show_default_node_shapes_internal = false;
241 private boolean _show_domain_labels = true;
242 private boolean _show_overview = true;
243 private boolean _show_scale = false;
244 private TAXONOMY_EXTRACTION _taxonomy_extraction = TAXONOMY_EXTRACTION.NO;
245 private UI _ui = UI.UNKNOWN;
246 private boolean _use_tabbed_display = false;
247 private boolean _validate_against_phyloxml_xsd_schema = AptxConstants.VALIDATE_AGAINST_PHYLOXML_XSD_SCJEMA_DEFAULT;
248 private Color _vector_data_min_color = Color.BLUE;
249 private Color _vector_data_max_color = Color.YELLOW;
250 private Color _vector_data_mean_color = Color.WHITE;
251 private double _vector_data_height = 12;
252 private int _vector_data_width = 120;
253 private boolean _line_up_renderable_node_data = true;
254 private boolean _right_align_domains = false;
255 private boolean _allow_thick_strokes = false;
256 private boolean _could_read_config_file = false;
258 for( final String font_name : AptxConstants.DEFAULT_FONT_CHOICES ) {
259 if ( Arrays.binarySearch( AptxUtil.getAvailableFontFamiliesSorted(), font_name ) >= 0 ) {
260 DEFAULT_FONT_FAMILY = font_name;
264 if ( ForesterUtil.isEmpty( DEFAULT_FONT_FAMILY ) ) {
265 DEFAULT_FONT_FAMILY = AptxConstants.DEFAULT_FONT_CHOICES[ AptxConstants.DEFAULT_FONT_CHOICES.length - 1 ];
269 public Configuration() {
270 this( null, false, false, false );
273 public Configuration( final String cf, final boolean is_url, final boolean is_applet, final boolean verbose ) {
274 if ( ForesterUtil.isEmpty( cf ) ) {
275 config_filename = default_config_filename;
278 config_filename = cf;
280 _could_read_config_file = false;
281 setDisplayColors( new TreeMap<String, Color>() );
282 config_filename = config_filename.trim();
285 // If URL, open accordingly
287 u = new URL( config_filename );
289 final InputStreamReader isr = new InputStreamReader( u.openStream() );
290 final BufferedReader bf = new BufferedReader( isr );
293 ForesterUtil.programMessage( AptxConstants.PRG_NAME, "successfully read from configuration url ["
294 + config_filename + "]" );
295 _could_read_config_file = true;
297 catch ( final Exception e ) {
298 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "failed to read configuration from ["
299 + config_filename + "]: " + e.getLocalizedMessage() );
302 catch ( final Exception e ) {
303 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "cannot find or open configuration url ["
304 + config_filename + "]" );
308 // Otherwise, open as a file
309 File f = new File( config_filename );
311 f = new File( config_filename + ".txt" );
313 if ( f.exists() && f.canRead() ) {
315 final BufferedReader bf = new BufferedReader( new FileReader( f ) );
318 _could_read_config_file = true;
320 catch ( final Exception e ) {
322 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "failed to read configuration from ["
323 + config_filename + "]: " + e );
329 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "cannot find or open configuration file ["
330 + config_filename + "]" );
336 public String getBaseFontFamilyName() {
337 return _base_font_family_name;
340 public int getDefaultBootstrapSamples() {
341 return _default_bootstrap_samples;
344 public NodeFill getDefaultNodeFill() {
345 return _default_node_fill;
348 public NodeShape getDefaultNodeShape() {
349 return _default_node_shape;
352 public short getDefaultNodeShapeSize() {
353 return _default_node_shape_size;
356 public NodeDataField getExtDescNodeDataToReturn() {
357 return _ext_desc_data_to_return;
360 public EXT_NODE_DATA_RETURN_ON getExtNodeDataReturnOn() {
361 return _ext_node_data_return_on;
364 public int getFrameXSize() {
365 return _frame_x_size;
368 public int getFrameYSize() {
369 return _frame_y_size;
372 public String getLabelForGetExtDescendentsData() {
373 return _label_for_get_ext_descendents_data;
376 public File getPathToLocalFastme() {
377 return _path_to_local_fastme;
380 public File getPathToLocalMafft() {
381 return _path_to_local_mafft;
384 public File getPathToLocalRaxml() {
385 return _path_to_local_raxml;
388 public double getVectorDataHeight() {
389 return _vector_data_height;
392 public Color getVectorDataMaxColor() {
393 return _vector_data_max_color;
396 public Color getVectorDataMeanColor() {
397 return _vector_data_mean_color;
400 public Color getVectorDataMinColor() {
401 return _vector_data_min_color;
404 public int getVectorDataWidth() {
405 return _vector_data_width;
408 public boolean isAbbreviateScientificTaxonNames() {
409 return _abbreviate_scientific_names;
412 public boolean isAllowThickStrokes() {
413 return _allow_thick_strokes;
416 public boolean isBackgroundColorGradient() {
417 return _background_color_gradient;
420 public boolean isColorByTaxonomicGroup() {
424 public boolean isColorLabelsSameAsParentBranch() {
425 return _color_labels_same_as_parent_branch;
428 final public boolean isLineUpRendarableNodeData() {
429 return _line_up_renderable_node_data;
432 public boolean isMidpointReroot() {
433 return _midpoint_root;
436 final public boolean isRightLineUpDomains() {
437 return _right_align_domains;
440 public boolean isShowAnnotationRefSource() {
441 return _show_annotation_ref_source;
444 public boolean isShowDefaultNodeShapesExternal() {
445 return _show_default_node_shapes_external;
448 public boolean isShowDefaultNodeShapesForMarkedNodes() {
449 return _show_default_node_shapes_for_marked_nodes;
452 public boolean isShowDefaultNodeShapesInternal() {
453 return _show_default_node_shapes_internal;
456 public boolean isShowDomainLabels() {
457 return _show_domain_labels;
460 public void putDisplayColors( final String key, final Color color ) {
461 getDisplayColors().put( key, color );
464 public void setAbbreviateScientificTaxonNames( final boolean abbreviate_scientific_names ) {
465 _abbreviate_scientific_names = abbreviate_scientific_names;
468 public void setAddTaxonomyImagesCB( final boolean b ) {
469 display_options[ show_taxonomy_images ][ 1 ] = b ? "yes" : "no";
472 public void setBackgroundColorGradient( final boolean background_color_gradient ) {
473 _background_color_gradient = background_color_gradient;
476 public void setBaseFontFamilyName( final String base_font_family_name ) {
477 _base_font_family_name = base_font_family_name;
480 public void setBaseFontSize( final int base_font_size ) {
481 _base_font_size = base_font_size;
484 public void setColorizeBranches( final boolean b ) {
485 display_options[ use_style ][ 2 ] = b ? "yes" : "no";
488 public void setColorLabelsSameAsParentBranch( final boolean color_labels_same_as_parent_branch ) {
489 _color_labels_same_as_parent_branch = color_labels_same_as_parent_branch;
492 public void setDefaultNodeFill( final NodeFill default_node_fill ) {
493 _default_node_fill = default_node_fill;
496 public void setDefaultNodeShape( final NodeShape default_node_shape ) {
497 _default_node_shape = default_node_shape;
500 public void setDefaultNodeShapeSize( final short default_node_shape_size ) {
501 _default_node_shape_size = default_node_shape_size;
504 public void setDisplayAsPhylogram( final boolean b ) {
505 display_options[ display_as_phylogram ][ 2 ] = b ? "yes" : "no";
508 public void setDisplayColors( final SortedMap<String, Color> display_colors ) {
509 _display_colors = display_colors;
512 public void setDisplayConfidenceValues( final boolean b ) {
513 display_options[ write_confidence_values ][ 2 ] = b ? "yes" : "no";
516 public void setDisplayGeneNames( final boolean b ) {
517 display_options[ show_gene_names ][ 2 ] = b ? "yes" : "no";
520 public void setDisplayInternalData( final boolean b ) {
521 display_options[ display_internal_data ][ 2 ] = b ? "yes" : "no";
524 public void setDisplayMultipleSequenceAlignment( final boolean b ) {
525 display_options[ show_mol_seqs ][ 2 ] = b ? "yes" : "no";
528 public void setDisplayNodeNames( final boolean b ) {
529 display_options[ show_node_names ][ 2 ] = b ? "yes" : "no";
532 public void setDisplaySequenceAcc( final boolean b ) {
533 display_options[ show_sequence_acc ][ 2 ] = b ? "yes" : "no";
536 public void setDisplaySequenceNames( final boolean b ) {
537 display_options[ show_seq_names ][ 2 ] = b ? "yes" : "no";
540 public void setDisplaySequenceRelations( final boolean display_sequence_relations ) {
541 _display_sequence_relations = display_sequence_relations;
544 public void setDisplaySequenceSymbols( final boolean b ) {
545 display_options[ show_seq_symbols ][ 2 ] = b ? "yes" : "no";
548 public void setDisplayTaxonomyCode( final boolean b ) {
549 display_options[ show_tax_code ][ 2 ] = b ? "yes" : "no";
552 public void setDisplayTaxonomyCommonNames( final boolean b ) {
553 display_options[ show_taxonomy_common_names ][ 2 ] = b ? "yes" : "no";
556 public void setDisplayTaxonomyImages( final boolean b ) {
557 display_options[ show_taxonomy_images ][ 2 ] = b ? "yes" : "no";
560 public void setDisplayTaxonomyScientificNames( final boolean b ) {
561 display_options[ show_taxonomy_scientific_names ][ 2 ] = b ? "yes" : "no";
564 public void setDynamicallyHideData( final boolean b ) {
565 display_options[ dynamically_hide_data ][ 2 ] = b ? "yes" : "no";
568 public void setExtDescNodeDataToReturn( final NodeDataField ext_desc_data_to_return ) {
569 _ext_desc_data_to_return = ext_desc_data_to_return;
572 public void setFrameXSize( final int frame_x_size ) {
573 _frame_x_size = frame_x_size;
576 public void setFrameYSize( final int frame_y_size ) {
577 _frame_y_size = frame_y_size;
580 final public void setLineUpRendarableNodeData( final boolean line_up_renderable_node_data ) {
581 _line_up_renderable_node_data = line_up_renderable_node_data;
584 public void setMidpointReroot( final boolean midpoint_root ) {
585 _midpoint_root = midpoint_root;
588 public void setMinConfidenceValue( final double min_confidence_value ) {
589 _min_confidence_value = min_confidence_value;
592 public void setNodeLabelDirection( final NODE_LABEL_DIRECTION node_label_direction ) {
593 _node_label_direction = node_label_direction;
596 public void setNumberOfDigitsAfterCommaForBranchLengthValue( final short number_of_digits_after_comma_for_branch_length_values ) {
597 _number_of_digits_after_comma_for_branch_length_values = number_of_digits_after_comma_for_branch_length_values;
600 public void setNumberOfDigitsAfterCommaForConfidenceValues( final short number_of_digits_after_comma_for_confidence_values ) {
601 _number_of_digits_after_comma_for_confidence_values = number_of_digits_after_comma_for_confidence_values;
604 public void setPhylogenyGraphicsType( final PHYLOGENY_GRAPHICS_TYPE phylogeny_graphics_type ) {
605 _phylogeny_graphics_type = phylogeny_graphics_type;
608 public void setPrintLineWidth( final float print_line_width ) {
609 _print_line_width = print_line_width;
612 public void setReplaceUnderscoresInNhParsing( final boolean nh_parsing_replace_underscores ) {
613 _nh_parsing_replace_underscores = nh_parsing_replace_underscores;
616 final public void setRightLineUpDomains( final boolean right_align_domains ) {
617 _right_align_domains = right_align_domains;
620 public void setShowDefaultNodeShapesExternal( final boolean show_default_node_shapes_external ) {
621 _show_default_node_shapes_external = show_default_node_shapes_external;
624 public void setShowDefaultNodeShapesForMarkedNodes( final boolean show_default_node_shapes_for_marked_nodes ) {
625 _show_default_node_shapes_for_marked_nodes = show_default_node_shapes_for_marked_nodes;
628 public void setShowDefaultNodeShapesInternal( final boolean show_default_node_shapes_internal ) {
629 _show_default_node_shapes_internal = show_default_node_shapes_internal;
632 public void setShowDomainLabels( final boolean show_domain_labels ) {
633 _show_domain_labels = show_domain_labels;
636 public void setShowScale( final boolean show_scale ) {
637 _show_scale = show_scale;
640 public void setUseStyle( final boolean b ) {
641 display_options[ use_style ][ 2 ] = b ? "yes" : "no";
644 private int getClickToIndex( final String name ) {
646 if ( name.equals( "edit_info" ) ) {
647 index = Configuration.display_node_data;
649 .printWarningMessage( AptxConstants.PRG_NAME,
650 "configuration key [edit_info] is deprecated, use [display node data] instead" );
652 else if ( name.equals( "display_node_data" ) ) {
653 index = Configuration.display_node_data;
655 else if ( name.equals( "collapse_uncollapse" ) ) {
656 index = Configuration.collapse_uncollapse;
658 else if ( name.equals( "reroot" ) ) {
659 index = Configuration.reroot;
661 else if ( name.equals( "subtree" ) ) {
662 index = Configuration.subtree;
664 else if ( name.equals( "swap" ) ) {
665 index = Configuration.swap;
667 else if ( name.equals( "sort_descendants" ) ) {
668 index = Configuration.sort_descendents;
670 else if ( name.equals( "get_ext_descendents_data" ) ) {
671 index = Configuration.get_ext_desc_data;
673 else if ( name.equals( "display_sequences" ) ) {
675 .printWarningMessage( AptxConstants.PRG_NAME, "configuration key [display_sequences] is deprecated" );
678 else if ( name.equals( "open_seq_web" ) ) {
679 index = Configuration.open_seq_web;
681 else if ( name.equals( "open_pdb_web" ) ) {
682 index = Configuration.open_pdb_web;
684 else if ( name.equals( "open_tax_web" ) ) {
685 index = Configuration.open_tax_web;
687 else if ( name.equals( "blast" ) ) {
688 index = Configuration.blast;
690 else if ( name.equals( "cut_subtree" ) ) {
691 index = Configuration.cut_subtree;
693 else if ( name.equals( "copy_subtree" ) ) {
694 index = Configuration.copy_subtree;
696 else if ( name.equals( "paste_subtree" ) ) {
697 index = Configuration.paste_subtree;
699 else if ( name.equals( "delete" ) ) {
700 index = Configuration.delete_subtree_or_node;
702 else if ( name.equals( "add_new_node" ) ) {
703 index = Configuration.add_new_node;
705 else if ( name.equals( "edit_node_data" ) ) {
706 index = Configuration.edit_node_data;
708 else if ( name.equals( "select_nodes" ) ) {
709 index = Configuration.select_nodes;
711 else if ( name.equals( "display_node_popup" ) ) {
712 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME,
713 "configuration key [display_node_popup] is deprecated" );
716 else if ( name.equals( "custom_option" ) ) {
717 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "configuration key [custom_option] is deprecated" );
720 else if ( name.equals( "color_subtree" ) ) {
721 index = Configuration.color_subtree;
723 else if ( name.equals( "change_node_font" ) ) {
724 index = Configuration.change_node_font;
726 else if ( name.equals( "color_node_font" ) ) {
727 index = Configuration.color_node_font;
729 else if ( name.equals( "color_subtree" ) ) {
730 index = Configuration.color_subtree;
735 private final void initSpeciesColors() {
736 _species_colors = new Hashtable<String, Color>();
737 for( final String[] s : DEFAULT_SPECIES_COLORS ) {
738 _species_colors.put( s[ 0 ], Color.decode( s[ 1 ] ) );
742 private boolean parseBoolean( final String str ) {
743 final String my_str = str.trim().toLowerCase();
744 if ( my_str.equals( "yes" ) || my_str.equals( "true" ) ) {
747 else if ( my_str.equals( "no" ) || my_str.equals( "false" ) ) {
751 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "could not parse boolean value from [" + str + "]" );
756 private double parseDouble( final String str ) {
759 d = Double.parseDouble( str.trim() );
761 catch ( final Exception e ) {
762 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "could not parse double from [" + str + "]" );
768 private float parseFloat( final String str ) {
771 f = Float.parseFloat( str.trim() );
773 catch ( final Exception e ) {
774 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "could not parse float from [" + str + "]" );
780 private int parseInt( final String str ) {
783 i = Integer.parseInt( str.trim() );
785 catch ( final Exception e ) {
786 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "could not parse integer from [" + str + "]" );
792 private short parseShort( final String str ) {
795 i = Short.parseShort( str.trim() );
797 catch ( final Exception e ) {
798 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "could not parse short from [" + str + "]" );
804 private void processFontFamily( final StringTokenizer st ) {
805 setBaseFontFamilyName( "" );
806 final String font_str = ( ( String ) st.nextElement() ).trim();
807 final String[] fonts = font_str.split( ",+" );
808 for( String font : fonts ) {
809 font = font.replace( '_', ' ' ).trim();
810 if ( Arrays.binarySearch( AptxUtil.getAvailableFontFamiliesSorted(), font ) >= 0 ) {
811 setBaseFontFamilyName( font );
818 * read each line of config file, process non-comment lines
819 * @throws IOException
821 private void readConfig( final BufferedReader conf_in ) throws IOException {
824 line = conf_in.readLine();
825 if ( line != null ) {
827 // skip comments and blank lines
828 if ( !line.startsWith( "#" ) && ( !ForesterUtil.isEmpty( line ) ) ) {
829 // convert runs of spaces to tabs
830 line = line.replaceAll( "\\s+", "\t" );
831 final StringTokenizer st = new StringTokenizer( line, "\t" );
835 } while ( line != null );
838 private void setAntialiasScreen( final boolean antialias_screen ) {
839 _antialias_screen = antialias_screen;
842 private void setCladogramType( final CLADOGRAM_TYPE cladogram_type ) {
843 _cladogram_type = cladogram_type;
846 private void setDefaultBootstrapSamples( final int default_bootstrap_samples ) {
847 _default_bootstrap_samples = default_bootstrap_samples;
850 private void setEditable( final boolean editable ) {
851 _editable = editable;
854 private void setExtNodeDataReturnOn( final EXT_NODE_DATA_RETURN_ON ext_node_data_return_on ) {
855 _ext_node_data_return_on = ext_node_data_return_on;
858 //private void setGraphicsExportX( final int graphics_export_x ) {
859 // _graphics_export_x = graphics_export_x;
862 //private void setGraphicsExportY( final int graphics_export_y ) {
863 // _graphics_export_y = graphics_export_y;
866 private void setInternalNumberAreConfidenceForNhParsing( final boolean internal_number_are_confidence_for_nh_parsing ) {
867 _internal_number_are_confidence_for_nh_parsing = internal_number_are_confidence_for_nh_parsing;
871 * Set a key-value(s) tuple
873 private void setKeyValue( final StringTokenizer st ) {
874 final String key = ( ( String ) st.nextElement() ).replace( ':', ' ' ).trim().toLowerCase();
875 if ( !st.hasMoreElements() ) {
878 // Handle single value settings first:
879 if ( key.equals( "default_click_to" ) ) {
880 final String clickto_name = ( String ) st.nextElement();
881 default_clickto = getClickToIndex( clickto_name );
882 if ( default_clickto == -1 ) {
883 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "invalid value [" + clickto_name
884 + "] for [default_click_to]" );
887 else if ( default_clickto == DEPRECATED ) {
891 else if ( key.equals( "native_ui" ) ) {
892 final String my_str = ( ( String ) st.nextElement() ).trim().toLowerCase();
893 if ( my_str.equals( "yes" ) || my_str.equals( "true" ) ) {
896 else if ( my_str.equals( "no" ) || my_str.equals( "false" ) ) {
897 _ui = UI.CROSSPLATFORM;
899 else if ( my_str.equals( "?" ) ) {
903 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "could not parse yes/no/? value from [" + my_str
908 else if ( key.equals( VALIDATE_AGAINST_PHYLOXML_XSD_SCHEMA ) ) {
909 setValidatePhyloXmlAgainstSchema( parseBoolean( ( String ) st.nextElement() ) );
911 else if ( key.equals( "antialias_screen" ) ) {
912 setAntialiasScreen( parseBoolean( ( String ) st.nextElement() ) );
914 else if ( key.equals( "phylogeny_graphics_type" ) ) {
915 final String type_str = ( ( String ) st.nextElement() ).trim();
916 if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.CONVEX.toString() ) ) {
917 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.CONVEX );
919 else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.CURVED.toString() ) ) {
920 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.CURVED );
922 else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.EURO_STYLE.toString() ) ) {
923 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.EURO_STYLE );
925 else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.ROUNDED.toString() ) ) {
926 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.ROUNDED );
928 else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR.toString() ) ) {
929 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR );
931 else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.TRIANGULAR.toString() ) ) {
932 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.TRIANGULAR );
934 else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.UNROOTED.toString() ) ) {
935 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.UNROOTED );
937 else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.CIRCULAR.toString() ) ) {
938 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.CIRCULAR );
941 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR );
942 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + type_str
943 + "] for [phylogeny_graphics_type]" );
946 else if ( key.equals( "min_confidence_value" ) ) {
947 final String mcv_str = ( ( String ) st.nextElement() ).trim();
948 final double d = parseDouble( mcv_str );
949 setMinConfidenceValue( d );
951 else if ( key.equals( "font_family" ) ) {
952 processFontFamily( st );
954 else if ( key.equals( "font_size" ) ) {
955 final String size_str = ( ( String ) st.nextElement() ).trim();
956 final int i = parseInt( size_str );
958 setBaseFontSize( i );
961 else if ( key.equals( "font_size_min" ) ) {
962 final String size_str = ( ( String ) st.nextElement() ).trim();
963 final int i = parseInt( size_str );
965 setMinBaseFontSize( i );
968 else if ( key.equals( "font_size_max" ) ) {
969 final String size_str = ( ( String ) st.nextElement() ).trim();
970 final int i = parseInt( size_str );
972 setMaxBaseFontSize( i );
975 else if ( key.equals( "graphics_export_x" ) ) {
976 // final String str = ( ( String ) st.nextElement() ).trim();
977 // final int i = parseInt( str );
979 // setGraphicsExportX( i );
982 else if ( key.equals( "graphics_export_y" ) ) {
983 //final String str = ( ( String ) st.nextElement() ).trim();
984 // final int i = parseInt( str );
986 // setGraphicsExportY( i );
989 else if ( key.equals( "pdf_export_line_width" ) ) {
990 final String str = ( ( String ) st.nextElement() ).trim();
991 final float f = parseFloat( str );
993 setPrintLineWidth( f );
996 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME,
997 "value for [pdf_export_line_width] cannot be zero or negative" );
1000 else if ( key.equals( "window_initial_size_x" ) ) {
1001 final String str = ( ( String ) st.nextElement() ).trim();
1002 final int i = parseInt( str );
1007 else if ( key.equals( "window_initial_size_y" ) ) {
1008 final String str = ( ( String ) st.nextElement() ).trim();
1009 final int i = parseInt( str );
1014 else if ( key.equals( "default_number_of_bootstrap_resamples" ) ) {
1015 final String str = ( ( String ) st.nextElement() ).trim();
1016 final int i = parseInt( str );
1018 setDefaultBootstrapSamples( i );
1022 .printWarningMessage( AptxConstants.PRG_NAME,
1023 "value for [default_number_of_bootstrap_resamples] cannot be negative" );
1026 else if ( key.equals( "mafft_local" ) ) {
1027 final String str = ( ( String ) st.nextElement() ).trim();
1028 if ( !ForesterUtil.isEmpty( str ) ) {
1029 setPathToLocalMafft( new File( str ) );
1032 else if ( key.equals( "fastme_local" ) ) {
1033 final String str = ( ( String ) st.nextElement() ).trim();
1034 if ( !ForesterUtil.isEmpty( str ) ) {
1035 setPathToLocalFastme( new File( str ) );
1038 else if ( key.equals( "raxml_local" ) ) {
1039 final String str = ( ( String ) st.nextElement() ).trim();
1040 if ( !ForesterUtil.isEmpty( str ) ) {
1041 setPathToLocalRaxml( new File( str ) );
1044 else if ( key.equals( "show_scale" ) ) {
1045 setShowScale( parseBoolean( ( String ) st.nextElement() ) );
1047 else if ( key.equals( "show_overview" ) ) {
1048 setShowOverview( parseBoolean( ( String ) st.nextElement() ) );
1050 else if ( key.equals( "background_gradient" ) ) {
1051 setBackgroundColorGradient( parseBoolean( ( String ) st.nextElement() ) );
1053 else if ( key.equals( "color_labels_same_as_branch_length_values" ) ) {
1054 setColorLabelsSameAsParentBranch( parseBoolean( ( String ) st.nextElement() ) );
1056 else if ( key.equals( "show_domain_labels" ) ) {
1057 setShowDomainLabels( parseBoolean( ( String ) st.nextElement() ) );
1059 else if ( key.equals( "show_seq_annotation_ref_sources" ) ) {
1060 setShowAnnotationRefSource( parseBoolean( ( String ) st.nextElement() ) );
1062 else if ( key.equals( "abbreviate_scientific_names" ) ) {
1063 setAbbreviateScientificTaxonNames( parseBoolean( ( String ) st.nextElement() ) );
1065 else if ( key.equals( "cladogram_type" ) ) {
1066 final String type_str = ( ( String ) st.nextElement() ).trim();
1067 if ( type_str.equalsIgnoreCase( Options.CLADOGRAM_TYPE.NON_LINED_UP.toString() ) ) {
1068 setCladogramType( Options.CLADOGRAM_TYPE.NON_LINED_UP );
1070 else if ( type_str.equalsIgnoreCase( Options.CLADOGRAM_TYPE.EXT_NODE_SUM_DEP.toString() ) ) {
1071 setCladogramType( Options.CLADOGRAM_TYPE.EXT_NODE_SUM_DEP );
1073 else if ( type_str.equalsIgnoreCase( Options.CLADOGRAM_TYPE.TOTAL_NODE_SUM_DEP.toString() ) ) {
1074 setCladogramType( Options.CLADOGRAM_TYPE.TOTAL_NODE_SUM_DEP );
1077 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + type_str
1078 + "] for [cladogram_type]" );
1081 else if ( key.equals( "non_lined_up_cladogram" ) ) {
1083 .printWarningMessage( AptxConstants.PRG_NAME,
1084 "configuration key [non_lined_up_cladogram] is deprecated, use [cladogram_type] instead" );
1086 else if ( key.equals( "hide_controls_and_menus" ) ) {
1087 _hide_controls_and_menus = parseBoolean( ( String ) st.nextElement() );
1089 else if ( key.equals( "use_tabbed_display" ) ) {
1090 _use_tabbed_display = parseBoolean( ( String ) st.nextElement() );
1092 else if ( key.equals( "overview_width" ) ) {
1093 final short i = parseShort( ( ( String ) st.nextElement() ) );
1096 else if ( key.equals( "overview_height" ) ) {
1097 final short i = parseShort( ( ( String ) st.nextElement() ) );
1098 setOvMaxHeight( i );
1100 else if ( key.equals( "overview_placement_type" ) ) {
1101 final String type_str = ( ( String ) st.nextElement() ).trim();
1102 if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT.toTag() ) ) {
1103 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT );
1105 else if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.UPPER_RIGHT.toTag() ) ) {
1106 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.UPPER_RIGHT );
1108 else if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.LOWER_LEFT.toTag() ) ) {
1109 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.LOWER_LEFT );
1111 else if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.LOWER_RIGHT.toTag() ) ) {
1112 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.LOWER_RIGHT );
1115 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT );
1116 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + type_str
1117 + "] for [overview_placement_type]" );
1120 else if ( key.equals( "node_label_direction" ) ) {
1121 final String type_str = ( ( String ) st.nextElement() ).trim();
1122 if ( type_str.equalsIgnoreCase( NODE_LABEL_DIRECTION.HORIZONTAL.toString() ) ) {
1123 setNodeLabelDirection( NODE_LABEL_DIRECTION.HORIZONTAL );
1125 else if ( type_str.equalsIgnoreCase( NODE_LABEL_DIRECTION.RADIAL.toString() ) ) {
1126 setNodeLabelDirection( NODE_LABEL_DIRECTION.RADIAL );
1129 setNodeLabelDirection( NODE_LABEL_DIRECTION.HORIZONTAL );
1130 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + type_str
1131 + "] for [node_label_direction]" );
1134 else if ( key.equals( "branch_length_value_digits" ) ) {
1135 final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1137 setNumberOfDigitsAfterCommaForBranchLengthValue( i );
1140 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "illegal value [" + i
1141 + "] for [branch_length_value_digits]" );
1144 else if ( key.equals( "confidence_value_digits" ) ) {
1145 final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1147 setNumberOfDigitsAfterCommaForConfidenceValues( i );
1150 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "illegal value [" + i
1151 + "] for [confidence_value_digits]" );
1154 else if ( key.equals( "allow_editing" ) ) {
1155 setEditable( parseBoolean( ( String ) st.nextElement() ) );
1157 else if ( key.equals( "display_sequence_relations" ) ) {
1158 setDisplaySequenceRelations( parseBoolean( ( String ) st.nextElement() ) );
1160 else if ( key.equals( "replace_underscores_in_nh_parsing" ) ) {
1161 final boolean r = parseBoolean( ( String ) st.nextElement() );
1162 if ( r && ( getTaxonomyExtraction() != TAXONOMY_EXTRACTION.NO ) ) {
1164 .printWarningMessage( AptxConstants.PRG_NAME,
1165 "attempt to extract taxonomies and replace underscores at the same time" );
1168 setReplaceUnderscoresInNhParsing( r );
1171 else if ( key.equals( "taxonomy_extraction_in_nh_parsing" ) ) {
1172 final String s = ( String ) st.nextElement();
1173 if ( s.equalsIgnoreCase( "no" ) ) {
1174 setTaxonomyExtraction( TAXONOMY_EXTRACTION.NO );
1176 else if ( s.equalsIgnoreCase( "pfam_relaxed" ) ) {
1177 setTaxonomyExtraction( TAXONOMY_EXTRACTION.PFAM_STYLE_RELAXED );
1179 else if ( s.equalsIgnoreCase( "pfam_strict" ) ) {
1180 setTaxonomyExtraction( TAXONOMY_EXTRACTION.PFAM_STYLE_STRICT );
1182 else if ( s.equalsIgnoreCase( "aggressive" ) ) {
1183 setTaxonomyExtraction( TAXONOMY_EXTRACTION.AGGRESSIVE );
1187 .printWarningMessage( AptxConstants.PRG_NAME,
1188 "unknown value for \"taxonomy_extraction_in_nh_parsing\": "
1190 + " (must be either: no, pfam_relaxed, pfam_strict, or aggressive)" );
1192 if ( ( getTaxonomyExtraction() != TAXONOMY_EXTRACTION.NO ) && isReplaceUnderscoresInNhParsing() ) {
1194 .printWarningMessage( AptxConstants.PRG_NAME,
1195 "attempt to extract taxonomies and replace underscores at the same time" );
1198 else if ( key.equals( "internal_labels_are_confidence_values" ) ) {
1199 setInternalNumberAreConfidenceForNhParsing( parseBoolean( ( String ) st.nextElement() ) );
1201 else if ( key.equals( "gui_background_color" ) ) {
1202 _gui_background_color = Color.decode( ( String ) st.nextElement() );
1204 else if ( key.equals( "gui_checkbox_text_color" ) ) {
1205 _gui_checkbox_text_color = Color.decode( ( String ) st.nextElement() );
1207 else if ( key.equals( "gui_checkbox_and_button_active_color" ) ) {
1208 _gui_checkbox_and_button_active_color = Color.decode( ( String ) st.nextElement() );
1210 else if ( key.equals( "gui_button_text_color" ) ) {
1211 _gui_button_text_color = Color.decode( ( String ) st.nextElement() );
1213 else if ( key.equals( "gui_button_background_color" ) ) {
1214 _gui_button_background_color = Color.decode( ( String ) st.nextElement() );
1216 else if ( key.equals( "gui_menu_background_color" ) ) {
1217 _gui_menu_background_color = Color.decode( ( String ) st.nextElement() );
1219 else if ( key.equals( "gui_menu_text_color" ) ) {
1220 _gui_menu_text_color = Color.decode( ( String ) st.nextElement() );
1222 else if ( key.equals( "gui_button_border_color" ) ) {
1223 _gui_button_border_color = Color.decode( ( String ) st.nextElement() );
1225 else if ( key.equals( "show_default_node_shapes_internal" ) ) {
1226 setShowDefaultNodeShapesInternal( parseBoolean( ( ( String ) st.nextElement() ).trim() ) );
1228 else if ( key.equals( "show_default_node_shapes_external" ) ) {
1229 setShowDefaultNodeShapesExternal( parseBoolean( ( ( String ) st.nextElement() ).trim() ) );
1231 else if ( key.equals( "show_node_shapes_for_nodes_with_vis_data" ) ) {
1232 setShowDefaultNodeShapesForMarkedNodes( parseBoolean( ( ( String ) st.nextElement() ).trim() ) );
1234 else if ( key.equals( "default_node_size" ) ) {
1235 final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1236 setDefaultNodeShapeSize( i );
1238 else if ( key.equals( "default_node_fill" ) ) {
1239 final String fill_str = ( ( String ) st.nextElement() ).trim();
1240 if ( fill_str.equalsIgnoreCase( NodeVisualData.NodeFill.NONE.toString() ) ) {
1241 setDefaultNodeFill( NodeFill.NONE );
1243 else if ( fill_str.equalsIgnoreCase( NodeVisualData.NodeFill.GRADIENT.toString() ) ) {
1244 setDefaultNodeFill( NodeFill.GRADIENT );
1246 else if ( fill_str.equalsIgnoreCase( NodeVisualData.NodeFill.SOLID.toString() ) ) {
1247 setDefaultNodeFill( NodeFill.SOLID );
1250 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + fill_str
1251 + "] for [default_node_fill]" );
1254 else if ( key.equals( "default_node_shape" ) ) {
1255 final String shape_str = ( ( String ) st.nextElement() ).trim();
1256 if ( shape_str.equalsIgnoreCase( NodeVisualData.NodeShape.CIRCLE.toString() ) ) {
1257 setDefaultNodeShape( NodeShape.CIRCLE );
1259 else if ( shape_str.equalsIgnoreCase( NodeVisualData.NodeShape.RECTANGLE.toString() ) ) {
1260 setDefaultNodeShape( NodeShape.RECTANGLE );
1263 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + shape_str
1264 + "] for [default_node_shape]" );
1267 else if ( key.equals( "midpoint_reroot" ) ) {
1268 setMidpointReroot( parseBoolean( ( String ) st.nextElement() ) );
1270 else if ( key.equals( "list_node_data_field" ) || key.equals( "ext_descendents_data_to_return" ) ) {
1271 final String s = ( ( String ) st.nextElement() ).trim();
1272 if ( s.equalsIgnoreCase( "node_name" ) ) {
1273 setExtDescNodeDataToReturn( NodeDataField.NODE_NAME );
1275 else if ( s.equalsIgnoreCase( "sequence_acc" ) ) {
1276 setExtDescNodeDataToReturn( NodeDataField.SEQUENCE_ACC );
1278 else if ( s.equalsIgnoreCase( "sequence_mol_seq_fasta" ) ) {
1279 setExtDescNodeDataToReturn( NodeDataField.SEQUENCE_MOL_SEQ_FASTA );
1281 else if ( s.equalsIgnoreCase( "sequence_name" ) ) {
1282 setExtDescNodeDataToReturn( NodeDataField.SEQUENCE_NAME );
1284 else if ( s.equalsIgnoreCase( "gene_name" ) ) {
1285 setExtDescNodeDataToReturn( NodeDataField.GENE_NAME );
1287 else if ( s.equalsIgnoreCase( "sequence_symbol" ) ) {
1288 setExtDescNodeDataToReturn( NodeDataField.SEQUENCE_SYMBOL );
1290 else if ( s.equalsIgnoreCase( "taxonomy_scientific_name" ) ) {
1291 setExtDescNodeDataToReturn( NodeDataField.TAXONOMY_SCIENTIFIC_NAME );
1293 else if ( s.equalsIgnoreCase( "taxonomy_code" ) ) {
1294 setExtDescNodeDataToReturn( NodeDataField.TAXONOMY_CODE );
1296 else if ( s.equalsIgnoreCase( "user_selected" ) ) {
1297 setExtDescNodeDataToReturn( NodeDataField.UNKNOWN );
1299 else if ( s.equalsIgnoreCase( "domains" ) ) {
1300 setExtDescNodeDataToReturn( NodeDataField.DOMAINS_ALL );
1302 else if ( s.equalsIgnoreCase( "domains_collapsed" ) ) {
1303 setExtDescNodeDataToReturn( NodeDataField.DOMAINS_COLLAPSED_PER_PROTEIN );
1305 else if ( s.equalsIgnoreCase( "seq_annotations" ) ) {
1306 setExtDescNodeDataToReturn( NodeDataField.SEQ_ANNOTATIONS );
1308 else if ( s.equalsIgnoreCase( "go_term_ids" ) ) {
1309 setExtDescNodeDataToReturn( NodeDataField.GO_TERM_IDS );
1312 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + s
1313 + "] for [ext_descendents_data_to_return]" );
1316 else if ( key.equals( "list_node_data_custom_label" ) || key.equals( "label_for_get_ext_descendents_data" ) ) {
1317 final String s = ( ( String ) st.nextElement() ).trim();
1318 if ( !ForesterUtil.isEmpty( s ) && ( s.length() > 1 ) ) {
1319 setLabelForGetExtDescendentsData( s.replaceAll( "_", " " ) );
1322 else if ( key.equals( "list_node_data_in" ) || key.equals( "ext_descendents_data_to_return_on" ) ) {
1323 final String s = ( ( String ) st.nextElement() ).trim().toLowerCase();
1324 if ( s.equals( "console" ) ) {
1325 setExtNodeDataReturnOn( EXT_NODE_DATA_RETURN_ON.CONSOLE );
1327 else if ( s.equals( "window" ) ) {
1328 setExtNodeDataReturnOn( EXT_NODE_DATA_RETURN_ON.WINODW );
1330 else if ( s.equals( "buffer_only" ) ) {
1331 setExtNodeDataReturnOn( EXT_NODE_DATA_RETURN_ON.BUFFER_ONLY );
1334 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown value [" + s
1335 + "] for [ext_descendents_data_to_return_on]" );
1338 else if ( key.equals( "vector_data_min_color" ) ) {
1339 _vector_data_min_color = Color.decode( ( String ) st.nextElement() );
1341 else if ( key.equals( "vector_data_max_color" ) ) {
1342 _vector_data_max_color = Color.decode( ( String ) st.nextElement() );
1344 else if ( key.equals( "vector_data_mean_color" ) ) {
1345 _vector_data_mean_color = Color.decode( ( String ) st.nextElement() );
1347 else if ( key.equals( "vector_data_width" ) ) {
1348 _vector_data_width = parseShort( ( String ) st.nextElement() );
1349 if ( _vector_data_width < 1 ) {
1350 _vector_data_width = 120;
1353 else if ( key.equals( "vector_data_height" ) ) {
1354 _vector_data_height = parseShort( ( String ) st.nextElement() );
1355 if ( _vector_data_height < 1 ) {
1356 _vector_data_height = 12;
1359 else if ( key.equals( "line_up_renderable_data" ) ) {
1360 setLineUpRendarableNodeData( parseBoolean( ( String ) st.nextElement() ) );
1362 else if ( key.equals( "right_align_domain_architectures" ) ) {
1363 setRightLineUpDomains( parseBoolean( ( String ) st.nextElement() ) );
1365 else if ( key.equals( "allow_thick_strokes" ) ) {
1366 _allow_thick_strokes = parseBoolean( ( String ) st.nextElement() );
1368 else if ( st.countTokens() >= 2 ) { // counts the tokens that are not
1371 if ( key.equals( "phylogram" ) ) {
1372 key_index = Configuration.display_as_phylogram;
1374 else if ( key.equals( "rollover" ) ) {
1375 key_index = Configuration.node_data_popup;
1377 else if ( key.equals( "color_according_to_species" ) ) {
1378 key_index = Configuration.color_according_to_species;
1380 else if ( key.equals( "color_according_to_sequence" ) ) {
1381 key_index = Configuration.color_according_to_sequence;
1383 else if ( key.equals( "show_node_names" ) ) {
1384 key_index = Configuration.show_node_names;
1386 else if ( key.equals( "show_taxonomy_code" ) ) {
1387 key_index = Configuration.show_tax_code;
1389 else if ( key.equals( "write_confidence_values" ) ) {
1390 key_index = Configuration.write_confidence_values;
1392 else if ( key.equals( "write_branch_length_values" ) ) {
1393 key_index = Configuration.write_branch_length_values;
1395 else if ( key.equals( "write_events" ) ) {
1396 key_index = Configuration.write_events;
1398 else if ( key.equals( "use_visual_styles" ) ) {
1399 key_index = Configuration.use_style;
1401 else if ( key.equals( "color_branches" ) ) {
1402 key_index = Configuration.use_style;
1404 .printWarningMessage( AptxConstants.PRG_NAME,
1405 "configuration key [color_branches] is deprecated, use [use_visual_styles] instead" );
1407 else if ( key.equals( "width_branches" ) ) {
1408 key_index = Configuration.width_branches;
1410 else if ( key.equals( "show_domain_architectures" ) ) {
1411 key_index = Configuration.show_domain_architectures;
1413 else if ( key.equals( "show_msa" ) ) {
1414 key_index = Configuration.show_mol_seqs;
1416 else if ( key.equals( "show_annotations" ) ) {
1417 key_index = Configuration.show_annotation;
1419 else if ( key.equals( "show_binary_characters" ) ) {
1420 key_index = Configuration.show_binary_characters;
1422 else if ( key.equals( "show_binary_character_counts" ) ) {
1423 key_index = Configuration.show_binary_character_counts;
1425 else if ( key.equals( "show_seq_names" ) ) {
1426 key_index = Configuration.show_seq_names;
1428 else if ( key.equals( "show_gene_names" ) ) {
1429 key_index = Configuration.show_gene_names;
1431 else if ( key.equals( "show_seq_symbols" ) ) {
1432 key_index = Configuration.show_seq_symbols;
1434 else if ( key.equals( "show_seq_acc" ) ) {
1435 key_index = Configuration.show_sequence_acc;
1437 else if ( key.equals( "display_internal_data" ) ) {
1438 key_index = Configuration.display_internal_data;
1440 else if ( key.equals( "dynamically_hide_data" ) ) {
1441 key_index = Configuration.dynamically_hide_data;
1443 else if ( key.equals( "show_taxonomy_scientific_names" ) ) {
1444 key_index = Configuration.show_taxonomy_scientific_names;
1446 else if ( key.equals( "show_taxonomy_common_names" ) ) {
1447 key_index = Configuration.show_taxonomy_common_names;
1449 else if ( key.equals( "show_taxonomy_images" ) ) {
1450 key_index = Configuration.show_taxonomy_images;
1452 else if ( key.equals( "color_according_to_annotation" ) ) {
1453 key_index = Configuration.color_according_to_annotation;
1455 else if ( key.equals( "show_vector_data" ) ) {
1456 key_index = Configuration.show_vector_data;
1458 else if ( key.equals( "show_properties" ) ) {
1459 key_index = Configuration.show_properties;
1461 else if ( key.equals( "show_relation_confidence" ) ) {
1462 key_index = Configuration.show_relation_confidence;
1464 // If we've found the key, set the values
1465 if ( key_index >= 0 ) {
1466 display_options[ key_index ][ 1 ] = ( String ) st.nextElement();
1467 display_options[ key_index ][ 2 ] = ( String ) st.nextElement();
1468 // otherwise, keep looking
1471 if ( key_index == DEPRECATED ) {
1474 else if ( key.equals( "click_to" ) ) {
1475 final String click_to_name = ( String ) st.nextElement();
1476 key_index = getClickToIndex( click_to_name );
1477 if ( key_index >= 0 ) {
1478 clickto_options[ key_index ][ 1 ] = ( String ) st.nextElement();
1480 else if ( key_index == DEPRECATED ) {
1484 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown click-to option: "
1488 else if ( key.equals( "species_color" ) ) {
1489 getSpeciesColors().put( ( ( String ) st.nextElement() ).replace( '_', ' ' ),
1490 Color.decode( ( String ) st.nextElement() ) );
1492 else if ( key.equals( "sequence_color" ) ) {
1493 getSequenceColors().put( ( ( String ) st.nextElement() ).replace( '_', ' ' ),
1494 Color.decode( ( String ) st.nextElement() ) );
1496 else if ( key.equals( "domain_color" ) ) {
1497 getDomainColors().put( ( String ) st.nextElement(), Color.decode( ( String ) st.nextElement() ) );
1499 else if ( key.equals( "annotation_color" ) ) {
1500 getAnnotationColors()
1501 .put( ( String ) st.nextElement(), Color.decode( ( String ) st.nextElement() ) );
1503 else if ( key.equals( "function_color" ) ) {
1504 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME,
1505 "configuration key [function_color] is deprecated" );
1507 else if ( key.equals( DISPLAY_COLOR_KEY ) ) {
1508 putDisplayColors( ( String ) st.nextElement(), Color.decode( ( String ) st.nextElement() ) );
1511 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown configuration key [" + key
1512 + "] in: " + config_filename );
1517 ForesterUtil.printWarningMessage( AptxConstants.PRG_NAME, "unknown configuration key [" + key + "] in: "
1518 + config_filename );
1522 private void setLabelForGetExtDescendentsData( final String label_for_get_ext_descendents_data ) {
1523 _label_for_get_ext_descendents_data = label_for_get_ext_descendents_data;
1526 private void setMaxBaseFontSize( final int max_base_font_size ) {
1527 _max_base_font_size = max_base_font_size;
1530 private void setMinBaseFontSize( final int min_base_font_size ) {
1531 _min_base_font_size = min_base_font_size;
1534 private void setOvMaxHeight( final short ov_max_height ) {
1535 _ov_max_height = ov_max_height;
1538 private void setOvMaxWidth( final short ov_max_width ) {
1539 _ov_max_width = ov_max_width;
1542 private void setOvPlacement( final OVERVIEW_PLACEMENT_TYPE ov_placement ) {
1543 _ov_placement = ov_placement;
1546 private void setPathToLocalFastme( final File path_to_local_fastme ) {
1547 _path_to_local_fastme = path_to_local_fastme;
1550 private void setPathToLocalMafft( final File path_to_local_mafft ) {
1551 _path_to_local_mafft = path_to_local_mafft;
1554 private void setPathToLocalRaxml( final File path_to_local_raxml ) {
1555 _path_to_local_raxml = path_to_local_raxml;
1558 private void setShowAnnotationRefSource( final boolean b ) {
1559 _show_annotation_ref_source = b;
1562 private void setShowOverview( final boolean show_overview ) {
1563 _show_overview = show_overview;
1566 private void setValidatePhyloXmlAgainstSchema( final boolean validate_against_phyloxml_xsd_schema ) {
1567 _validate_against_phyloxml_xsd_schema = validate_against_phyloxml_xsd_schema;
1570 boolean displaySequenceRelations() {
1571 return _display_sequence_relations;
1574 boolean doCheckOption( final int which ) {
1575 return ( display_options[ which ][ 2 ].equalsIgnoreCase( "yes" ) )
1576 || ( display_options[ which ][ 2 ].equalsIgnoreCase( "true" ) );
1579 boolean doDisplayClickToOption( final int which ) {
1580 return clickto_options[ which ][ 1 ].equalsIgnoreCase( "display" );
1583 boolean doDisplayOption( final int which ) {
1584 return display_options[ which ][ 1 ].equalsIgnoreCase( "display" );
1588 * Will attempt to use the phylogeny to determine whether to check
1589 * this or not (e.g. phylogram)
1592 boolean doGuessCheckOption( final int which ) {
1593 return display_options[ which ][ 2 ].equals( "?" );
1596 Map<String, Color> getAnnotationColors() {
1597 if ( _annotation_colors == null ) {
1598 _annotation_colors = new Hashtable<String, Color>();
1600 return _annotation_colors;
1603 int getBaseFontSize() {
1604 return _base_font_size;
1607 CLADOGRAM_TYPE getCladogramType() {
1608 return _cladogram_type;
1611 int getClickToOptionsCount() {
1612 return clickto_options.length;
1615 String getClickToTitle( final int which ) {
1616 return clickto_options[ which ][ 0 ];
1619 int getDefaultDisplayClicktoOption() {
1620 return default_clickto;
1623 SortedMap<String, Color> getDisplayColors() {
1624 return _display_colors;
1627 String getDisplayTitle( final int which ) {
1628 return display_options[ which ][ 0 ];
1631 Map<String, Color> getDomainColors() {
1632 if ( _domain_colors == null ) {
1633 _domain_colors = new Hashtable<String, Color>();
1635 return _domain_colors;
1639 Color getGuiBackgroundColor() {
1640 return _gui_background_color;
1643 Color getGuiButtonBackgroundColor() {
1644 return _gui_button_background_color;
1647 Color getGuiButtonBorderColor() {
1648 return _gui_button_border_color;
1651 Color getGuiButtonTextColor() {
1652 return _gui_button_text_color;
1655 Color getGuiCheckboxAndButtonActiveColor() {
1656 return _gui_checkbox_and_button_active_color;
1659 Color getGuiCheckboxTextColor() {
1660 return _gui_checkbox_text_color;
1663 Color getGuiMenuBackgroundColor() {
1664 return _gui_menu_background_color;
1667 Color getGuiMenuTextColor() {
1668 return _gui_menu_text_color;
1671 int getMaxBaseFontSize() {
1672 return _max_base_font_size;
1675 int getMinBaseFontSize() {
1676 return _min_base_font_size;
1679 double getMinConfidenceValue() {
1680 return _min_confidence_value;
1683 NODE_LABEL_DIRECTION getNodeLabelDirection() {
1684 return _node_label_direction;
1687 short getNumberOfDigitsAfterCommaForBranchLengthValues() {
1688 return _number_of_digits_after_comma_for_branch_length_values;
1691 short getNumberOfDigitsAfterCommaForConfidenceValues() {
1692 return _number_of_digits_after_comma_for_confidence_values;
1695 short getOvMaxHeight() {
1696 return _ov_max_height;
1699 short getOvMaxWidth() {
1700 return _ov_max_width;
1703 OVERVIEW_PLACEMENT_TYPE getOvPlacement() {
1704 return _ov_placement;
1707 PHYLOGENY_GRAPHICS_TYPE getPhylogenyGraphicsType() {
1708 return _phylogeny_graphics_type;
1711 float getPrintLineWidth() {
1712 return _print_line_width;
1715 Hashtable<String, Color> getSequenceColors() {
1716 if ( _sequence_colors == null ) {
1717 _sequence_colors = new Hashtable<String, Color>();
1719 return _sequence_colors;
1722 Hashtable<String, Color> getSpeciesColors() {
1723 if ( _species_colors == null ) {
1724 initSpeciesColors();
1726 return _species_colors;
1729 final TAXONOMY_EXTRACTION getTaxonomyExtraction() {
1730 return _taxonomy_extraction;
1733 boolean isAntialiasScreen() {
1734 return _antialias_screen;
1738 * Convenience method.
1740 * @return true if value in configuration file was 'yes'
1742 boolean isDrawAsPhylogram() {
1743 return doCheckOption( display_as_phylogram );
1746 boolean isEditable() {
1751 * Only used by ArchaeoptryxE.
1754 boolean isHideControlPanelAndMenubar() {
1755 return _hide_controls_and_menus;
1758 boolean isInternalNumberAreConfidenceForNhParsing() {
1759 return _internal_number_are_confidence_for_nh_parsing;
1762 boolean isReplaceUnderscoresInNhParsing() {
1763 return _nh_parsing_replace_underscores;
1766 boolean isShowOverview() {
1767 return _show_overview;
1770 boolean isShowScale() {
1774 final boolean isUseNativeUI() {
1775 if ( ( _ui == UI.UNKNOWN ) && ForesterUtil.isMac() ) {
1778 return _ui == UI.NATIVE;
1782 * Only used by ArchaeoptryxE.
1785 boolean isUseTabbedDisplay() {
1786 return _use_tabbed_display;
1789 boolean isValidatePhyloXmlAgainstSchema() {
1790 return _validate_against_phyloxml_xsd_schema;
1793 final void setTaxonomyExtraction( final TAXONOMY_EXTRACTION taxonomy_extraction ) {
1794 _taxonomy_extraction = taxonomy_extraction;
1797 static String getDefaultFontFamilyName() {
1798 return DEFAULT_FONT_FAMILY;
1801 public boolean isCouldReadConfigFile() {
1802 return _could_read_config_file;