forester/java/src/org/forester/archaeopteryx/Configuration.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   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
  11 //
  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.
  16 //
  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.
  21 //
  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
  25 //
  26 // Contact: phylosoft @ gmail . com
  27 // WWW: www.phylosoft.org/forester
  28
  29 package org.forester.archaeopteryx;
  30
  31 import java.awt.Color;
  32 import java.io.BufferedReader;
  33 import java.io.File;
  34 import java.io.FileReader;
  35 import java.io.IOException;
  36 import java.io.InputStreamReader;
  37 import java.net.MalformedURLException;
  38 import java.net.URL;
  39 import java.util.Arrays;
  40 import java.util.Hashtable;
  41 import java.util.Map;
  42 import java.util.SortedMap;
  43 import java.util.StringTokenizer;
  44 import java.util.TreeMap;
  45
  46 import org.forester.archaeopteryx.Options.CLADOGRAM_TYPE;
  47 import org.forester.archaeopteryx.Options.NODE_LABEL_DIRECTION;
  48 import org.forester.archaeopteryx.Options.OVERVIEW_PLACEMENT_TYPE;
  49 import org.forester.archaeopteryx.Options.PHYLOGENY_GRAPHICS_TYPE;
  50 import org.forester.phylogeny.data.NodeVisualization;
  51 import org.forester.phylogeny.data.NodeVisualization.NodeFill;
  52 import org.forester.phylogeny.data.NodeVisualization.NodeShape;
  53 import org.forester.util.ForesterUtil;
  54
  55 public final class Configuration {
  56
  57     static final String                     VALIDATE_AGAINST_PHYLOXML_XSD_SCHEMA                   = "validate_against_phyloxml_xsd_schema";
  58     private static final String             WEB_LINK_KEY                                           = "web_link";
  59     private static final String             DISPLAY_COLOR_KEY                                      = "display_color";
  60     private static final int                DEPRECATED                                             = -2;
  61     private UI                              _ui                                                    = UI.UNKNOWN;
  62     private boolean                         _use_tabbed_display                                    = false;
  63     private boolean                         _hide_controls_and_menus                               = false;
  64     private CLADOGRAM_TYPE                  _cladogram_type                                        = Constants.CLADOGRAM_TYPE_DEFAULT;
  65     private SortedMap<String, WebLink>      _weblinks                                              = null;
  66     private SortedMap<String, Color>        _display_colors                                        = null;
  67     private boolean                         _antialias_screen                                      = true;
  68     private PHYLOGENY_GRAPHICS_TYPE         _phylogeny_graphics_type                               = PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR;
  69     private String                          _base_font_family_name                                 = "";
  70     private int                             _base_font_size                                        = -1;
  71     private int                             _graphics_export_x                                     = -1;
  72     private int                             _graphics_export_y                                     = -1;
  73     private short                           _ov_max_width                                          = 80;
  74     private short                           _ov_max_height                                         = 80;
  75     private OVERVIEW_PLACEMENT_TYPE         _ov_placement                                          = OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT;
  76     private double                          _min_confidence_value                                  = Options.MIN_CONFIDENCE_DEFAULT;
  77     private float                           _print_line_width                                      = Constants.PDF_LINE_WIDTH_DEFAULT;
  78     private boolean                         _show_scale                                            = false;
  79     private boolean                         _show_branch_length_values                             = false;
  80     private boolean                         _show_overview                                         = true;
  81     private short                           _number_of_digits_after_comma_for_confidence_values    = Constants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_CONFIDENCE_VALUES_DEFAULT;
  82     private short                           _number_of_digits_after_comma_for_branch_length_values = Constants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_BRANCH_LENGTH_VALUES_DEFAULT;
  83     private boolean                         _editable                                              = true;
  84     private boolean                         _nh_parsing_replace_underscores                        = false;
  85     private boolean                         _nh_parsing_extract_pfam_taxonomy_codes                = false;
  86     private boolean                         _internal_number_are_confidence_for_nh_parsing         = false;
  87     private boolean                         _display_sequence_relations                            = false;
  88     private boolean                         _validate_against_phyloxml_xsd_schema                  = Constants.VALIDATE_AGAINST_PHYLOXML_XSD_SCJEMA_DEFAULT;
  89     private boolean                         _background_color_gradient                             = false;
  90     private boolean                         _show_domain_labels                                    = true;
  91     private boolean                         _abbreviate_scientific_names                           = false;
  92     private boolean                         _color_labels_same_as_parent_branch                    = false;
  93     private boolean                         _show_default_node_shapes                              = false;
  94     private NodeShape                       _default_node_shape                                    = NodeShape.CIRCLE;
  95     private NodeFill                        _default_node_fill                                     = NodeFill.GRADIENT;
  96     private short                           _default_node_shape_size                               = Constants.DEFAULT_NODE_SHAPE_SIZE_DEFAULT;
  97     private boolean                         _taxonomy_colorize_node_shapes                         = false;
  98     private int                             _default_bootstrap_samples                             = -1;
  99     private File                            _path_to_local_mafft                                   = null;
 100     private File                            _path_to_local_fastme                                  = null;
 101     private File                            _path_to_local_raxml                                   = null;
 102     private File                            _path_to_local_clustalo                                = null;
 103     final static int                        display_as_phylogram                                   = 0;
 104     final static int                        show_node_names                                        = 1;
 105     final static int                        show_tax_code                                          = 2;
 106     final static int                        show_annotation                                        = 3;
 107     final static int                        write_confidence_values                                = 4;
 108     final static int                        write_events                                           = 5;
 109     final static int                        color_according_to_species                             = 6;
 110     final static int                        color_branches                                         = 7;
 111     final static int                        width_branches                                         = 8;
 112     final static int                        show_custom_node_shapes                                = 9;
 113     final static int                        show_domain_architectures                              = 10;
 114     final static int                        show_binary_characters                                 = 11;
 115     final static int                        show_binary_character_counts                           = 12;
 116     final static int                        show_gene_names                                        = 13;
 117     final static int                        show_sequence_acc                                      = 14;
 118     final static int                        display_internal_data                                  = 15;
 119     final static int                        dynamically_hide_data                                  = 16;
 120     final static int                        show_taxonomy_scientific_names                         = 17;
 121     final static int                        show_taxonomy_common_names                             = 18;
 122     final static int                        color_according_to_annotation                          = 19;
 123     final static int                        show_gene_symbols                                      = 20;
 124     final static int                        node_data_popup                                        = 21;
 125     final static int                        show_relation_confidence                               = 22;
 126     final static int                        show_vector_data                                       = 23;
 127     final static int                        show_taxonomy_images                                   = 24;
 128     final static int                        show_properties                                        = 25;
 129     // ------------------
 130     // Click-to options
 131     // ------------------
 132     final static int                        display_node_data                                      = 0;
 133     final static int                        collapse_uncollapse                                    = 1;
 134     final static int                        reroot                                                 = 2;
 135     final static int                        subtree                                                = 3;
 136     final static int                        swap                                                   = 4;
 137     final static int                        color_subtree                                          = 5;
 138     final static int                        open_seq_web                                           = 6;
 139     final static int                        open_tax_web                                           = 7;
 140     final static int                        blast                                                  = 8;
 141     final static int                        cut_subtree                                            = 9;
 142     final static int                        copy_subtree                                           = 10;
 143     final static int                        paste_subtree                                          = 11;
 144     final static int                        delete_subtree_or_node                                 = 12;
 145     final static int                        add_new_node                                           = 13;
 146     final static int                        edit_node_data                                         = 14;
 147     final static int                        sort_descendents                                       = 15;
 148     // ---------------------------
 149     // Display options for trees
 150     // ---------------------------
 151     // ---------------------------------
 152     // Pertaining to the config itself
 153     // ---------------------------------
 154     // Full path to config (may be URL)
 155     String                                  config_filename;
 156     String                                  default_config_filename                                = Constants.DEFAULT_CONFIGURATION_FILE_NAME;
 157     final static String                     display_options[][]                                    = {
 158             { "Phylogram", "display", "?" }, { "Node Name", "display", "yes" }, { "Taxonomy Code", "display", "yes" },
 159             { "Annotation", "nodisplay", "no" }, { "Confidence Values", "display", "?" }, { "Event", "display", "?" },
 160             { "Taxonomy Colorize", "display", "no" }, { "Colorize Branches", "display", "no" },
 161             { "Use Branch-Widths", "display", "no" }, { "Show Custom Nodes", "display", "yes" },
 162             { "Domains", "nodisplay", "no" }, { "Binary Characters", "nodisplay", "no" },
 163             { "Binary Char Counts", "nodisplay", "no" }, { "Prot/Gene Name", "display", "yes" },
 164             { "Prot/Gene Acc", "display", "no" }, { "Show Internal Data", "display", "yes" },
 165             { "Dyna Hide", "display", "yes" }, { "Taxonomy Scientific", "display", "yes" },
 166             { "Taxonomy Common", "display", "no" }, { "Annotation Colorize", "nodisplay", "no" },
 167             { "Prot/Gene Symbol", "display", "yes" }, { "Rollover", "display", "yes" },
 168             { "Relation Confidence", "display", "no" }, { "Vector Data", "display", "no" },
 169             { "Taxonomy Images", "display", "no" }, { "Properties", "display", "no" }             };
 170     final static String                     clickto_options[][]                                    = {
 171             { "Display Node Data", "display" }, { "Collapse/Uncollapse", "display" }, { "Root/Reroot", "display" },
 172             { "Sub/Super Tree", "display" }, { "Swap Descendants", "display" }, { "Colorize Subtree", "display" },
 173             { "Open Sequence Web", "display" }, { "Open Taxonomy Web", "display" }, { "Blast", "display" },
 174             { "Cut Subtree", "display" }, { "Copy Subtree", "display" }, { "Paste Subtree", "display" },
 175             { "Delete Subtree/Node", "display" }, { "Add New Node", "display" }, { "Edit Node Data", "display" },
 176             { "Sort Descendants", "display" }                                                     };
 177     // This option is selected in the dropdown
 178     int                                     default_clickto                                        = Configuration.display_node_data;
 179     // --------------
 180     // Color set
 181     // --------------
 182     TreeColorSet                            tree_color_set;
 183     // -------
 184     // Fonts
 185     // -------
 186     TreeFontSet                             tree_font_set;
 187     // ----------------
 188     // Species colors
 189     // ----------------
 190     private static Hashtable<String, Color> _species_colors;
 191     // ----------------
 192     // Domain colors
 193     // ----------------
 194     private static Hashtable<String, Color> _domain_colors;
 195     // ----------------
 196     // Function colors
 197     // ----------------
 198     private static Hashtable<String, Color> _annotation_colors;
 199     boolean                                 verbose                                                = Constants.VERBOSE_DEFAULT;
 200     private NODE_LABEL_DIRECTION            _node_label_direction                                  = NODE_LABEL_DIRECTION.HORIZONTAL;
 201     private Color                           _gui_background_color                                  = Constants.GUI_BACKGROUND_DEFAULT;
 202     private Color                           _gui_checkbox_text_color                               = Constants.CHECKBOX_TEXT_COLOR_DEFAULT;
 203     private Color                           _gui_checkbox_and_button_active_color                  = Constants.CHECKBOX_AND_BUTTON_ACTIVE_COLOR_DEFAULT;
 204     private Color                           _gui_button_text_color                                 = Constants.BUTTON_TEXT_COLOR_DEFAULT;
 205     private Color                           _gui_button_background_color                           = Constants.BUTTON_BACKGROUND_COLOR_DEFAULT;
 206     private Color                           _gui_menu_background_color                             = Constants.MENU_BACKGROUND_COLOR_DEFAULT;
 207     private Color                           _gui_menu_text_color                                   = Constants.MENU_TEXT_COLOR_DEFAULT;
 208     private Color                           _gui_button_border_color                               = Constants.BUTTON_BORDER_COLOR_DEFAULT;
 209     private Color                           _domain_structure_font_color                           = Constants.DOMAIN_STRUCTURE_FONT_COLOR_DEFAULT;
 210     private Color                           _domain_structure_base_color                           = Constants.DOMAIN_STRUCTURE_BASE_COLOR_DEFAULT;
 211     private static String                   DEFAULT_FONT_FAMILY                                    = "";
 212     static {
 213         for( final String font_name : Constants.DEFAULT_FONT_CHOICES ) {
 214             if ( Arrays.binarySearch( AptxUtil.getAvailableFontFamiliesSorted(), font_name ) >= 0 ) {
 215                 DEFAULT_FONT_FAMILY = font_name;
 216                 break;
 217             }
 218         }
 219         if ( ForesterUtil.isEmpty( DEFAULT_FONT_FAMILY ) ) {
 220             DEFAULT_FONT_FAMILY = Constants.DEFAULT_FONT_CHOICES[ Constants.DEFAULT_FONT_CHOICES.length - 1 ];
 221         }
 222     }
 223
 224     public Configuration() {
 225         this( null, false, false, false );
 226     }
 227
 228     public Configuration( final String cf, final boolean is_url, final boolean is_applet, final boolean verbose ) {
 229         if ( ForesterUtil.isEmpty( cf ) ) {
 230             config_filename = default_config_filename;
 231         }
 232         else {
 233             config_filename = cf;
 234         }
 235         setWebLinks( new TreeMap<String, WebLink>() );
 236         setDisplayColors( new TreeMap<String, Color>() );
 237         config_filename = config_filename.trim();
 238         URL u = null;
 239         if ( is_url ) {
 240             // If URL, open accordingly
 241             try {
 242                 u = new URL( config_filename );
 243                 try {
 244                     final InputStreamReader isr = new InputStreamReader( u.openStream() );
 245                     final BufferedReader bf = new BufferedReader( isr );
 246                     readConfig( bf );
 247                     bf.close();
 248                     ForesterUtil.programMessage( Constants.PRG_NAME, "successfully read from configuration url ["
 249                             + config_filename + "]" );
 250                 }
 251                 catch ( final Exception e ) {
 252                     ForesterUtil.printWarningMessage( Constants.PRG_NAME, "failed to read configuration from ["
 253                             + config_filename + "]: " + e.getLocalizedMessage() );
 254                 }
 255             }
 256             catch ( final Exception e ) {
 257                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "cannot find or open configuration url ["
 258                         + config_filename + "]" );
 259             }
 260         }
 261         else {
 262             // Otherwise, open as a file
 263             File f = new File( config_filename );
 264             if ( !f.exists() ) {
 265                 f = new File( config_filename + ".txt" );
 266             }
 267             if ( f.exists() && f.canRead() ) {
 268                 try {
 269                     final BufferedReader bf = new BufferedReader( new FileReader( f ) );
 270                     readConfig( bf );
 271                     bf.close();
 272                 }
 273                 catch ( final Exception e ) {
 274                     if ( verbose ) {
 275                         ForesterUtil.printWarningMessage( Constants.PRG_NAME, "failed to read configuration from ["
 276                                 + config_filename + "]: " + e );
 277                     }
 278                 }
 279             }
 280             else {
 281                 if ( verbose ) {
 282                     ForesterUtil.printWarningMessage( Constants.PRG_NAME, "cannot find or open configuration file ["
 283                             + config_filename + "]" );
 284                 }
 285             }
 286         }
 287     }
 288
 289     private void createWebLink( final String url_str, final String desc, final String source_identifier ) {
 290         WebLink weblink = null;
 291         boolean ex = false;
 292         try {
 293             weblink = new WebLink( new URL( url_str.trim() ), desc.trim(), source_identifier.trim() );
 294         }
 295         catch ( final MalformedURLException e ) {
 296             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "could not create URL from [" + url_str + "]" );
 297             ex = true;
 298         }
 299         if ( !ex && ( weblink != null ) ) {
 300             getWebLinks().put( weblink.getSourceIdentifier().toLowerCase(), weblink );
 301         }
 302     }
 303
 304     boolean displaySequenceRelations() {
 305         return _display_sequence_relations;
 306     }
 307
 308     boolean doCheckOption( final int which ) {
 309         return ( display_options[ which ][ 2 ].equalsIgnoreCase( "yes" ) )
 310                 || ( display_options[ which ][ 2 ].equalsIgnoreCase( "true" ) );
 311     }
 312
 313     boolean doDisplayClickToOption( final int which ) {
 314         return clickto_options[ which ][ 1 ].equalsIgnoreCase( "display" );
 315     }
 316
 317     boolean doDisplayOption( final int which ) {
 318         return display_options[ which ][ 1 ].equalsIgnoreCase( "display" );
 319     }
 320
 321     /**
 322      * Will attempt to use the phylogeny to determine whether to check
 323      * this or not (e.g. phylogram)
 324      *
 325      */
 326     boolean doGuessCheckOption( final int which ) {
 327         return display_options[ which ][ 2 ].equals( "?" );
 328     }
 329
 330     Map<String, Color> getAnnotationColors() {
 331         if ( _annotation_colors == null ) {
 332             _annotation_colors = new Hashtable<String, Color>();
 333         }
 334         return _annotation_colors;
 335     }
 336
 337     public String getBaseFontFamilyName() {
 338         return _base_font_family_name;
 339     }
 340
 341     int getBaseFontSize() {
 342         return _base_font_size;
 343     }
 344
 345     CLADOGRAM_TYPE getCladogramType() {
 346         return _cladogram_type;
 347     }
 348
 349     private int getClickToIndex( final String name ) {
 350         int index = -1;
 351         if ( name.equals( "edit_info" ) ) {
 352             index = Configuration.display_node_data;
 353             ForesterUtil
 354                     .printWarningMessage( Constants.PRG_NAME,
 355                                           "configuration key [edit_info] is deprecated, use [display node data] instead" );
 356         }
 357         else if ( name.equals( "display_node_data" ) ) {
 358             index = Configuration.display_node_data;
 359         }
 360         else if ( name.equals( "collapse_uncollapse" ) ) {
 361             index = Configuration.collapse_uncollapse;
 362         }
 363         else if ( name.equals( "reroot" ) ) {
 364             index = Configuration.reroot;
 365         }
 366         else if ( name.equals( "subtree" ) ) {
 367             index = Configuration.subtree;
 368         }
 369         else if ( name.equals( "swap" ) ) {
 370             index = Configuration.swap;
 371         }
 372         else if ( name.equals( "sort_descendants" ) ) {
 373             index = Configuration.sort_descendents;
 374         }
 375         else if ( name.equals( "display_sequences" ) ) {
 376             ForesterUtil
 377                     .printWarningMessage( Constants.PRG_NAME, "configuration key [display_sequences] is deprecated" );
 378             return DEPRECATED;
 379         }
 380         else if ( name.equals( "open_seq_web" ) ) {
 381             index = Configuration.open_seq_web;
 382         }
 383         else if ( name.equals( "open_tax_web" ) ) {
 384             index = Configuration.open_tax_web;
 385         }
 386         else if ( name.equals( "blast" ) ) {
 387             index = Configuration.blast;
 388         }
 389         else if ( name.equals( "cut_subtree" ) ) {
 390             index = Configuration.cut_subtree;
 391         }
 392         else if ( name.equals( "copy_subtree" ) ) {
 393             index = Configuration.copy_subtree;
 394         }
 395         else if ( name.equals( "paste_subtree" ) ) {
 396             index = Configuration.paste_subtree;
 397         }
 398         else if ( name.equals( "delete" ) ) {
 399             index = Configuration.delete_subtree_or_node;
 400         }
 401         else if ( name.equals( "add_new_node" ) ) {
 402             index = Configuration.add_new_node;
 403         }
 404         else if ( name.equals( "edit_node_data" ) ) {
 405             index = Configuration.edit_node_data;
 406         }
 407         else if ( name.equals( "display_node_popup" ) ) {
 408             ForesterUtil.printWarningMessage( Constants.PRG_NAME,
 409                                               "configuration key [display_node_popup] is deprecated" );
 410             return DEPRECATED;
 411         }
 412         else if ( name.equals( "custom_option" ) ) {
 413             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "configuration key [custom_option] is deprecated" );
 414             return DEPRECATED;
 415         }
 416         else if ( name.equals( "color_subtree" ) ) {
 417             index = Configuration.color_subtree;
 418         }
 419         else if ( name.equals( "go_to_swiss_prot" ) ) {
 420             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "configuration key [go_to_swiss_prot] is deprecated" );
 421             return DEPRECATED;
 422         }
 423         return index;
 424     }
 425
 426     int getClickToOptionsCount() {
 427         return clickto_options.length;
 428     }
 429
 430     String getClickToTitle( final int which ) {
 431         return clickto_options[ which ][ 0 ];
 432     }
 433
 434     public int getDefaultBootstrapSamples() {
 435         return _default_bootstrap_samples;
 436     }
 437
 438     public File getpathToLocalMafft() {
 439         return _path_to_local_mafft;
 440     }
 441
 442
 443
 444     public File getPathToLocalFastme() {
 445         return _path_to_local_fastme;
 446     }
 447
 448     public File getPathToLocalRaxml() {
 449         return _path_to_local_raxml;
 450     }
 451
 452     int getDefaultDisplayClicktoOption() {
 453         return default_clickto;
 454     }
 455
 456     public NodeFill getDefaultNodeFill() {
 457         return _default_node_fill;
 458     }
 459
 460     public NodeShape getDefaultNodeShape() {
 461         return _default_node_shape;
 462     }
 463
 464     public short getDefaultNodeShapeSize() {
 465         return _default_node_shape_size;
 466     }
 467
 468     SortedMap<String, Color> getDisplayColors() {
 469         return _display_colors;
 470     }
 471
 472     String getDisplayTitle( final int which ) {
 473         return display_options[ which ][ 0 ];
 474     }
 475
 476     Map<String, Color> getDomainColors() {
 477         if ( _domain_colors == null ) {
 478             _domain_colors = new Hashtable<String, Color>();
 479         }
 480         return _domain_colors;
 481     }
 482
 483     public Color getDomainStructureBaseColor() {
 484         return _domain_structure_base_color;
 485     }
 486
 487     public Color getDomainStructureFontColor() {
 488         return _domain_structure_font_color;
 489     }
 490
 491     int getGraphicsExportX() {
 492         return _graphics_export_x;
 493     }
 494
 495     int getGraphicsExportY() {
 496         return _graphics_export_y;
 497     }
 498
 499     Color getGuiBackgroundColor() {
 500         return _gui_background_color;
 501     }
 502
 503     Color getGuiButtonBackgroundColor() {
 504         return _gui_button_background_color;
 505     }
 506
 507     Color getGuiButtonBorderColor() {
 508         return _gui_button_border_color;
 509     }
 510
 511     Color getGuiButtonTextColor() {
 512         return _gui_button_text_color;
 513     }
 514
 515     Color getGuiCheckboxAndButtonActiveColor() {
 516         return _gui_checkbox_and_button_active_color;
 517     }
 518
 519     Color getGuiCheckboxTextColor() {
 520         return _gui_checkbox_text_color;
 521     }
 522
 523     Color getGuiMenuBackgroundColor() {
 524         return _gui_menu_background_color;
 525     }
 526
 527     Color getGuiMenuTextColor() {
 528         return _gui_menu_text_color;
 529     }
 530
 531     double getMinConfidenceValue() {
 532         return _min_confidence_value;
 533     }
 534
 535     NODE_LABEL_DIRECTION getNodeLabelDirection() {
 536         return _node_label_direction;
 537     }
 538
 539     short getNumberOfDigitsAfterCommaForBranchLengthValues() {
 540         return _number_of_digits_after_comma_for_branch_length_values;
 541     }
 542
 543     short getNumberOfDigitsAfterCommaForConfidenceValues() {
 544         return _number_of_digits_after_comma_for_confidence_values;
 545     }
 546
 547     short getOvMaxHeight() {
 548         return _ov_max_height;
 549     }
 550
 551     short getOvMaxWidth() {
 552         return _ov_max_width;
 553     }
 554
 555     OVERVIEW_PLACEMENT_TYPE getOvPlacement() {
 556         return _ov_placement;
 557     }
 558
 559     PHYLOGENY_GRAPHICS_TYPE getPhylogenyGraphicsType() {
 560         return _phylogeny_graphics_type;
 561     }
 562
 563     float getPrintLineWidth() {
 564         return _print_line_width;
 565     }
 566
 567     Hashtable<String, Color> getSpeciesColors() {
 568         if ( _species_colors == null ) {
 569             _species_colors = new Hashtable<String, Color>();
 570         }
 571         return _species_colors;
 572     }
 573
 574     TreeColorSet getTreeColorSet() {
 575         return null;
 576     }
 577
 578     TreeFontSet getTreeFontSet() {
 579         return null;
 580     }
 581
 582     WebLink getWebLink( final String source ) {
 583         return getWebLinks().get( source );
 584     }
 585
 586     Map<String, WebLink> getWebLinks() {
 587         return _weblinks;
 588     }
 589
 590     public boolean isAbbreviateScientificTaxonNames() {
 591         return _abbreviate_scientific_names;
 592     }
 593
 594     boolean isAntialiasScreen() {
 595         return _antialias_screen;
 596     }
 597
 598     public boolean isBackgroundColorGradient() {
 599         return _background_color_gradient;
 600     }
 601
 602     public boolean isColorLabelsSameAsParentBranch() {
 603         return _color_labels_same_as_parent_branch;
 604     }
 605
 606     /**
 607      * Convenience method.
 608      *
 609      * @return true if value in configuration file was 'yes'
 610      */
 611     boolean isDrawAsPhylogram() {
 612         return doCheckOption( display_as_phylogram );
 613     }
 614
 615     boolean isEditable() {
 616         return _editable;
 617     }
 618
 619     boolean isExtractPfamTaxonomyCodesInNhParsing() {
 620         return _nh_parsing_extract_pfam_taxonomy_codes;
 621     }
 622
 623     boolean isHasWebLink( final String source ) {
 624         return getWebLinks().containsKey( source );
 625     }
 626
 627     /**
 628      * Only used by ArchaeoptryxE.
 629      *
 630      */
 631     boolean isHideControlPanelAndMenubar() {
 632         return _hide_controls_and_menus;
 633     }
 634
 635     boolean isInternalNumberAreConfidenceForNhParsing() {
 636         return _internal_number_are_confidence_for_nh_parsing;
 637     }
 638
 639     boolean isReplaceUnderscoresInNhParsing() {
 640         return _nh_parsing_replace_underscores;
 641     }
 642
 643     boolean isShowBranchLengthValues() {
 644         return _show_branch_length_values;
 645     }
 646
 647     public boolean isShowDefaultNodeShapes() {
 648         return _show_default_node_shapes;
 649     }
 650
 651     public boolean isShowDomainLabels() {
 652         return _show_domain_labels;
 653     }
 654
 655     boolean isShowOverview() {
 656         return _show_overview;
 657     }
 658
 659     boolean isShowScale() {
 660         return _show_scale;
 661     }
 662
 663     public boolean isTaxonomyColorizeNodeShapes() {
 664         return _taxonomy_colorize_node_shapes;
 665     }
 666
 667     final boolean isUseNativeUI() {
 668         if ( ( _ui == UI.UNKNOWN ) && AptxUtil.isMac() && AptxUtil.isJava15() ) {
 669             _ui = UI.NATIVE;
 670         }
 671         return _ui == UI.NATIVE;
 672     }
 673
 674     /**
 675      * Only used by ArchaeoptryxE.
 676      *
 677      */
 678     boolean isUseTabbedDisplay() {
 679         return _use_tabbed_display;
 680     }
 681
 682     boolean isValidatePhyloXmlAgainstSchema() {
 683         return _validate_against_phyloxml_xsd_schema;
 684     }
 685
 686     private boolean parseBoolean( final String str ) {
 687         final String my_str = str.trim().toLowerCase();
 688         if ( my_str.equals( "yes" ) || my_str.equals( "true" ) ) {
 689             return true;
 690         }
 691         else if ( my_str.equals( "no" ) || my_str.equals( "false" ) ) {
 692             return false;
 693         }
 694         else {
 695             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "could not parse boolean value from [" + str + "]" );
 696             return false;
 697         }
 698     }
 699
 700     private double parseDouble( final String str ) {
 701         double d = 0.0;
 702         try {
 703             d = Double.parseDouble( str );
 704         }
 705         catch ( final Exception e ) {
 706             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "could not parse double from [" + str + "]" );
 707             d = 0.0;
 708         }
 709         return d;
 710     }
 711
 712     private float parseFloat( final String str ) {
 713         float f = 0.0f;
 714         try {
 715             f = Float.parseFloat( str );
 716         }
 717         catch ( final Exception e ) {
 718             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "could not parse float from [" + str + "]" );
 719             f = 0.0f;
 720         }
 721         return f;
 722     }
 723
 724     private int parseInt( final String str ) {
 725         int i = -1;
 726         try {
 727             i = Integer.parseInt( str );
 728         }
 729         catch ( final Exception e ) {
 730             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "could not parse integer from [" + str + "]" );
 731             i = -1;
 732         }
 733         return i;
 734     }
 735
 736     private short parseShort( final String str ) {
 737         short i = -1;
 738         try {
 739             i = Short.parseShort( str );
 740         }
 741         catch ( final Exception e ) {
 742             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "could not parse short from [" + str + "]" );
 743             i = -1;
 744         }
 745         return i;
 746     }
 747
 748     private void processFontFamily( final StringTokenizer st ) {
 749         setBaseFontFamilyName( "" );
 750         final String font_str = ( ( String ) st.nextElement() ).trim();
 751         final String[] fonts = font_str.split( ",+" );
 752         for( String font : fonts ) {
 753             font = font.replace( '_', ' ' ).trim();
 754             if ( Arrays.binarySearch( AptxUtil.getAvailableFontFamiliesSorted(), font ) >= 0 ) {
 755                 setBaseFontFamilyName( font );
 756                 break;
 757             }
 758         }
 759     }
 760
 761     public void putDisplayColors( final String key, final Color color ) {
 762         getDisplayColors().put( key, color );
 763     }
 764
 765     /**
 766      * read each line of config file, process non-comment lines
 767      * @throws IOException
 768      */
 769     private void readConfig( final BufferedReader conf_in ) throws IOException {
 770         String line;
 771         do {
 772             line = conf_in.readLine();
 773             if ( line != null ) {
 774                 line = line.trim();
 775                 // skip comments and blank lines
 776                 if ( !line.startsWith( "#" ) && ( !ForesterUtil.isEmpty( line ) ) ) {
 777                     // convert runs of spaces to tabs
 778                     line = line.replaceAll( "\\s+", "\t" );
 779                     final StringTokenizer st = new StringTokenizer( line, "\t" );
 780                     setKeyValue( st );
 781                 }
 782             }
 783         } while ( line != null );
 784     }
 785
 786     public void setAbbreviateScientificTaxonNames( final boolean abbreviate_scientific_names ) {
 787         _abbreviate_scientific_names = abbreviate_scientific_names;
 788     }
 789
 790     private void setAntialiasScreen( final boolean antialias_screen ) {
 791         _antialias_screen = antialias_screen;
 792     }
 793
 794     public void setBackgroundColorGradient( final boolean background_color_gradient ) {
 795         _background_color_gradient = background_color_gradient;
 796     }
 797
 798     public void setBaseFontFamilyName( final String base_font_family_name ) {
 799         _base_font_family_name = base_font_family_name;
 800     }
 801
 802     public void setBaseFontSize( final int base_font_size ) {
 803         _base_font_size = base_font_size;
 804     }
 805
 806     private void setCladogramType( final CLADOGRAM_TYPE cladogram_type ) {
 807         _cladogram_type = cladogram_type;
 808     }
 809
 810     public void setColorizeBranches( final boolean b ) {
 811         display_options[ color_branches ][ 2 ] = b ? "yes" : "no";
 812     }
 813
 814     public void setColorLabelsSameAsParentBranch( final boolean color_labels_same_as_parent_branch ) {
 815         _color_labels_same_as_parent_branch = color_labels_same_as_parent_branch;
 816     }
 817
 818     private void setDefaultBootstrapSamples( final int default_bootstrap_samples ) {
 819         _default_bootstrap_samples = default_bootstrap_samples;
 820     }
 821
 822     private void setPathToLocalMafft( final File path_to_local_mafft ) {
 823         _path_to_local_mafft = path_to_local_mafft;
 824     }
 825
 826
 827
 828     private void setPathToLocalFastme( final File path_to_local_fastme ) {
 829         _path_to_local_fastme = path_to_local_fastme;
 830     }
 831
 832     private void setPathToLocalRaxml( final File path_to_local_raxml ) {
 833         _path_to_local_raxml = path_to_local_raxml;
 834     }
 835
 836     public File getPathToLocalClustalOmega() {
 837         return _path_to_local_clustalo;
 838     }
 839
 840     public void setPathToLocalClustalOmega( final File path_to_local_clustalo ) {
 841         _path_to_local_clustalo = path_to_local_clustalo;
 842     }
 843
 844     public void setDefaultNodeFill( final NodeFill default_node_fill ) {
 845         _default_node_fill = default_node_fill;
 846     }
 847
 848     public void setDefaultNodeShape( final NodeShape default_node_shape ) {
 849         _default_node_shape = default_node_shape;
 850     }
 851
 852     public void setDefaultNodeShapeSize( final short default_node_shape_size ) {
 853         _default_node_shape_size = default_node_shape_size;
 854     }
 855
 856     public void setDisplayAsPhylogram( final boolean b ) {
 857         display_options[ display_as_phylogram ][ 2 ] = b ? "yes" : "no";
 858     }
 859
 860     public void setDisplayColors( final SortedMap<String, Color> display_colors ) {
 861         _display_colors = display_colors;
 862     }
 863
 864     public void setDisplayConfidenceValues( final boolean b ) {
 865         display_options[ write_confidence_values ][ 2 ] = b ? "yes" : "no";
 866     }
 867
 868     public void setDisplayInternalData( final boolean b ) {
 869         display_options[ display_internal_data ][ 2 ] = b ? "yes" : "no";
 870     }
 871
 872     public void setDisplayNodeNames( final boolean b ) {
 873         display_options[ show_node_names ][ 2 ] = b ? "yes" : "no";
 874     }
 875
 876     public void setDisplaySequenceAcc( final boolean b ) {
 877         display_options[ show_sequence_acc ][ 2 ] = b ? "yes" : "no";
 878     }
 879
 880     public void setDisplaySequenceNames( final boolean b ) {
 881         display_options[ show_gene_names ][ 2 ] = b ? "yes" : "no";
 882     }
 883
 884     public void setDisplaySequenceRelations( final boolean display_sequence_relations ) {
 885         _display_sequence_relations = display_sequence_relations;
 886     }
 887
 888     public void setDisplaySequenceSymbols( final boolean b ) {
 889         display_options[ show_gene_symbols ][ 2 ] = b ? "yes" : "no";
 890     }
 891
 892     public void setDisplayTaxonomyCode( final boolean b ) {
 893         display_options[ show_tax_code ][ 2 ] = b ? "yes" : "no";
 894     }
 895
 896     public void setDisplayTaxonomyCommonNames( final boolean b ) {
 897         display_options[ show_taxonomy_common_names ][ 2 ] = b ? "yes" : "no";
 898     }
 899
 900     public void setDisplayTaxonomyImages( final boolean b ) {
 901         display_options[ show_taxonomy_images ][ 2 ] = b ? "yes" : "no";
 902     }
 903
 904     public void setDisplayTaxonomyScientificNames( final boolean b ) {
 905         display_options[ show_taxonomy_scientific_names ][ 2 ] = b ? "yes" : "no";
 906     }
 907
 908     public void setDynamicallyHideData( final boolean b ) {
 909         display_options[ dynamically_hide_data ][ 2 ] = b ? "yes" : "no";
 910     }
 911
 912     private void setEditable( final boolean editable ) {
 913         _editable = editable;
 914     }
 915
 916     public void setExtractPfamTaxonomyCodesInNhParsing( final boolean nh_parsing_extract_pfam_taxonomy_codes ) {
 917         _nh_parsing_extract_pfam_taxonomy_codes = nh_parsing_extract_pfam_taxonomy_codes;
 918     }
 919
 920     private void setGraphicsExportX( final int graphics_export_x ) {
 921         _graphics_export_x = graphics_export_x;
 922     }
 923
 924     private void setGraphicsExportY( final int graphics_export_y ) {
 925         _graphics_export_y = graphics_export_y;
 926     }
 927
 928     private void setInternalNumberAreConfidenceForNhParsing( final boolean internal_number_are_confidence_for_nh_parsing ) {
 929         _internal_number_are_confidence_for_nh_parsing = internal_number_are_confidence_for_nh_parsing;
 930     }
 931
 932     /**
 933      * Set a key-value(s) tuple
 934      */
 935     private void setKeyValue( final StringTokenizer st ) {
 936         String key = ( String ) st.nextElement();
 937         key = key.replace( ':', ' ' );
 938         key = key.trim();
 939         key = key.toLowerCase();
 940         // Handle single value settings first:
 941         if ( key.equals( "default_click_to" ) ) {
 942             final String clickto_name = ( String ) st.nextElement();
 943             default_clickto = getClickToIndex( clickto_name );
 944             if ( default_clickto == -1 ) {
 945                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "invalid value [" + clickto_name
 946                         + "] for [default_click_to]" );
 947                 default_clickto = 0;
 948             }
 949             else if ( default_clickto == DEPRECATED ) {
 950                 // Deprecated.
 951             }
 952         }
 953         else if ( key.equals( "native_ui" ) ) {
 954             final String my_str = ( ( String ) st.nextElement() ).trim().toLowerCase();
 955             if ( my_str.equals( "yes" ) || my_str.equals( "true" ) ) {
 956                 _ui = UI.NATIVE;
 957             }
 958             else if ( my_str.equals( "no" ) || my_str.equals( "false" ) ) {
 959                 _ui = UI.CROSSPLATFORM;
 960             }
 961             else if ( my_str.equals( "?" ) ) {
 962                 _ui = UI.UNKNOWN;
 963             }
 964             else {
 965                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "could not parse yes/no/? value from [" + my_str
 966                         + "]" );
 967                 _ui = UI.UNKNOWN;
 968             }
 969         }
 970         else if ( key.equals( VALIDATE_AGAINST_PHYLOXML_XSD_SCHEMA ) ) {
 971             setValidatePhyloXmlAgainstSchema( parseBoolean( ( String ) st.nextElement() ) );
 972         }
 973         else if ( key.equals( "antialias_screen" ) ) {
 974             setAntialiasScreen( parseBoolean( ( String ) st.nextElement() ) );
 975         }
 976         else if ( key.equals( "phylogeny_graphics_type" ) ) {
 977             final String type_str = ( ( String ) st.nextElement() ).trim();
 978             if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.CONVEX.toString() ) ) {
 979                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.CONVEX );
 980             }
 981             else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.CURVED.toString() ) ) {
 982                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.CURVED );
 983             }
 984             else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.EURO_STYLE.toString() ) ) {
 985                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.EURO_STYLE );
 986             }
 987             else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.ROUNDED.toString() ) ) {
 988                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.ROUNDED );
 989             }
 990             else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR.toString() ) ) {
 991                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR );
 992             }
 993             else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.TRIANGULAR.toString() ) ) {
 994                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.TRIANGULAR );
 995             }
 996             else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.UNROOTED.toString() ) ) {
 997                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.UNROOTED );
 998             }
 999             else if ( type_str.equalsIgnoreCase( PHYLOGENY_GRAPHICS_TYPE.CIRCULAR.toString() ) ) {
1000                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.CIRCULAR );
1001             }
1002             else {
1003                 setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR );
1004                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown value [" + type_str
1005                         + "] for [phylogeny_graphics_type]" );
1006             }
1007         }
1008         else if ( key.equals( "min_confidence_value" ) ) {
1009             final String mcv_str = ( ( String ) st.nextElement() ).trim();
1010             final double d = parseDouble( mcv_str );
1011             setMinConfidenceValue( d );
1012         }
1013         else if ( key.equals( "font_family" ) ) {
1014             processFontFamily( st );
1015         }
1016         else if ( key.equals( "font_size" ) ) {
1017             final String size_str = ( ( String ) st.nextElement() ).trim();
1018             final int i = parseInt( size_str );
1019             setBaseFontSize( i );
1020         }
1021         else if ( key.equals( "graphics_export_x" ) ) {
1022             final String str = ( ( String ) st.nextElement() ).trim();
1023             final int i = parseInt( str );
1024             setGraphicsExportX( i );
1025         }
1026         else if ( key.equals( "graphics_export_y" ) ) {
1027             final String str = ( ( String ) st.nextElement() ).trim();
1028             final int i = parseInt( str );
1029             setGraphicsExportY( i );
1030         }
1031         else if ( key.equals( "pdf_export_line_width" ) ) {
1032             final String str = ( ( String ) st.nextElement() ).trim();
1033             final float f = parseFloat( str );
1034             if ( f > 0 ) {
1035                 setPrintLineWidth( f );
1036             }
1037             else {
1038                 ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1039                                                   "value for [pdf_export_line_width] cannot be zero or negative" );
1040             }
1041         }
1042         else if ( key.equals( "default_number_of_bootstrap_resamples" ) ) {
1043             final String str = ( ( String ) st.nextElement() ).trim();
1044             final int i = parseInt( str );
1045             if ( i >= 0 ) {
1046                 setDefaultBootstrapSamples( i );
1047             }
1048             else {
1049                 ForesterUtil
1050                         .printWarningMessage( Constants.PRG_NAME,
1051                                               "value for [default_number_of_bootstrap_resamples] cannot be negative" );
1052             }
1053         }
1054         else if ( key.equals( "clustalo_local" ) ) {
1055             final String str = ( ( String ) st.nextElement() ).trim();
1056             if ( !ForesterUtil.isEmpty( str ) ) {
1057                 setPathToLocalClustalOmega( new File( str ) );
1058             }
1059         }
1060         else if ( key.equals( "mafft_local" ) ) {
1061             final String str = ( ( String ) st.nextElement() ).trim();
1062             if ( !ForesterUtil.isEmpty( str ) ) {
1063                 setPathToLocalMafft( new File( str ) );
1064             }
1065         }
1066
1067         else if ( key.equals( "fastme_local" ) ) {
1068             final String str = ( ( String ) st.nextElement() ).trim();
1069             if ( !ForesterUtil.isEmpty( str ) ) {
1070                 setPathToLocalFastme( new File( str ) );
1071             }
1072         }
1073         else if ( key.equals( "raxml_local" ) ) {
1074             final String str = ( ( String ) st.nextElement() ).trim();
1075             if ( !ForesterUtil.isEmpty( str ) ) {
1076                 setPathToLocalRaxml( new File( str ) );
1077             }
1078         }
1079         else if ( key.equals( "show_scale" ) ) {
1080             setShowScale( parseBoolean( ( String ) st.nextElement() ) );
1081         }
1082         else if ( key.equals( "show_overview" ) ) {
1083             setShowOverview( parseBoolean( ( String ) st.nextElement() ) );
1084         }
1085         else if ( key.equals( "show_branch_length_values" ) ) {
1086             setShowBranchLengthValues( parseBoolean( ( String ) st.nextElement() ) );
1087         }
1088         else if ( key.equals( "background_gradient" ) ) {
1089             setBackgroundColorGradient( parseBoolean( ( String ) st.nextElement() ) );
1090         }
1091         else if ( key.equals( "color_labels_same_as_branch_length_values" ) ) {
1092             setColorLabelsSameAsParentBranch( parseBoolean( ( String ) st.nextElement() ) );
1093         }
1094         else if ( key.equals( "show_domain_labels" ) ) {
1095             setShowDomainLabels( parseBoolean( ( String ) st.nextElement() ) );
1096         }
1097         else if ( key.equals( "abbreviate_scientific_names" ) ) {
1098             setAbbreviateScientificTaxonNames( parseBoolean( ( String ) st.nextElement() ) );
1099         }
1100         else if ( key.equals( "cladogram_type" ) ) {
1101             final String type_str = ( ( String ) st.nextElement() ).trim();
1102             if ( type_str.equalsIgnoreCase( Options.CLADOGRAM_TYPE.NON_LINED_UP.toString() ) ) {
1103                 setCladogramType( Options.CLADOGRAM_TYPE.NON_LINED_UP );
1104             }
1105             else if ( type_str.equalsIgnoreCase( Options.CLADOGRAM_TYPE.EXT_NODE_SUM_DEP.toString() ) ) {
1106                 setCladogramType( Options.CLADOGRAM_TYPE.EXT_NODE_SUM_DEP );
1107             }
1108             else if ( type_str.equalsIgnoreCase( Options.CLADOGRAM_TYPE.TOTAL_NODE_SUM_DEP.toString() ) ) {
1109                 setCladogramType( Options.CLADOGRAM_TYPE.TOTAL_NODE_SUM_DEP );
1110             }
1111             else {
1112                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown value [" + type_str
1113                         + "] for [cladogram_type]" );
1114             }
1115         }
1116         else if ( key.equals( "non_lined_up_cladogram" ) ) {
1117             ForesterUtil
1118                     .printWarningMessage( Constants.PRG_NAME,
1119                                           "configuration key [non_lined_up_cladogram] is deprecated, use [cladogram_type] instead" );
1120         }
1121         else if ( key.equals( "hide_controls_and_menus" ) ) {
1122             _hide_controls_and_menus = parseBoolean( ( String ) st.nextElement() );
1123         }
1124         else if ( key.equals( "use_tabbed_display" ) ) {
1125             _use_tabbed_display = parseBoolean( ( String ) st.nextElement() );
1126         }
1127         else if ( key.equals( "overview_width" ) ) {
1128             final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1129             setOvMaxWidth( i );
1130         }
1131         else if ( key.equals( "overview_height" ) ) {
1132             final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1133             setOvMaxHeight( i );
1134         }
1135         else if ( key.equals( "overview_placement_type" ) ) {
1136             final String type_str = ( ( String ) st.nextElement() ).trim();
1137             if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT.toTag() ) ) {
1138                 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT );
1139             }
1140             else if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.UPPER_RIGHT.toTag() ) ) {
1141                 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.UPPER_RIGHT );
1142             }
1143             else if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.LOWER_LEFT.toTag() ) ) {
1144                 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.LOWER_LEFT );
1145             }
1146             else if ( type_str.equalsIgnoreCase( OVERVIEW_PLACEMENT_TYPE.LOWER_RIGHT.toTag() ) ) {
1147                 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.LOWER_RIGHT );
1148             }
1149             else {
1150                 setOvPlacement( OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT );
1151                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown value [" + type_str
1152                         + "] for [overview_placement_type]" );
1153             }
1154         }
1155         else if ( key.equals( "node_label_direction" ) ) {
1156             final String type_str = ( ( String ) st.nextElement() ).trim();
1157             if ( type_str.equalsIgnoreCase( NODE_LABEL_DIRECTION.HORIZONTAL.toString() ) ) {
1158                 setNodeLabelDirection( NODE_LABEL_DIRECTION.HORIZONTAL );
1159             }
1160             else if ( type_str.equalsIgnoreCase( NODE_LABEL_DIRECTION.RADIAL.toString() ) ) {
1161                 setNodeLabelDirection( NODE_LABEL_DIRECTION.RADIAL );
1162             }
1163             else {
1164                 setNodeLabelDirection( NODE_LABEL_DIRECTION.HORIZONTAL );
1165                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown value [" + type_str
1166                         + "] for [node_label_direction]" );
1167             }
1168         }
1169         else if ( key.equals( "branch_length_value_digits" ) ) {
1170             final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1171             if ( i >= 0 ) {
1172                 setNumberOfDigitsAfterCommaForBranchLengthValue( i );
1173             }
1174             else {
1175                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "illegal value [" + i
1176                         + "] for [branch_length_value_digits]" );
1177             }
1178         }
1179         else if ( key.equals( "confidence_value_digits" ) ) {
1180             final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1181             if ( i >= 0 ) {
1182                 setNumberOfDigitsAfterCommaForConfidenceValues( i );
1183             }
1184             else {
1185                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "illegal value [" + i
1186                         + "] for [confidence_value_digits]" );
1187             }
1188         }
1189         else if ( key.equals( "allow_editing" ) ) {
1190             setEditable( parseBoolean( ( String ) st.nextElement() ) );
1191         }
1192         else if ( key.equals( "display_sequence_relations" ) ) {
1193             setDisplaySequenceRelations( parseBoolean( ( String ) st.nextElement() ) );
1194         }
1195         else if ( key.equals( "replace_underscores_in_nh_parsing" ) ) {
1196             final boolean r = parseBoolean( ( String ) st.nextElement() );
1197             if ( r && isExtractPfamTaxonomyCodesInNhParsing() ) {
1198                 ForesterUtil
1199                         .printWarningMessage( Constants.PRG_NAME,
1200                                               "attempt to extract taxonomies and replace underscores at the same time" );
1201             }
1202             else {
1203                 setReplaceUnderscoresInNhParsing( r );
1204             }
1205         }
1206         else if ( key.equals( "extract_taxonomy_codes_in_nh_parsing" ) ) {
1207             final boolean e = parseBoolean( ( String ) st.nextElement() );
1208             if ( e && isReplaceUnderscoresInNhParsing() ) {
1209                 ForesterUtil
1210                         .printWarningMessage( Constants.PRG_NAME,
1211                                               "attempt to extract taxonomies and replace underscores at the same time" );
1212             }
1213             else {
1214                 setExtractPfamTaxonomyCodesInNhParsing( e );
1215             }
1216         }
1217         else if ( key.equals( "internal_labels_are_confidence_values" ) ) {
1218             setInternalNumberAreConfidenceForNhParsing( parseBoolean( ( String ) st.nextElement() ) );
1219         }
1220         else if ( key.equals( "gui_background_color" ) ) {
1221             _gui_background_color = Color.decode( ( String ) st.nextElement() );
1222         }
1223         else if ( key.equals( "gui_checkbox_text_color" ) ) {
1224             _gui_checkbox_text_color = Color.decode( ( String ) st.nextElement() );
1225         }
1226         else if ( key.equals( "gui_checkbox_and_button_active_color" ) ) {
1227             _gui_checkbox_and_button_active_color = Color.decode( ( String ) st.nextElement() );
1228         }
1229         else if ( key.equals( "gui_button_text_color" ) ) {
1230             _gui_button_text_color = Color.decode( ( String ) st.nextElement() );
1231         }
1232         else if ( key.equals( "gui_button_background_color" ) ) {
1233             _gui_button_background_color = Color.decode( ( String ) st.nextElement() );
1234         }
1235         else if ( key.equals( "gui_menu_background_color" ) ) {
1236             _gui_menu_background_color = Color.decode( ( String ) st.nextElement() );
1237         }
1238         else if ( key.equals( "gui_menu_text_color" ) ) {
1239             _gui_menu_text_color = Color.decode( ( String ) st.nextElement() );
1240         }
1241         else if ( key.equals( "gui_button_border_color" ) ) {
1242             _gui_button_border_color = Color.decode( ( String ) st.nextElement() );
1243         }
1244         else if ( key.equals( "domain_structure_font_color" ) ) {
1245             _domain_structure_font_color = Color.decode( ( String ) st.nextElement() );
1246         }
1247         else if ( key.equals( "domain_structure_base_color" ) ) {
1248             _domain_structure_base_color = Color.decode( ( String ) st.nextElement() );
1249         }
1250         else if ( key.equals( "show_default_node_shapes" ) ) {
1251             setShowDefaultNodeShapes( parseBoolean( ( ( String ) st.nextElement() ).trim() ) );
1252         }
1253         else if ( key.equals( "default_node_size" ) ) {
1254             final short i = parseShort( ( ( String ) st.nextElement() ).trim() );
1255             setDefaultNodeShapeSize( i );
1256         }
1257         else if ( key.equals( "default_node_fill" ) ) {
1258             final String fill_str = ( ( String ) st.nextElement() ).trim();
1259             if ( fill_str.equalsIgnoreCase( NodeVisualization.NodeFill.NONE.toString() ) ) {
1260                 setDefaultNodeFill( NodeFill.NONE );
1261             }
1262             else if ( fill_str.equalsIgnoreCase( NodeVisualization.NodeFill.GRADIENT.toString() ) ) {
1263                 setDefaultNodeFill( NodeFill.GRADIENT );
1264             }
1265             else if ( fill_str.equalsIgnoreCase( NodeVisualization.NodeFill.SOLID.toString() ) ) {
1266                 setDefaultNodeFill( NodeFill.SOLID );
1267             }
1268             else {
1269                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown value [" + fill_str
1270                         + "] for [default_node_fill]" );
1271             }
1272         }
1273         else if ( key.equals( "default_node_shape" ) ) {
1274             final String shape_str = ( ( String ) st.nextElement() ).trim();
1275             if ( shape_str.equalsIgnoreCase( NodeVisualization.NodeShape.CIRCLE.toString() ) ) {
1276                 setDefaultNodeShape( NodeShape.CIRCLE );
1277             }
1278             else if ( shape_str.equalsIgnoreCase( NodeVisualization.NodeShape.RECTANGLE.toString() ) ) {
1279                 setDefaultNodeShape( NodeShape.RECTANGLE );
1280             }
1281             else {
1282                 ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown value [" + shape_str
1283                         + "] for [default_node_shape]" );
1284             }
1285         }
1286         else if ( key.equals( "taxonomy_colorize_node_shapes" ) ) {
1287             setTaxonomyColorizeNodeShapes( parseBoolean( ( String ) st.nextElement() ) );
1288         }
1289         else if ( st.countTokens() >= 2 ) { // counts the tokens that are not
1290             // yet retrieved!
1291             int key_index = -1;
1292             if ( key.equals( "use_real_br_lengths" ) || key.equals( "phylogram" ) ) {
1293                 key_index = Configuration.display_as_phylogram;
1294                 if ( key.equals( "use_real_br_lengths" ) ) {
1295                     ForesterUtil
1296                             .printWarningMessage( Constants.PRG_NAME,
1297                                                   "configuration key [use_real_br_lengths] is deprecated, use [phylogram] instead" );
1298                 }
1299             }
1300             else if ( key.equals( "rollover" ) ) {
1301                 key_index = Configuration.node_data_popup;
1302             }
1303             else if ( key.equals( "color_according_to_species" ) ) {
1304                 key_index = Configuration.color_according_to_species;
1305             }
1306             else if ( key.equals( "show_node_names" ) ) {
1307                 key_index = Configuration.show_node_names;
1308             }
1309             else if ( key.equals( "show_taxonomy" ) || key.equals( "show_taxonomy_code" ) ) {
1310                 key_index = Configuration.show_tax_code;
1311                 if ( key.equals( "show_taxonomy" ) ) {
1312                     ForesterUtil
1313                             .printWarningMessage( Constants.PRG_NAME,
1314                                                   "configuration key [show_taxonomy] is deprecated, use [show_taxonomy_code] instead" );
1315                 }
1316             }
1317             else if ( key.equals( "write_br_length_values" ) ) {
1318                 ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1319                                                   "configuration key [write_br_length_values] is deprecated" );
1320                 key_index = DEPRECATED;
1321             }
1322             else if ( key.equals( "write_bootstrap_values" ) || key.equals( "write_confidence_values" ) ) {
1323                 key_index = Configuration.write_confidence_values;
1324                 if ( key.equals( "write_bootstrap_values" ) ) {
1325                     ForesterUtil
1326                             .printWarningMessage( Constants.PRG_NAME,
1327                                                   "configuration key [write_bootstrap_values] is deprecated, use [write_confidence_values] instead" );
1328                 }
1329             }
1330             else if ( key.equals( "write_events" ) || key.equals( "write_dup_spec" ) ) {
1331                 key_index = Configuration.write_events;
1332                 if ( key.equals( "write_dup_spec" ) ) {
1333                     ForesterUtil
1334                             .printWarningMessage( Constants.PRG_NAME,
1335                                                   "configuration key [write_dup_spec] is deprecated, use [write_events] instead" );
1336                 }
1337             }
1338             else if ( key.equals( "color_branches" ) ) {
1339                 key_index = Configuration.color_branches;
1340             }
1341             else if ( key.equals( "width_branches" ) ) {
1342                 key_index = Configuration.width_branches;
1343             }
1344             else if ( key.equals( "color_orthologous" ) ) {
1345                 ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1346                                                   "configuration key [color_orthologous] is deprecated" );
1347             }
1348             else if ( key.equals( "color_subtree_neighbors" ) ) {
1349                 ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1350                                                   "configuration key [color_subtree_neighbors] is deprecated" );
1351             }
1352             else if ( key.equals( "color_super_orthologous" ) ) {
1353                 ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1354                                                   "configuration key [color_super_orthologous] is deprecated" );
1355             }
1356             else if ( key.equals( "mark_nodes_with_box" ) ) {
1357                 ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1358                                                   "configuration key [mark_nodes_with_box] is deprecated" );
1359                 key_index = DEPRECATED;
1360             }
1361             else if ( key.equals( "show_domain_architectures" ) ) {
1362                 key_index = Configuration.show_domain_architectures;
1363             }
1364             else if ( key.equals( "show_annotations" ) ) {
1365                 key_index = Configuration.show_annotation;
1366             }
1367             else if ( key.equals( "show_binary_characters" ) ) {
1368                 key_index = Configuration.show_binary_characters;
1369             }
1370             else if ( key.equals( "show_binary_character_counts" ) ) {
1371                 key_index = Configuration.show_binary_character_counts;
1372             }
1373             else if ( key.equals( "show_gene_names" ) ) {
1374                 key_index = Configuration.show_gene_names;
1375             }
1376             else if ( key.equals( "show_gene_symbols" ) ) {
1377                 key_index = Configuration.show_gene_symbols;
1378             }
1379             else if ( key.equals( "show_sequence_acc" ) ) {
1380                 key_index = Configuration.show_sequence_acc;
1381             }
1382             else if ( key.equals( "show_node_ids" ) ) {
1383                 ForesterUtil
1384                         .printWarningMessage( Constants.PRG_NAME, "configuration key [show_node_ids] is deprecated" );
1385                 key_index = DEPRECATED;
1386             }
1387             else if ( key.equals( "display_internal_data" ) ) {
1388                 key_index = Configuration.display_internal_data;
1389             }
1390             else if ( key.equals( "dynamically_hide_data" ) ) {
1391                 key_index = Configuration.dynamically_hide_data;
1392             }
1393             else if ( key.equals( "show_taxonomy_names" ) ) {
1394                 ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1395                                                   "configuration key [show_taxonomy_names] is deprecated" );
1396                 key_index = DEPRECATED;
1397             }
1398             else if ( key.equals( "show_taxonomy_scientific_names" ) ) {
1399                 key_index = Configuration.show_taxonomy_scientific_names;
1400             }
1401             else if ( key.equals( "show_taxonomy_common_names" ) ) {
1402                 key_index = Configuration.show_taxonomy_common_names;
1403             }
1404             else if ( key.equals( "show_taxonomy_images" ) ) {
1405                 key_index = Configuration.show_taxonomy_images;
1406             }
1407             else if ( key.equals( "color_according_to_annotation" ) ) {
1408                 key_index = Configuration.color_according_to_annotation;
1409             }
1410             else if ( key.equals( "show_vector_data" ) ) {
1411                 key_index = Configuration.show_vector_data;
1412             }
1413             else if ( key.equals( "show_properties" ) ) {
1414                 key_index = Configuration.show_properties;
1415             }
1416             else if ( key.equals( "show_relation_confidence" ) ) {
1417                 key_index = Configuration.show_relation_confidence;
1418             }
1419             else if ( key.equals( "show_custom_node_shapes" ) ) {
1420                 key_index = Configuration.show_custom_node_shapes;
1421             }
1422             // If we've found the key, set the values
1423             if ( key_index >= 0 ) {
1424                 display_options[ key_index ][ 1 ] = ( String ) st.nextElement();
1425                 display_options[ key_index ][ 2 ] = ( String ) st.nextElement();
1426                 // otherwise, keep looking
1427             }
1428             else {
1429                 if ( key_index == DEPRECATED ) {
1430                     // Deprecated.
1431                 }
1432                 else if ( key.equals( "click_to" ) ) {
1433                     final String click_to_name = ( String ) st.nextElement();
1434                     key_index = getClickToIndex( click_to_name );
1435                     if ( key_index >= 0 ) {
1436                         clickto_options[ key_index ][ 1 ] = ( String ) st.nextElement();
1437                     }
1438                     else if ( key_index == DEPRECATED ) {
1439                         // Deprecated.
1440                     }
1441                     else {
1442                         ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown click-to option: "
1443                                 + click_to_name );
1444                     }
1445                 }
1446                 else if ( key.equals( "species_color" ) ) {
1447                     getSpeciesColors().put( ( String ) st.nextElement(), Color.decode( ( String ) st.nextElement() ) );
1448                 }
1449                 else if ( key.equals( "domain_color" ) ) {
1450                     getDomainColors().put( ( String ) st.nextElement(), Color.decode( ( String ) st.nextElement() ) );
1451                 }
1452                 else if ( key.equals( "annotation_color" ) ) {
1453                     getAnnotationColors()
1454                             .put( ( String ) st.nextElement(), Color.decode( ( String ) st.nextElement() ) );
1455                 }
1456                 else if ( key.equals( "function_color" ) ) {
1457                     ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1458                                                       "configuration key [function_color] is deprecated" );
1459                 }
1460                 else if ( key.equals( DISPLAY_COLOR_KEY ) ) {
1461                     putDisplayColors( ( String ) st.nextElement(), Color.decode( ( String ) st.nextElement() ) );
1462                 }
1463                 else if ( key.equals( WEB_LINK_KEY ) ) {
1464                     if ( st.countTokens() == 3 ) {
1465                         createWebLink( ( String ) st.nextElement(),
1466                                        ( String ) st.nextElement(),
1467                                        ( String ) st.nextElement() );
1468                     }
1469                     else {
1470                         ForesterUtil.printWarningMessage( Constants.PRG_NAME,
1471                                                           "illegal format in configuration file for key [" + key + "]" );
1472                     }
1473                 }
1474                 else {
1475                     ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown configuration key [" + key
1476                             + "] in: " + config_filename );
1477                 }
1478             }
1479         }
1480         else {
1481             ForesterUtil.printWarningMessage( Constants.PRG_NAME, "unknown configuration key [" + key + "] in: "
1482                     + config_filename );
1483         }
1484     }
1485
1486     public void setMinConfidenceValue( final double min_confidence_value ) {
1487         _min_confidence_value = min_confidence_value;
1488     }
1489
1490     public void setNodeLabelDirection( final NODE_LABEL_DIRECTION node_label_direction ) {
1491         _node_label_direction = node_label_direction;
1492     }
1493
1494     public void setNumberOfDigitsAfterCommaForBranchLengthValue( final short _number_of_digits_after_comma_for_branch_length_values ) {
1495         this._number_of_digits_after_comma_for_branch_length_values = _number_of_digits_after_comma_for_branch_length_values;
1496     }
1497
1498     public void setNumberOfDigitsAfterCommaForConfidenceValues( final short _number_of_digits_after_comma_for_confidence_values ) {
1499         this._number_of_digits_after_comma_for_confidence_values = _number_of_digits_after_comma_for_confidence_values;
1500     }
1501
1502     private void setOvMaxHeight( final short ov_max_height ) {
1503         _ov_max_height = ov_max_height;
1504     }
1505
1506     private void setOvMaxWidth( final short ov_max_width ) {
1507         _ov_max_width = ov_max_width;
1508     }
1509
1510     private void setOvPlacement( final OVERVIEW_PLACEMENT_TYPE ov_placement ) {
1511         _ov_placement = ov_placement;
1512     }
1513
1514     public void setPhylogenyGraphicsType( final PHYLOGENY_GRAPHICS_TYPE phylogeny_graphics_type ) {
1515         _phylogeny_graphics_type = phylogeny_graphics_type;
1516     }
1517
1518     public void setPrintLineWidth( final float print_line_width ) {
1519         _print_line_width = print_line_width;
1520     }
1521
1522     public void setReplaceUnderscoresInNhParsing( final boolean nh_parsing_replace_underscores ) {
1523         _nh_parsing_replace_underscores = nh_parsing_replace_underscores;
1524     }
1525
1526     public void setShowBranchLengthValues( final boolean show_branch_length_values ) {
1527         _show_branch_length_values = show_branch_length_values;
1528     }
1529
1530     public void setShowDefaultNodeShapes( final boolean show_default_node_shapes ) {
1531         _show_default_node_shapes = show_default_node_shapes;
1532     }
1533
1534     public void setShowDomainLabels( final boolean show_domain_labels ) {
1535         _show_domain_labels = show_domain_labels;
1536     }
1537
1538     private void setShowOverview( final boolean show_overview ) {
1539         _show_overview = show_overview;
1540     }
1541
1542     public void setShowScale( final boolean show_scale ) {
1543         _show_scale = show_scale;
1544     }
1545
1546     public void setTaxonomyColorize( final boolean b ) {
1547         display_options[ color_according_to_species ][ 2 ] = b ? "yes" : "no";
1548     }
1549
1550     public void setTaxonomyColorizeNodeShapes( final boolean taxonomy_colorize_node_shapes ) {
1551         _taxonomy_colorize_node_shapes = taxonomy_colorize_node_shapes;
1552     }
1553
1554     public void setUseBranchesWidths( final boolean b ) {
1555         display_options[ width_branches ][ 2 ] = b ? "yes" : "no";
1556     }
1557
1558     private void setValidatePhyloXmlAgainstSchema( final boolean validate_against_phyloxml_xsd_schema ) {
1559         _validate_against_phyloxml_xsd_schema = validate_against_phyloxml_xsd_schema;
1560     }
1561
1562     void setWebLinks( final SortedMap<String, WebLink> weblinks ) {
1563         _weblinks = weblinks;
1564     }
1565
1566     static String getDefaultFontFamilyName() {
1567         return DEFAULT_FONT_FAMILY;
1568     }
1569
1570     static enum TRIPLET {
1571         TRUE, FALSE, UNKNOWN
1572     }
1573
1574     public enum UI {
1575         NATIVE, CROSSPLATFORM, NIMBUS, UNKNOWN
1576     }
1577 }