forester/java/src/org/forester/archaeopteryx/Options.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2009 Christian M. Zmasek
   6 // Copyright (C) 2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  25
  26 package org.forester.archaeopteryx;
  27
  28 import java.awt.Font;
  29
  30 import org.forester.io.parsers.nhx.NHXParser.TAXONOMY_EXTRACTION;
  31 import org.forester.phylogeny.PhylogenyNode.NH_CONVERSION_SUPPORT_VALUE_STYLE;
  32 import org.forester.phylogeny.data.NodeData;
  33 import org.forester.phylogeny.data.NodeData.NODE_DATA;
  34 import org.forester.phylogeny.data.NodeVisualData;
  35 import org.forester.phylogeny.data.NodeVisualData.NodeFill;
  36 import org.forester.phylogeny.data.NodeVisualData.NodeShape;
  37 import org.forester.util.ForesterUtil;
  38 import org.omg.stub.java.rmi._Remote_Stub;
  39
  40 /*
  41  * This is to hold changeable options.
  42  */
  43 final public class Options {
  44
  45     static final double                       MIN_CONFIDENCE_DEFAULT = 0.0;
  46     private boolean                           _abbreviate_scientific_names;
  47     private boolean                           _allow_errors_in_distance_to_parent;
  48     private boolean                           _antialias_print;
  49     private boolean                           _antialias_screen;
  50     private boolean                           _background_color_gradient;
  51     private Font                              _base_font;
  52     private CLADOGRAM_TYPE                    _cladogram_type;
  53     private boolean                           _color_by_taxonomic_group;
  54     private boolean                           _color_labels_same_as_parent_branch;
  55     private NodeVisualData.NodeFill           _default_node_fill;
  56     private NodeVisualData.NodeShape          _default_node_shape;
  57     private short                             _default_node_shape_size;
  58     private boolean                           _editable;
  59     private NODE_DATA                         _ext_desc_data_to_return;
  60     private boolean                           _graphics_export_using_actual_size;
  61     private boolean                           _graphics_export_visible_only;
  62     private boolean                           _internal_number_are_confidence_for_nh_parsing;
  63     private boolean                           _inverse_search_result;
  64     private boolean                           _match_whole_terms_only;
  65     private double                            _min_confidence_value;
  66     private NH_CONVERSION_SUPPORT_VALUE_STYLE _nh_conversion_support_value_style;
  67     private boolean                           _nh_parsing_replace_underscores;
  68     private NODE_LABEL_DIRECTION              _node_label_direction;
  69     private short                             _number_of_digits_after_comma_for_branch_length_values;
  70     private short                             _number_of_digits_after_comma_for_confidence_values;
  71     private OVERVIEW_PLACEMENT_TYPE           _ov_placement;
  72     private PHYLOGENY_GRAPHICS_TYPE           _phylogeny_graphics_type;
  73     private boolean                           _print_black_and_white;
  74     private float                             _print_line_width;
  75     private int                               _print_size_x;
  76     private int                               _print_size_y;
  77     private boolean                           _print_using_actual_size;
  78     private double                            _scale_bar_length;
  79     private boolean                           _search_case_sensitive;
  80     private boolean                           _show_annotation_ref_source;
  81     private boolean                           _show_branch_length_values;
  82     private boolean                           _show_confidence_stddev;
  83     private boolean                           _show_default_node_shapes_external;
  84     private boolean                           _show_default_node_shapes_internal;
  85     private boolean                           _show_domain_labels;
  86     private boolean                           _show_overview;
  87     private boolean                           _show_scale;
  88     private TAXONOMY_EXTRACTION               _taxonomy_extraction;
  89     private boolean _line_up_renderable_node_data;
  90     private boolean _right_align_domains;
  91
  92     private Options() {
  93         init();
  94     }
  95
  96     public NodeData.NODE_DATA getExtDescNodeDataToReturn() {
  97         return _ext_desc_data_to_return;
  98     }
  99
 100     public boolean isAllowErrorsInDistanceToParent() {
 101         return _allow_errors_in_distance_to_parent;
 102     }
 103
 104     public boolean isAllowFontSizeChange() {
 105         return true;
 106     }
 107
 108     public final boolean isShowAnnotationRefSource() {
 109         return _show_annotation_ref_source;
 110     }
 111
 112     public final boolean isShowDomainLabels() {
 113         return _show_domain_labels;
 114     }
 115
 116     public final void setAllowErrorsInDistanceToParent( final boolean allow_errors_in_distance_to_parent ) {
 117         _allow_errors_in_distance_to_parent = allow_errors_in_distance_to_parent;
 118     }
 119
 120     public void setBackgroundColorGradient( final boolean background_color_gradient ) {
 121         _background_color_gradient = background_color_gradient;
 122     }
 123
 124     public void setColorLabelsSameAsParentBranch( final boolean color_labels_same_as_parent_branch ) {
 125         _color_labels_same_as_parent_branch = color_labels_same_as_parent_branch;
 126     }
 127
 128     public void setExtDescNodeDataToReturn( final NODE_DATA ext_desc_data_to_return ) {
 129         _ext_desc_data_to_return = ext_desc_data_to_return;
 130     }
 131
 132     public final void setShowAnnotationRefSource( final boolean show_annotation_ref_source ) {
 133         _show_annotation_ref_source = show_annotation_ref_source;
 134     }
 135
 136     public void setShowDomainLabels( final boolean show_domain_labels ) {
 137         _show_domain_labels = show_domain_labels;
 138     }
 139
 140     final Font getBaseFont() {
 141         return _base_font;
 142     }
 143
 144     final CLADOGRAM_TYPE getCladogramType() {
 145         return _cladogram_type;
 146     }
 147
 148     final NodeFill getDefaultNodeFill() {
 149         return _default_node_fill;
 150     }
 151
 152     final NodeShape getDefaultNodeShape() {
 153         return _default_node_shape;
 154     }
 155
 156     final short getDefaultNodeShapeSize() {
 157         return _default_node_shape_size;
 158     }
 159
 160     final double getMinConfidenceValue() {
 161         return _min_confidence_value;
 162     }
 163
 164     NH_CONVERSION_SUPPORT_VALUE_STYLE getNhConversionSupportValueStyle() {
 165         return _nh_conversion_support_value_style;
 166     }
 167
 168     final NODE_LABEL_DIRECTION getNodeLabelDirection() {
 169         return _node_label_direction;
 170     }
 171
 172     final short getNumberOfDigitsAfterCommaForBranchLengthValues() {
 173         return _number_of_digits_after_comma_for_branch_length_values;
 174     }
 175
 176     final short getNumberOfDigitsAfterCommaForConfidenceValues() {
 177         return _number_of_digits_after_comma_for_confidence_values;
 178     }
 179
 180     final OVERVIEW_PLACEMENT_TYPE getOvPlacement() {
 181         return _ov_placement;
 182     }
 183
 184     final PHYLOGENY_GRAPHICS_TYPE getPhylogenyGraphicsType() {
 185         return _phylogeny_graphics_type;
 186     }
 187
 188     final float getPrintLineWidth() {
 189         return _print_line_width;
 190     }
 191
 192     final int getPrintSizeX() {
 193         return _print_size_x;
 194     }
 195
 196     final int getPrintSizeY() {
 197         return _print_size_y;
 198     }
 199
 200     final double getScaleBarLength() {
 201         return _scale_bar_length;
 202     }
 203
 204     final TAXONOMY_EXTRACTION getTaxonomyExtraction() {
 205         return _taxonomy_extraction;
 206     }
 207
 208     final boolean isAbbreviateScientificTaxonNames() {
 209         return _abbreviate_scientific_names;
 210     }
 211
 212     boolean isAllowMagnificationOfTaxonomyImages() {
 213         return true;
 214     }
 215
 216     final boolean isAntialiasPrint() {
 217         return _antialias_print;
 218     }
 219
 220     final boolean isAntialiasScreen() {
 221         return _antialias_screen;
 222     }
 223
 224     final boolean isBackgroundColorGradient() {
 225         return _background_color_gradient;
 226     }
 227
 228     final boolean isColorByTaxonomicGroup() {
 229         return _color_by_taxonomic_group;
 230     }
 231
 232     final boolean isColorLabelsSameAsParentBranch() {
 233         return _color_labels_same_as_parent_branch;
 234     }
 235
 236     final boolean isEditable() {
 237         return _editable;
 238     }
 239
 240     final boolean isGraphicsExportUsingActualSize() {
 241         return _graphics_export_using_actual_size;
 242     }
 243
 244     final boolean isGraphicsExportVisibleOnly() {
 245         return _graphics_export_visible_only;
 246     }
 247
 248     final boolean isInternalNumberAreConfidenceForNhParsing() {
 249         return _internal_number_are_confidence_for_nh_parsing;
 250     }
 251
 252     final boolean isInverseSearchResult() {
 253         return _inverse_search_result;
 254     }
 255
 256     final boolean isMatchWholeTermsOnly() {
 257         return _match_whole_terms_only;
 258     }
 259
 260     final boolean isPrintBlackAndWhite() {
 261         return _print_black_and_white;
 262     }
 263
 264     final boolean isPrintUsingActualSize() {
 265         return _print_using_actual_size;
 266     }
 267
 268     final boolean isReplaceUnderscoresInNhParsing() {
 269         return _nh_parsing_replace_underscores;
 270     }
 271
 272     final boolean isSearchCaseSensitive() {
 273         return _search_case_sensitive;
 274     }
 275
 276     final boolean isShowBranchLengthValues() {
 277         return _show_branch_length_values;
 278     }
 279
 280     boolean isShowConfidenceStddev() {
 281         return _show_confidence_stddev;
 282     }
 283
 284     boolean isShowDefaultNodeShapesExternal() {
 285         return _show_default_node_shapes_external;
 286     }
 287
 288     boolean isShowDefaultNodeShapesInternal() {
 289         return _show_default_node_shapes_internal;
 290     }
 291
 292     final boolean isShowOverview() {
 293         return _show_overview;
 294     }
 295
 296     final boolean isShowScale() {
 297         return _show_scale;
 298     }
 299
 300     final void setAbbreviateScientificTaxonNames( final boolean abbreviate_scientific_names ) {
 301         _abbreviate_scientific_names = abbreviate_scientific_names;
 302     }
 303
 304     final void setAntialiasPrint( final boolean antialias_print ) {
 305         _antialias_print = antialias_print;
 306     }
 307
 308     final void setAntialiasScreen( final boolean antialias_screen ) {
 309         _antialias_screen = antialias_screen;
 310     }
 311
 312     final void setBaseFont( final Font base_font ) {
 313         _base_font = base_font;
 314     }
 315
 316     final void setCladogramType( final CLADOGRAM_TYPE cladogram_type ) {
 317         _cladogram_type = cladogram_type;
 318     }
 319
 320     final void setColorByTaxonomicGroup( final boolean color_by_taxonomic_group ) {
 321         _color_by_taxonomic_group = color_by_taxonomic_group;
 322     }
 323
 324     final void setDefaultNodeFill( final NodeFill default_node_fill ) {
 325         _default_node_fill = default_node_fill;
 326     }
 327
 328     final void setDefaultNodeShape( final NodeShape default_node_shape ) {
 329         _default_node_shape = default_node_shape;
 330     }
 331
 332     final void setDefaultNodeShapeSize( final short default_node_shape_size ) {
 333         _default_node_shape_size = default_node_shape_size;
 334     }
 335
 336     final void setEditable( final boolean editable ) {
 337         _editable = editable;
 338     }
 339
 340     final void setGraphicsExportUsingActualSize( final boolean graphics_export_using_actual_size ) {
 341         _graphics_export_using_actual_size = graphics_export_using_actual_size;
 342         if ( !graphics_export_using_actual_size ) {
 343             setGraphicsExportVisibleOnly( false );
 344         }
 345     }
 346
 347     final void setGraphicsExportVisibleOnly( final boolean graphics_export_visible_only ) {
 348         _graphics_export_visible_only = graphics_export_visible_only;
 349         if ( graphics_export_visible_only ) {
 350             setGraphicsExportUsingActualSize( true );
 351         }
 352     }
 353
 354     final void setInternalNumberAreConfidenceForNhParsing( final boolean internal_number_are_confidence_for_nh_parsing ) {
 355         _internal_number_are_confidence_for_nh_parsing = internal_number_are_confidence_for_nh_parsing;
 356     }
 357
 358     final void setInverseSearchResult( final boolean inverse_search_result ) {
 359         _inverse_search_result = inverse_search_result;
 360     }
 361
 362     final void setMatchWholeTermsOnly( final boolean search_whole_words_only ) {
 363         _match_whole_terms_only = search_whole_words_only;
 364     }
 365
 366     final void setMinConfidenceValue( final double min_confidence_value ) {
 367         _min_confidence_value = min_confidence_value;
 368     }
 369
 370     void setNhConversionSupportValueStyle( final NH_CONVERSION_SUPPORT_VALUE_STYLE nh_conversion_support_value_style ) {
 371         _nh_conversion_support_value_style = nh_conversion_support_value_style;
 372     }
 373
 374     final void setNodeLabelDirection( final NODE_LABEL_DIRECTION node_label_direction ) {
 375         _node_label_direction = node_label_direction;
 376     }
 377
 378     final void setOvPlacement( final OVERVIEW_PLACEMENT_TYPE ov_placement ) {
 379         _ov_placement = ov_placement;
 380     }
 381
 382     final void setPhylogenyGraphicsType( final PHYLOGENY_GRAPHICS_TYPE phylogeny_graphics_type ) {
 383         _phylogeny_graphics_type = phylogeny_graphics_type;
 384     }
 385
 386     final void setPrintBlackAndWhite( final boolean print_black_and_white ) {
 387         _print_black_and_white = print_black_and_white;
 388     }
 389
 390     final void setPrintLineWidth( final float print_line_width ) {
 391         _print_line_width = print_line_width;
 392     }
 393
 394     final void setPrintSizeX( final int print_size_x ) {
 395         _print_size_x = print_size_x;
 396     }
 397
 398     final void setPrintSizeY( final int print_size_y ) {
 399         _print_size_y = print_size_y;
 400     }
 401
 402     final void setPrintUsingActualSize( final boolean print_using_actual_size ) {
 403         _print_using_actual_size = print_using_actual_size;
 404     }
 405
 406     final void setReplaceUnderscoresInNhParsing( final boolean nh_parsing_replace_underscores ) {
 407         _nh_parsing_replace_underscores = nh_parsing_replace_underscores;
 408     }
 409
 410     final void setScaleBarLength( final double scale_bar_length ) {
 411         _scale_bar_length = scale_bar_length;
 412     }
 413
 414     final void setSearchCaseSensitive( final boolean search_case_sensitive ) {
 415         _search_case_sensitive = search_case_sensitive;
 416     }
 417
 418     final void setShowBranchLengthValues( final boolean show_branch_length_values ) {
 419         _show_branch_length_values = show_branch_length_values;
 420     }
 421
 422     void setShowConfidenceStddev( final boolean show_confidence_stddev ) {
 423         _show_confidence_stddev = show_confidence_stddev;
 424     }
 425
 426     void setShowDefaultNodeShapesExternal( final boolean show_default_node_shapes_external ) {
 427         _show_default_node_shapes_external = show_default_node_shapes_external;
 428     }
 429
 430     void setShowDefaultNodeShapesInternal( final boolean show_default_node_shapes_internal ) {
 431         _show_default_node_shapes_internal = show_default_node_shapes_internal;
 432     }
 433
 434     final void setShowOverview( final boolean show_overview ) {
 435         _show_overview = show_overview;
 436     }
 437
 438     final void setShowScale( final boolean show_scale ) {
 439         _show_scale = show_scale;
 440     }
 441
 442     final void setTaxonomyExtraction( final TAXONOMY_EXTRACTION taxonomy_extraction ) {
 443         _taxonomy_extraction = taxonomy_extraction;
 444     }
 445
 446     final private void init() {
 447         _default_node_shape = NodeShape.CIRCLE;
 448         _default_node_fill = NodeFill.GRADIENT;
 449         _default_node_shape_size = Constants.DEFAULT_NODE_SHAPE_SIZE_DEFAULT;
 450         _show_branch_length_values = false;
 451         _internal_number_are_confidence_for_nh_parsing = false;
 452         _show_scale = false;
 453         _antialias_screen = true;
 454         _antialias_print = true;
 455         _graphics_export_visible_only = false;
 456         _editable = true;
 457         _background_color_gradient = false;
 458         _show_default_node_shapes_internal = false;
 459         _show_default_node_shapes_external = false;
 460         if ( AptxUtil.isUsOrCanada() ) {
 461             _print_size_x = Constants.US_LETTER_SIZE_X;
 462             _print_size_y = Constants.US_LETTER_SIZE_Y;
 463         }
 464         else {
 465             _print_size_x = Constants.A4_SIZE_X;
 466             _print_size_y = Constants.A4_SIZE_Y;
 467         }
 468         _min_confidence_value = MIN_CONFIDENCE_DEFAULT;
 469         _print_black_and_white = false;
 470         _print_using_actual_size = true;
 471         _graphics_export_using_actual_size = true;
 472         _phylogeny_graphics_type = PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR;
 473         _base_font = new Font( Configuration.getDefaultFontFamilyName(), Font.PLAIN, 10 );
 474         _match_whole_terms_only = false;
 475         _search_case_sensitive = false;
 476         _print_line_width = Constants.PDF_LINE_WIDTH_DEFAULT;
 477         _show_overview = true;
 478         _ov_placement = OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT;
 479         _node_label_direction = NODE_LABEL_DIRECTION.HORIZONTAL;
 480         _inverse_search_result = false;
 481         _scale_bar_length = 0.0;
 482         _number_of_digits_after_comma_for_branch_length_values = Constants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_BRANCH_LENGTH_VALUES_DEFAULT;
 483         _number_of_digits_after_comma_for_confidence_values = Constants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_CONFIDENCE_VALUES_DEFAULT;
 484         _nh_parsing_replace_underscores = false;
 485         _taxonomy_extraction = TAXONOMY_EXTRACTION.NO;
 486         _cladogram_type = Constants.CLADOGRAM_TYPE_DEFAULT;
 487         _show_domain_labels = true;
 488         _show_annotation_ref_source = true;
 489         setAbbreviateScientificTaxonNames( false );
 490         _color_labels_same_as_parent_branch = false;
 491         _show_confidence_stddev = true;
 492         _nh_conversion_support_value_style = NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE;
 493         _ext_desc_data_to_return = NODE_DATA.UNKNOWN;
 494         _line_up_renderable_node_data = false;
 495         _right_align_domains = false;
 496     }
 497
 498     final private void setNumberOfDigitsAfterCommaForBranchLength( final short number_of_digits_after_comma_for_branch_length_values ) {
 499         _number_of_digits_after_comma_for_branch_length_values = number_of_digits_after_comma_for_branch_length_values;
 500     }
 501
 502     final private void setNumberOfDigitsAfterCommaForConfidenceValues( final short number_of_digits_after_comma_for_confidence_values ) {
 503         _number_of_digits_after_comma_for_confidence_values = number_of_digits_after_comma_for_confidence_values;
 504     }
 505
 506     public final static Options createInstance( final Configuration configuration ) {
 507         final Options instance = createDefaultInstance();
 508         if ( configuration != null ) {
 509             instance.setAntialiasScreen( configuration.isAntialiasScreen() );
 510             instance.setShowScale( configuration.isShowScale() );
 511             instance.setShowBranchLengthValues( configuration.isShowBranchLengthValues() );
 512             instance.setShowOverview( configuration.isShowOverview() );
 513             instance.setColorByTaxonomicGroup( configuration.isColorByTaxonomicGroup() );
 514             instance.setCladogramType( configuration.getCladogramType() );
 515             instance.setOvPlacement( configuration.getOvPlacement() );
 516             instance.setPrintLineWidth( configuration.getPrintLineWidth() );
 517             instance.setNodeLabelDirection( configuration.getNodeLabelDirection() );
 518             instance.setBackgroundColorGradient( configuration.isBackgroundColorGradient() );
 519             if ( configuration.getNumberOfDigitsAfterCommaForBranchLengthValues() >= 0 ) {
 520                 instance.setNumberOfDigitsAfterCommaForBranchLength( configuration
 521                         .getNumberOfDigitsAfterCommaForBranchLengthValues() );
 522             }
 523             if ( configuration.getNumberOfDigitsAfterCommaForConfidenceValues() >= 0 ) {
 524                 instance.setNumberOfDigitsAfterCommaForConfidenceValues( configuration
 525                         .getNumberOfDigitsAfterCommaForConfidenceValues() );
 526             }
 527             instance.setTaxonomyExtraction( configuration.getTaxonomyExtraction() );
 528             instance.setReplaceUnderscoresInNhParsing( configuration.isReplaceUnderscoresInNhParsing() );
 529             instance.setInternalNumberAreConfidenceForNhParsing( configuration
 530                     .isInternalNumberAreConfidenceForNhParsing() );
 531             instance.setEditable( configuration.isEditable() );
 532             instance.setColorLabelsSameAsParentBranch( configuration.isColorLabelsSameAsParentBranch() );
 533             instance.setShowDomainLabels( configuration.isShowDomainLabels() );
 534             instance.setShowAnnotationRefSource( configuration.isShowAnnotationRefSource() );
 535             instance.setAbbreviateScientificTaxonNames( configuration.isAbbreviateScientificTaxonNames() );
 536             if ( configuration.getMinConfidenceValue() != MIN_CONFIDENCE_DEFAULT ) {
 537                 instance.setMinConfidenceValue( configuration.getMinConfidenceValue() );
 538             }
 539             if ( configuration.getGraphicsExportX() > 0 ) {
 540                 instance.setPrintSizeX( configuration.getGraphicsExportX() );
 541             }
 542             if ( configuration.getGraphicsExportY() > 0 ) {
 543                 instance.setPrintSizeY( configuration.getGraphicsExportY() );
 544             }
 545             if ( configuration.getBaseFontSize() > 0 ) {
 546                 instance.setBaseFont( instance.getBaseFont().deriveFont( ( float ) configuration.getBaseFontSize() ) );
 547             }
 548             if ( !ForesterUtil.isEmpty( configuration.getBaseFontFamilyName() ) ) {
 549                 instance.setBaseFont( new Font( configuration.getBaseFontFamilyName(), Font.PLAIN, instance
 550                         .getBaseFont().getSize() ) );
 551             }
 552             if ( configuration.getPhylogenyGraphicsType() != null ) {
 553                 instance.setPhylogenyGraphicsType( configuration.getPhylogenyGraphicsType() );
 554             }
 555             if ( configuration.getDefaultNodeFill() != null ) {
 556                 instance.setDefaultNodeFill( configuration.getDefaultNodeFill() );
 557             }
 558             if ( configuration.getDefaultNodeShape() != null ) {
 559                 instance.setDefaultNodeShape( configuration.getDefaultNodeShape() );
 560             }
 561             if ( configuration.getDefaultNodeShapeSize() >= 0 ) {
 562                 instance.setDefaultNodeShapeSize( configuration.getDefaultNodeShapeSize() );
 563             }
 564             instance.setShowDefaultNodeShapesInternal( configuration.isShowDefaultNodeShapesInternal() );
 565             instance.setShowDefaultNodeShapesExternal( configuration.isShowDefaultNodeShapesExternal() );
 566             if ( configuration.getExtDescNodeDataToReturn() != null ) {
 567                 instance.setExtDescNodeDataToReturn( configuration.getExtDescNodeDataToReturn() );
 568             }
 569
 570             instance.setRightLineUpDomains(  configuration.isRightLineUpDomains() );
 571             instance.setLineUpRendarableNodeData(  configuration.isLineUpRendarableNodeData() );
 572             instance.setAllowErrorsInDistanceToParent( false );
 573         }
 574         return instance;
 575     }
 576
 577     final static Options createDefaultInstance() {
 578         return new Options();
 579     }
 580
 581     public static enum CLADOGRAM_TYPE {
 582         EXT_NODE_SUM_DEP, NON_LINED_UP, TOTAL_NODE_SUM_DEP;
 583     }
 584
 585     public static enum NODE_LABEL_DIRECTION {
 586         HORIZONTAL, RADIAL;
 587     }
 588
 589     public static enum PHYLOGENY_GRAPHICS_TYPE {
 590         CIRCULAR, CONVEX, CURVED, EURO_STYLE, RECTANGULAR, ROUNDED, TRIANGULAR, UNROOTED;
 591     }
 592
 593     static enum OVERVIEW_PLACEMENT_TYPE {
 594         LOWER_LEFT( "lower left" ),
 595         LOWER_RIGHT( "lower right" ),
 596         UPPER_LEFT( "upper left" ),
 597         UPPER_RIGHT( "upper right" );
 598
 599         private final String _name;
 600
 601         private OVERVIEW_PLACEMENT_TYPE( final String name ) {
 602             _name = name;
 603         }
 604
 605         @Override
 606         public String toString() {
 607             return _name;
 608         }
 609
 610         public String toTag() {
 611             return toString().replaceAll( " ", "_" );
 612         }
 613     }
 614
 615     final public boolean isLineUpRendarableNodeData() {
 616
 617         return _line_up_renderable_node_data;
 618     }
 619
 620     final public boolean isRightLineUpDomains() {
 621
 622         return _right_align_domains;
 623     }
 624
 625     final public void setLineUpRendarableNodeData( final boolean line_up_renderable_node_data) {
 626
 627          _line_up_renderable_node_data = line_up_renderable_node_data;
 628     }
 629
 630     final public void setRightLineUpDomains( final boolean right_align_domains ) {
 631
 632         _right_align_domains = right_align_domains;
 633     }
 634
 635 }