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