2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
5 // Copyright (C) 2009 Christian M. Zmasek
6 // Copyright (C) 2009 Burnham Institute for Medical Research
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.
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.
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
23 // Contact: phylosoft @ gmail . com
24 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
26 package org.forester.archaeopteryx;
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.NodeDataField;
33 import org.forester.phylogeny.data.NodeVisualData;
34 import org.forester.phylogeny.data.NodeVisualData.NodeFill;
35 import org.forester.phylogeny.data.NodeVisualData.NodeShape;
36 import org.forester.util.ForesterUtil;
39 * This is to hold changeable options.
41 final public class Options {
43 public static enum CLADOGRAM_TYPE {
44 EXT_NODE_SUM_DEP, NON_LINED_UP, TOTAL_NODE_SUM_DEP;
47 public static enum NODE_LABEL_DIRECTION {
51 public static enum PHYLOGENY_GRAPHICS_TYPE {
52 CIRCULAR, CONVEX, CURVED, EURO_STYLE, RECTANGULAR, ROUNDED, TRIANGULAR, UNROOTED;
55 static enum OVERVIEW_PLACEMENT_TYPE {
56 LOWER_LEFT( "lower left" ),
57 LOWER_RIGHT( "lower right" ),
58 UPPER_LEFT( "upper left" ),
59 UPPER_RIGHT( "upper right" );
61 private final String _name;
63 private OVERVIEW_PLACEMENT_TYPE( final String name ) {
68 public String toString() {
72 public String toTag() {
73 return toString().replaceAll( " ", "_" );
76 static final double MIN_CONFIDENCE_DEFAULT = 0.0;
77 private boolean _abbreviate_scientific_names;
78 private boolean _allow_errors_in_distance_to_parent;
79 private boolean _antialias_print;
80 private boolean _antialias_screen;
81 private boolean _background_color_gradient;
82 private Font _base_font;
83 private CLADOGRAM_TYPE _cladogram_type;
84 private boolean _color_by_taxonomic_group;
85 private boolean _color_labels_same_as_parent_branch;
86 private NodeVisualData.NodeFill _default_node_fill;
87 private NodeVisualData.NodeShape _default_node_shape;
88 private short _default_node_shape_size;
89 private boolean _editable;
90 private NodeDataField _ext_desc_data_to_return;
91 private boolean _graphics_export_using_actual_size;
92 private boolean _graphics_export_visible_only;
93 private boolean _internal_number_are_confidence_for_nh_parsing;
94 private boolean _inverse_search_result;
95 private boolean _match_whole_terms_only;
96 private boolean _search_with_regex;
97 private double _min_confidence_value;
98 private NH_CONVERSION_SUPPORT_VALUE_STYLE _nh_conversion_support_value_style;
99 private boolean _nh_parsing_replace_underscores;
100 private NODE_LABEL_DIRECTION _node_label_direction;
101 private short _number_of_digits_after_comma_for_branch_length_values;
102 private short _number_of_digits_after_comma_for_confidence_values;
103 private OVERVIEW_PLACEMENT_TYPE _ov_placement;
104 private PHYLOGENY_GRAPHICS_TYPE _phylogeny_graphics_type;
105 private boolean _print_black_and_white;
106 private float _print_line_width;
107 private int _print_size_x;
108 private int _print_size_y;
109 private boolean _print_using_actual_size;
110 private double _scale_bar_length;
111 private boolean _search_case_sensitive;
112 private boolean _show_annotation_ref_source;
113 private boolean _show_confidence_stddev;
114 private boolean _show_default_node_shapes_for_marked_nodes;
115 private boolean _show_default_node_shapes_external;
116 private boolean _show_default_node_shapes_internal;
117 private boolean _show_domain_labels;
118 private boolean _show_overview;
119 private boolean _show_scale;
120 private TAXONOMY_EXTRACTION _taxonomy_extraction;
121 private boolean _line_up_renderable_node_data;
122 private boolean _right_align_domains;
128 public NodeDataField getExtDescNodeDataToReturn() {
129 return _ext_desc_data_to_return;
132 public boolean isAllowErrorsInDistanceToParent() {
133 return _allow_errors_in_distance_to_parent;
136 final public boolean isLineUpRendarableNodeData() {
137 return _line_up_renderable_node_data;
140 final public boolean isRightLineUpDomains() {
141 return _right_align_domains;
144 public final boolean isShowAnnotationRefSource() {
145 return _show_annotation_ref_source;
148 public final boolean isShowDomainLabels() {
149 return _show_domain_labels;
152 public final void setAllowErrorsInDistanceToParent( final boolean allow_errors_in_distance_to_parent ) {
153 _allow_errors_in_distance_to_parent = allow_errors_in_distance_to_parent;
156 public void setBackgroundColorGradient( final boolean background_color_gradient ) {
157 _background_color_gradient = background_color_gradient;
160 public void setColorLabelsSameAsParentBranch( final boolean color_labels_same_as_parent_branch ) {
161 _color_labels_same_as_parent_branch = color_labels_same_as_parent_branch;
164 public void setExtDescNodeDataToReturn( final NodeDataField ext_desc_data_to_return ) {
165 _ext_desc_data_to_return = ext_desc_data_to_return;
168 final public void setLineUpRendarableNodeData( final boolean line_up_renderable_node_data ) {
169 _line_up_renderable_node_data = line_up_renderable_node_data;
172 final public void setRightLineUpDomains( final boolean right_align_domains ) {
173 _right_align_domains = right_align_domains;
176 public final void setShowAnnotationRefSource( final boolean show_annotation_ref_source ) {
177 _show_annotation_ref_source = show_annotation_ref_source;
180 public void setShowDomainLabels( final boolean show_domain_labels ) {
181 _show_domain_labels = show_domain_labels;
184 final private void init() {
185 _default_node_shape = NodeShape.CIRCLE;
186 _default_node_fill = NodeFill.GRADIENT;
187 _default_node_shape_size = Constants.DEFAULT_NODE_SHAPE_SIZE_DEFAULT;
188 _internal_number_are_confidence_for_nh_parsing = false;
190 _antialias_screen = true;
191 _antialias_print = true;
192 _graphics_export_visible_only = false;
194 _background_color_gradient = false;
195 _show_default_node_shapes_internal = false;
196 _show_default_node_shapes_external = false;
197 _show_default_node_shapes_for_marked_nodes = false;
198 if ( AptxUtil.isUsOrCanada() ) {
199 _print_size_x = Constants.US_LETTER_SIZE_X;
200 _print_size_y = Constants.US_LETTER_SIZE_Y;
203 _print_size_x = Constants.A4_SIZE_X;
204 _print_size_y = Constants.A4_SIZE_Y;
206 _min_confidence_value = MIN_CONFIDENCE_DEFAULT;
207 _print_black_and_white = false;
208 _print_using_actual_size = true;
209 _graphics_export_using_actual_size = true;
210 _phylogeny_graphics_type = PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR;
211 _base_font = new Font( Configuration.getDefaultFontFamilyName(), Font.PLAIN, 10 );
212 _match_whole_terms_only = false;
213 _search_with_regex = false;
214 _search_case_sensitive = false;
215 _print_line_width = Constants.PDF_LINE_WIDTH_DEFAULT;
216 _show_overview = true;
217 _ov_placement = OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT;
218 _node_label_direction = NODE_LABEL_DIRECTION.HORIZONTAL;
219 _inverse_search_result = false;
220 _scale_bar_length = 0.0;
221 _number_of_digits_after_comma_for_branch_length_values = Constants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_BRANCH_LENGTH_VALUES_DEFAULT;
222 _number_of_digits_after_comma_for_confidence_values = Constants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_CONFIDENCE_VALUES_DEFAULT;
223 _nh_parsing_replace_underscores = false;
224 _taxonomy_extraction = TAXONOMY_EXTRACTION.NO;
225 _cladogram_type = Constants.CLADOGRAM_TYPE_DEFAULT;
226 _show_domain_labels = true;
227 _show_annotation_ref_source = true;
228 setAbbreviateScientificTaxonNames( false );
229 _color_labels_same_as_parent_branch = false;
230 _show_confidence_stddev = false;
231 _nh_conversion_support_value_style = NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE;
232 _ext_desc_data_to_return = NodeDataField.UNKNOWN;
233 _line_up_renderable_node_data = true;
234 _right_align_domains = false;
237 final private void setNumberOfDigitsAfterCommaForBranchLength( final short number_of_digits_after_comma_for_branch_length_values ) {
238 _number_of_digits_after_comma_for_branch_length_values = number_of_digits_after_comma_for_branch_length_values;
241 final private void setNumberOfDigitsAfterCommaForConfidenceValues( final short number_of_digits_after_comma_for_confidence_values ) {
242 _number_of_digits_after_comma_for_confidence_values = number_of_digits_after_comma_for_confidence_values;
245 final Font getBaseFont() {
249 final CLADOGRAM_TYPE getCladogramType() {
250 return _cladogram_type;
253 final NodeFill getDefaultNodeFill() {
254 return _default_node_fill;
257 final NodeShape getDefaultNodeShape() {
258 return _default_node_shape;
261 final short getDefaultNodeShapeSize() {
262 return _default_node_shape_size;
265 final double getMinConfidenceValue() {
266 return _min_confidence_value;
269 NH_CONVERSION_SUPPORT_VALUE_STYLE getNhConversionSupportValueStyle() {
270 return _nh_conversion_support_value_style;
273 final NODE_LABEL_DIRECTION getNodeLabelDirection() {
274 return _node_label_direction;
277 final short getNumberOfDigitsAfterCommaForBranchLengthValues() {
278 return _number_of_digits_after_comma_for_branch_length_values;
281 final short getNumberOfDigitsAfterCommaForConfidenceValues() {
282 return _number_of_digits_after_comma_for_confidence_values;
285 final OVERVIEW_PLACEMENT_TYPE getOvPlacement() {
286 return _ov_placement;
289 final PHYLOGENY_GRAPHICS_TYPE getPhylogenyGraphicsType() {
290 return _phylogeny_graphics_type;
293 final float getPrintLineWidth() {
294 return _print_line_width;
297 final int getPrintSizeX() {
298 return _print_size_x;
301 final int getPrintSizeY() {
302 return _print_size_y;
305 final double getScaleBarLength() {
306 return _scale_bar_length;
309 final TAXONOMY_EXTRACTION getTaxonomyExtraction() {
310 return _taxonomy_extraction;
313 final boolean isAbbreviateScientificTaxonNames() {
314 return _abbreviate_scientific_names;
317 boolean isAllowMagnificationOfTaxonomyImages() {
321 final boolean isAntialiasPrint() {
322 return _antialias_print;
325 final boolean isAntialiasScreen() {
326 return _antialias_screen;
329 final boolean isBackgroundColorGradient() {
330 return _background_color_gradient;
333 final boolean isColorByTaxonomicGroup() {
334 return _color_by_taxonomic_group;
337 final boolean isColorLabelsSameAsParentBranch() {
338 return _color_labels_same_as_parent_branch;
341 final boolean isEditable() {
345 final boolean isGraphicsExportUsingActualSize() {
346 return _graphics_export_using_actual_size;
349 final boolean isGraphicsExportVisibleOnly() {
350 return _graphics_export_visible_only;
353 final boolean isInternalNumberAreConfidenceForNhParsing() {
354 return _internal_number_are_confidence_for_nh_parsing;
357 final boolean isInverseSearchResult() {
358 return _inverse_search_result;
361 final boolean isMatchWholeTermsOnly() {
362 return _match_whole_terms_only;
365 final boolean isPrintBlackAndWhite() {
366 return _print_black_and_white;
369 final boolean isPrintUsingActualSize() {
370 return _print_using_actual_size;
373 final boolean isReplaceUnderscoresInNhParsing() {
374 return _nh_parsing_replace_underscores;
377 final boolean isSearchCaseSensitive() {
378 return _search_case_sensitive;
381 final boolean isSearchWithRegex() {
382 return _search_with_regex;
385 boolean isShowConfidenceStddev() {
386 return _show_confidence_stddev;
389 boolean isShowDefaultNodeShapesExternal() {
390 return _show_default_node_shapes_external;
393 boolean isShowDefaultNodeShapesForMarkedNodes() {
394 return _show_default_node_shapes_for_marked_nodes;
397 boolean isShowDefaultNodeShapesInternal() {
398 return _show_default_node_shapes_internal;
401 final boolean isShowOverview() {
402 return _show_overview;
405 final boolean isShowScale() {
409 final void setAbbreviateScientificTaxonNames( final boolean abbreviate_scientific_names ) {
410 _abbreviate_scientific_names = abbreviate_scientific_names;
413 final void setAntialiasPrint( final boolean antialias_print ) {
414 _antialias_print = antialias_print;
417 final void setAntialiasScreen( final boolean antialias_screen ) {
418 _antialias_screen = antialias_screen;
421 final void setBaseFont( final Font base_font ) {
422 _base_font = base_font;
425 final void setCladogramType( final CLADOGRAM_TYPE cladogram_type ) {
426 _cladogram_type = cladogram_type;
429 final void setColorByTaxonomicGroup( final boolean color_by_taxonomic_group ) {
430 _color_by_taxonomic_group = color_by_taxonomic_group;
433 final void setDefaultNodeFill( final NodeFill default_node_fill ) {
434 _default_node_fill = default_node_fill;
437 final void setDefaultNodeShape( final NodeShape default_node_shape ) {
438 _default_node_shape = default_node_shape;
441 final void setDefaultNodeShapeSize( final short default_node_shape_size ) {
442 _default_node_shape_size = default_node_shape_size;
445 final void setEditable( final boolean editable ) {
446 _editable = editable;
449 final void setGraphicsExportUsingActualSize( final boolean graphics_export_using_actual_size ) {
450 _graphics_export_using_actual_size = graphics_export_using_actual_size;
451 if ( !graphics_export_using_actual_size ) {
452 setGraphicsExportVisibleOnly( false );
456 final void setGraphicsExportVisibleOnly( final boolean graphics_export_visible_only ) {
457 _graphics_export_visible_only = graphics_export_visible_only;
458 if ( graphics_export_visible_only ) {
459 setGraphicsExportUsingActualSize( true );
463 final void setInternalNumberAreConfidenceForNhParsing( final boolean internal_number_are_confidence_for_nh_parsing ) {
464 _internal_number_are_confidence_for_nh_parsing = internal_number_are_confidence_for_nh_parsing;
467 final void setInverseSearchResult( final boolean inverse_search_result ) {
468 _inverse_search_result = inverse_search_result;
471 final void setMatchWholeTermsOnly( final boolean search_whole_words_only ) {
472 _match_whole_terms_only = search_whole_words_only;
475 final void setMinConfidenceValue( final double min_confidence_value ) {
476 _min_confidence_value = min_confidence_value;
479 void setNhConversionSupportValueStyle( final NH_CONVERSION_SUPPORT_VALUE_STYLE nh_conversion_support_value_style ) {
480 _nh_conversion_support_value_style = nh_conversion_support_value_style;
483 final void setNodeLabelDirection( final NODE_LABEL_DIRECTION node_label_direction ) {
484 _node_label_direction = node_label_direction;
487 final void setOvPlacement( final OVERVIEW_PLACEMENT_TYPE ov_placement ) {
488 _ov_placement = ov_placement;
491 final void setPhylogenyGraphicsType( final PHYLOGENY_GRAPHICS_TYPE phylogeny_graphics_type ) {
492 _phylogeny_graphics_type = phylogeny_graphics_type;
495 final void setPrintBlackAndWhite( final boolean print_black_and_white ) {
496 _print_black_and_white = print_black_and_white;
499 final void setPrintLineWidth( final float print_line_width ) {
500 _print_line_width = print_line_width;
503 final void setPrintSizeX( final int print_size_x ) {
504 _print_size_x = print_size_x;
507 final void setPrintSizeY( final int print_size_y ) {
508 _print_size_y = print_size_y;
511 final void setPrintUsingActualSize( final boolean print_using_actual_size ) {
512 _print_using_actual_size = print_using_actual_size;
515 final void setReplaceUnderscoresInNhParsing( final boolean nh_parsing_replace_underscores ) {
516 _nh_parsing_replace_underscores = nh_parsing_replace_underscores;
519 final void setScaleBarLength( final double scale_bar_length ) {
520 _scale_bar_length = scale_bar_length;
523 final void setSearchCaseSensitive( final boolean search_case_sensitive ) {
524 _search_case_sensitive = search_case_sensitive;
527 final void setSearchWithRegex( final boolean search_with_regex ) {
528 _search_with_regex = search_with_regex;
531 void setShowConfidenceStddev( final boolean show_confidence_stddev ) {
532 _show_confidence_stddev = show_confidence_stddev;
535 void setShowDefaultNodeShapesExternal( final boolean show_default_node_shapes_external ) {
536 _show_default_node_shapes_external = show_default_node_shapes_external;
539 void setShowDefaultNodeShapesForMarkedNodes( final boolean show_default_node_shapes_for_marked_nodes ) {
540 _show_default_node_shapes_for_marked_nodes = show_default_node_shapes_for_marked_nodes;
543 void setShowDefaultNodeShapesInternal( final boolean show_default_node_shapes_internal ) {
544 _show_default_node_shapes_internal = show_default_node_shapes_internal;
547 final void setShowOverview( final boolean show_overview ) {
548 _show_overview = show_overview;
551 final void setShowScale( final boolean show_scale ) {
552 _show_scale = show_scale;
555 final void setTaxonomyExtraction( final TAXONOMY_EXTRACTION taxonomy_extraction ) {
556 _taxonomy_extraction = taxonomy_extraction;
559 public final static Options createInstance( final Configuration configuration ) {
560 final Options instance = createDefaultInstance();
561 if ( configuration != null ) {
562 instance.setAntialiasScreen( configuration.isAntialiasScreen() );
563 instance.setShowScale( configuration.isShowScale() );
564 instance.setShowOverview( configuration.isShowOverview() );
565 instance.setColorByTaxonomicGroup( configuration.isColorByTaxonomicGroup() );
566 instance.setCladogramType( configuration.getCladogramType() );
567 instance.setOvPlacement( configuration.getOvPlacement() );
568 instance.setPrintLineWidth( configuration.getPrintLineWidth() );
569 instance.setNodeLabelDirection( configuration.getNodeLabelDirection() );
570 instance.setBackgroundColorGradient( configuration.isBackgroundColorGradient() );
571 if ( configuration.getNumberOfDigitsAfterCommaForBranchLengthValues() >= 0 ) {
572 instance.setNumberOfDigitsAfterCommaForBranchLength( configuration
573 .getNumberOfDigitsAfterCommaForBranchLengthValues() );
575 if ( configuration.getNumberOfDigitsAfterCommaForConfidenceValues() >= 0 ) {
576 instance.setNumberOfDigitsAfterCommaForConfidenceValues( configuration
577 .getNumberOfDigitsAfterCommaForConfidenceValues() );
579 instance.setTaxonomyExtraction( configuration.getTaxonomyExtraction() );
580 instance.setReplaceUnderscoresInNhParsing( configuration.isReplaceUnderscoresInNhParsing() );
581 instance.setInternalNumberAreConfidenceForNhParsing( configuration
582 .isInternalNumberAreConfidenceForNhParsing() );
583 instance.setEditable( configuration.isEditable() );
584 instance.setColorLabelsSameAsParentBranch( configuration.isColorLabelsSameAsParentBranch() );
585 instance.setShowDomainLabels( configuration.isShowDomainLabels() );
586 instance.setShowAnnotationRefSource( configuration.isShowAnnotationRefSource() );
587 instance.setAbbreviateScientificTaxonNames( configuration.isAbbreviateScientificTaxonNames() );
588 if ( configuration.getMinConfidenceValue() != MIN_CONFIDENCE_DEFAULT ) {
589 instance.setMinConfidenceValue( configuration.getMinConfidenceValue() );
591 if ( configuration.getGraphicsExportX() > 0 ) {
592 instance.setPrintSizeX( configuration.getGraphicsExportX() );
594 if ( configuration.getGraphicsExportY() > 0 ) {
595 instance.setPrintSizeY( configuration.getGraphicsExportY() );
597 if ( configuration.getBaseFontSize() > 0 ) {
598 instance.setBaseFont( instance.getBaseFont().deriveFont( ( float ) configuration.getBaseFontSize() ) );
600 if ( !ForesterUtil.isEmpty( configuration.getBaseFontFamilyName() ) ) {
601 instance.setBaseFont( new Font( configuration.getBaseFontFamilyName(), Font.PLAIN, instance
602 .getBaseFont().getSize() ) );
604 if ( configuration.getPhylogenyGraphicsType() != null ) {
605 instance.setPhylogenyGraphicsType( configuration.getPhylogenyGraphicsType() );
607 if ( configuration.getDefaultNodeFill() != null ) {
608 instance.setDefaultNodeFill( configuration.getDefaultNodeFill() );
610 if ( configuration.getDefaultNodeShape() != null ) {
611 instance.setDefaultNodeShape( configuration.getDefaultNodeShape() );
613 if ( configuration.getDefaultNodeShapeSize() >= 0 ) {
614 instance.setDefaultNodeShapeSize( configuration.getDefaultNodeShapeSize() );
616 instance.setShowDefaultNodeShapesInternal( configuration.isShowDefaultNodeShapesInternal() );
617 instance.setShowDefaultNodeShapesExternal( configuration.isShowDefaultNodeShapesExternal() );
618 instance.setShowDefaultNodeShapesForMarkedNodes( configuration.isShowDefaultNodeShapesForMarkedNodes() );
619 if ( configuration.getExtDescNodeDataToReturn() != null ) {
620 instance.setExtDescNodeDataToReturn( configuration.getExtDescNodeDataToReturn() );
622 instance.setRightLineUpDomains( configuration.isRightLineUpDomains() );
623 instance.setLineUpRendarableNodeData( configuration.isLineUpRendarableNodeData() );
624 instance.setAllowErrorsInDistanceToParent( false );
629 final static Options createDefaultInstance() {
630 return new Options();