114328871c10e8e99df309f1bd7be372c2888c49
[jalview.git] / 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.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;
37
38 /*
39  * This is to hold changeable options.
40  */
41 final public class Options {
42
43     public static enum CLADOGRAM_TYPE {
44         EXT_NODE_SUM_DEP, NON_LINED_UP, TOTAL_NODE_SUM_DEP;
45     }
46
47     public static enum NODE_LABEL_DIRECTION {
48         HORIZONTAL, RADIAL;
49     }
50
51     public static enum PHYLOGENY_GRAPHICS_TYPE {
52         CIRCULAR, CONVEX, CURVED, EURO_STYLE, RECTANGULAR, ROUNDED, TRIANGULAR, UNROOTED;
53     }
54
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" );
60
61         private final String _name;
62
63         private OVERVIEW_PLACEMENT_TYPE( final String name ) {
64             _name = name;
65         }
66
67         @Override
68         public String toString() {
69             return _name;
70         }
71
72         public String toTag() {
73             return toString().replaceAll( " ", "_" );
74         }
75     }
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 final boolean                     _graphics_export_using_actual_size = true;
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 final boolean                     _print_using_actual_size = true;
108     private double                            _scale_bar_length;
109     private boolean                           _search_case_sensitive;
110     private boolean                           _show_annotation_ref_source;
111     private boolean                           _show_confidence_stddev;
112     private boolean                           _show_default_node_shapes_for_marked_nodes;
113     private boolean                           _show_default_node_shapes_external;
114     private boolean                           _show_default_node_shapes_internal;
115     private boolean                           _show_domain_labels;
116     private boolean                           _show_overview;
117     private boolean                           _show_scale;
118     private TAXONOMY_EXTRACTION               _taxonomy_extraction;
119     private boolean                           _line_up_renderable_node_data;
120     private boolean                           _right_align_domains;
121     private boolean                           _color_all_found_nodes_when_coloring_subtree;
122
123     private Options() {
124         init();
125     }
126
127     public NodeDataField getExtDescNodeDataToReturn() {
128         return _ext_desc_data_to_return;
129     }
130
131     public boolean isAllowErrorsInDistanceToParent() {
132         return _allow_errors_in_distance_to_parent;
133     }
134
135     final public boolean isLineUpRendarableNodeData() {
136         return _line_up_renderable_node_data;
137     }
138
139     final public boolean isRightLineUpDomains() {
140         return _right_align_domains;
141     }
142
143     public final boolean isShowAnnotationRefSource() {
144         return _show_annotation_ref_source;
145     }
146
147     public final boolean isShowDomainLabels() {
148         return _show_domain_labels;
149     }
150
151     public final void setAllowErrorsInDistanceToParent( final boolean allow_errors_in_distance_to_parent ) {
152         _allow_errors_in_distance_to_parent = allow_errors_in_distance_to_parent;
153     }
154
155     public void setBackgroundColorGradient( final boolean background_color_gradient ) {
156         _background_color_gradient = background_color_gradient;
157     }
158
159     public void setColorLabelsSameAsParentBranch( final boolean color_labels_same_as_parent_branch ) {
160         _color_labels_same_as_parent_branch = color_labels_same_as_parent_branch;
161     }
162
163     public void setExtDescNodeDataToReturn( final NodeDataField ext_desc_data_to_return ) {
164         _ext_desc_data_to_return = ext_desc_data_to_return;
165     }
166
167     final public void setLineUpRendarableNodeData( final boolean line_up_renderable_node_data ) {
168         _line_up_renderable_node_data = line_up_renderable_node_data;
169     }
170
171     final public void setRightLineUpDomains( final boolean right_align_domains ) {
172         _right_align_domains = right_align_domains;
173     }
174
175     public final void setShowAnnotationRefSource( final boolean show_annotation_ref_source ) {
176         _show_annotation_ref_source = show_annotation_ref_source;
177     }
178
179     public void setShowDomainLabels( final boolean show_domain_labels ) {
180         _show_domain_labels = show_domain_labels;
181     }
182
183     final private void init() {
184         _default_node_shape = NodeShape.CIRCLE;
185         _default_node_fill = NodeFill.GRADIENT;
186         _default_node_shape_size = AptxConstants.DEFAULT_NODE_SHAPE_SIZE_DEFAULT;
187         _internal_number_are_confidence_for_nh_parsing = false;
188         _show_scale = false;
189         _antialias_screen = true;
190         _antialias_print = true;
191         _graphics_export_visible_only = false;
192         _editable = true;
193         _background_color_gradient = false;
194         _show_default_node_shapes_internal = false;
195         _show_default_node_shapes_external = false;
196         _show_default_node_shapes_for_marked_nodes = false;
197         _color_all_found_nodes_when_coloring_subtree = false;
198         _min_confidence_value = MIN_CONFIDENCE_DEFAULT;
199         _print_black_and_white = false;
200         _phylogeny_graphics_type = PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR;
201         _base_font = new Font( Configuration.getDefaultFontFamilyName(), Font.PLAIN, 10 );
202         _match_whole_terms_only = false;
203         _search_with_regex = false;
204         _search_case_sensitive = false;
205         _print_line_width = AptxConstants.PDF_LINE_WIDTH_DEFAULT;
206         _show_overview = true;
207         _ov_placement = OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT;
208         _node_label_direction = NODE_LABEL_DIRECTION.HORIZONTAL;
209         _inverse_search_result = false;
210         _scale_bar_length = 0.0;
211         _number_of_digits_after_comma_for_branch_length_values = AptxConstants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_BRANCH_LENGTH_VALUES_DEFAULT;
212         _number_of_digits_after_comma_for_confidence_values = AptxConstants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_CONFIDENCE_VALUES_DEFAULT;
213         _nh_parsing_replace_underscores = false;
214         _taxonomy_extraction = TAXONOMY_EXTRACTION.NO;
215         _cladogram_type = AptxConstants.CLADOGRAM_TYPE_DEFAULT;
216         _show_domain_labels = true;
217         _show_annotation_ref_source = true;
218         setAbbreviateScientificTaxonNames( false );
219         _color_labels_same_as_parent_branch = false;
220         _show_confidence_stddev = false;
221         _nh_conversion_support_value_style = NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE;
222         _ext_desc_data_to_return = NodeDataField.UNKNOWN;
223         _line_up_renderable_node_data = true;
224         _right_align_domains = false;
225     }
226
227     final private void setNumberOfDigitsAfterCommaForBranchLength( final short number_of_digits_after_comma_for_branch_length_values ) {
228         _number_of_digits_after_comma_for_branch_length_values = number_of_digits_after_comma_for_branch_length_values;
229     }
230
231     final private void setNumberOfDigitsAfterCommaForConfidenceValues( final short number_of_digits_after_comma_for_confidence_values ) {
232         _number_of_digits_after_comma_for_confidence_values = number_of_digits_after_comma_for_confidence_values;
233     }
234
235     final Font getBaseFont() {
236         return _base_font;
237     }
238
239     final CLADOGRAM_TYPE getCladogramType() {
240         return _cladogram_type;
241     }
242
243     final NodeFill getDefaultNodeFill() {
244         return _default_node_fill;
245     }
246
247     final NodeShape getDefaultNodeShape() {
248         return _default_node_shape;
249     }
250
251     final short getDefaultNodeShapeSize() {
252         return _default_node_shape_size;
253     }
254
255     final double getMinConfidenceValue() {
256         return _min_confidence_value;
257     }
258
259     NH_CONVERSION_SUPPORT_VALUE_STYLE getNhConversionSupportValueStyle() {
260         return _nh_conversion_support_value_style;
261     }
262
263     final NODE_LABEL_DIRECTION getNodeLabelDirection() {
264         return _node_label_direction;
265     }
266
267     final short getNumberOfDigitsAfterCommaForBranchLengthValues() {
268         return _number_of_digits_after_comma_for_branch_length_values;
269     }
270
271     final short getNumberOfDigitsAfterCommaForConfidenceValues() {
272         return _number_of_digits_after_comma_for_confidence_values;
273     }
274
275     final OVERVIEW_PLACEMENT_TYPE getOvPlacement() {
276         return _ov_placement;
277     }
278
279     final PHYLOGENY_GRAPHICS_TYPE getPhylogenyGraphicsType() {
280         return _phylogeny_graphics_type;
281     }
282
283     final float getPrintLineWidth() {
284         return _print_line_width;
285     }
286
287     final double getScaleBarLength() {
288         return _scale_bar_length;
289     }
290
291     final TAXONOMY_EXTRACTION getTaxonomyExtraction() {
292         return _taxonomy_extraction;
293     }
294
295     final boolean isAbbreviateScientificTaxonNames() {
296         return _abbreviate_scientific_names;
297     }
298
299     boolean isAllowMagnificationOfTaxonomyImages() {
300         return true;
301     }
302
303     final boolean isAntialiasPrint() {
304         return _antialias_print;
305     }
306
307     final boolean isAntialiasScreen() {
308         return _antialias_screen;
309     }
310
311     final boolean isBackgroundColorGradient() {
312         return _background_color_gradient;
313     }
314
315     final boolean isColorByTaxonomicGroup() {
316         return _color_by_taxonomic_group;
317     }
318
319     final boolean isColorLabelsSameAsParentBranch() {
320         return _color_labels_same_as_parent_branch;
321     }
322
323     final boolean isEditable() {
324         return _editable;
325     }
326
327     final boolean isGraphicsExportUsingActualSize() {
328         return _graphics_export_using_actual_size;
329     }
330
331     final boolean isGraphicsExportVisibleOnly() {
332         return _graphics_export_visible_only;
333     }
334
335     final boolean isInternalNumberAreConfidenceForNhParsing() {
336         return _internal_number_are_confidence_for_nh_parsing;
337     }
338
339     final boolean isInverseSearchResult() {
340         return _inverse_search_result;
341     }
342
343     final boolean isMatchWholeTermsOnly() {
344         return _match_whole_terms_only;
345     }
346
347     final boolean isPrintBlackAndWhite() {
348         return _print_black_and_white;
349     }
350
351     final boolean isPrintUsingActualSize() {
352         return _print_using_actual_size;
353     }
354
355     final boolean isReplaceUnderscoresInNhParsing() {
356         return _nh_parsing_replace_underscores;
357     }
358
359     final boolean isSearchCaseSensitive() {
360         return _search_case_sensitive;
361     }
362
363     final boolean isSearchWithRegex() {
364         return _search_with_regex;
365     }
366
367     boolean isShowConfidenceStddev() {
368         return _show_confidence_stddev;
369     }
370
371     boolean isShowDefaultNodeShapesExternal() {
372         return _show_default_node_shapes_external;
373     }
374
375     boolean isShowDefaultNodeShapesForMarkedNodes() {
376         return _show_default_node_shapes_for_marked_nodes;
377     }
378
379     boolean isShowDefaultNodeShapesInternal() {
380         return _show_default_node_shapes_internal;
381     }
382
383     final boolean isShowOverview() {
384         return _show_overview;
385     }
386
387     final boolean isShowScale() {
388         return _show_scale;
389     }
390
391     final void setAbbreviateScientificTaxonNames( final boolean abbreviate_scientific_names ) {
392         _abbreviate_scientific_names = abbreviate_scientific_names;
393     }
394
395     final void setAntialiasPrint( final boolean antialias_print ) {
396         _antialias_print = antialias_print;
397     }
398
399     final void setAntialiasScreen( final boolean antialias_screen ) {
400         _antialias_screen = antialias_screen;
401     }
402
403     final void setBaseFont( final Font base_font ) {
404         _base_font = base_font;
405     }
406
407     final void setCladogramType( final CLADOGRAM_TYPE cladogram_type ) {
408         _cladogram_type = cladogram_type;
409     }
410
411     final void setColorByTaxonomicGroup( final boolean color_by_taxonomic_group ) {
412         _color_by_taxonomic_group = color_by_taxonomic_group;
413     }
414
415     final void setDefaultNodeFill( final NodeFill default_node_fill ) {
416         _default_node_fill = default_node_fill;
417     }
418
419     final void setDefaultNodeShape( final NodeShape default_node_shape ) {
420         _default_node_shape = default_node_shape;
421     }
422
423     final void setDefaultNodeShapeSize( final short default_node_shape_size ) {
424         _default_node_shape_size = default_node_shape_size;
425     }
426
427     final void setEditable( final boolean editable ) {
428         _editable = editable;
429     }
430
431     final void setGraphicsExportVisibleOnly( final boolean graphics_export_visible_only ) {
432         _graphics_export_visible_only = graphics_export_visible_only;
433     }
434
435     final void setInternalNumberAreConfidenceForNhParsing( final boolean internal_number_are_confidence_for_nh_parsing ) {
436         _internal_number_are_confidence_for_nh_parsing = internal_number_are_confidence_for_nh_parsing;
437     }
438
439     final void setInverseSearchResult( final boolean inverse_search_result ) {
440         _inverse_search_result = inverse_search_result;
441     }
442
443     final void setMatchWholeTermsOnly( final boolean search_whole_words_only ) {
444         _match_whole_terms_only = search_whole_words_only;
445     }
446
447     final void setMinConfidenceValue( final double min_confidence_value ) {
448         _min_confidence_value = min_confidence_value;
449     }
450
451     void setNhConversionSupportValueStyle( final NH_CONVERSION_SUPPORT_VALUE_STYLE nh_conversion_support_value_style ) {
452         _nh_conversion_support_value_style = nh_conversion_support_value_style;
453     }
454
455     final void setNodeLabelDirection( final NODE_LABEL_DIRECTION node_label_direction ) {
456         _node_label_direction = node_label_direction;
457     }
458
459     final void setOvPlacement( final OVERVIEW_PLACEMENT_TYPE ov_placement ) {
460         _ov_placement = ov_placement;
461     }
462
463     final void setPhylogenyGraphicsType( final PHYLOGENY_GRAPHICS_TYPE phylogeny_graphics_type ) {
464         _phylogeny_graphics_type = phylogeny_graphics_type;
465     }
466
467     final void setPrintBlackAndWhite( final boolean print_black_and_white ) {
468         _print_black_and_white = print_black_and_white;
469     }
470
471     final void setPrintLineWidth( final float print_line_width ) {
472         _print_line_width = print_line_width;
473     }
474     
475     final void setReplaceUnderscoresInNhParsing( final boolean nh_parsing_replace_underscores ) {
476         _nh_parsing_replace_underscores = nh_parsing_replace_underscores;
477     }
478
479     final void setScaleBarLength( final double scale_bar_length ) {
480         _scale_bar_length = scale_bar_length;
481     }
482
483     final void setSearchCaseSensitive( final boolean search_case_sensitive ) {
484         _search_case_sensitive = search_case_sensitive;
485     }
486
487     final void setSearchWithRegex( final boolean search_with_regex ) {
488         _search_with_regex = search_with_regex;
489     }
490
491     void setShowConfidenceStddev( final boolean show_confidence_stddev ) {
492         _show_confidence_stddev = show_confidence_stddev;
493     }
494
495     void setShowDefaultNodeShapesExternal( final boolean show_default_node_shapes_external ) {
496         _show_default_node_shapes_external = show_default_node_shapes_external;
497     }
498
499     void setShowDefaultNodeShapesForMarkedNodes( final boolean show_default_node_shapes_for_marked_nodes ) {
500         _show_default_node_shapes_for_marked_nodes = show_default_node_shapes_for_marked_nodes;
501     }
502
503     void setShowDefaultNodeShapesInternal( final boolean show_default_node_shapes_internal ) {
504         _show_default_node_shapes_internal = show_default_node_shapes_internal;
505     }
506
507     final void setShowOverview( final boolean show_overview ) {
508         _show_overview = show_overview;
509     }
510
511     final void setShowScale( final boolean show_scale ) {
512         _show_scale = show_scale;
513     }
514
515     final void setTaxonomyExtraction( final TAXONOMY_EXTRACTION taxonomy_extraction ) {
516         _taxonomy_extraction = taxonomy_extraction;
517     }
518
519     public final static Options createInstance( final Configuration configuration ) {
520         final Options instance = createDefaultInstance();
521         if ( configuration != null ) {
522             instance.setAntialiasScreen( configuration.isAntialiasScreen() );
523             instance.setShowScale( configuration.isShowScale() );
524             instance.setShowOverview( configuration.isShowOverview() );
525             instance.setColorByTaxonomicGroup( configuration.isColorByTaxonomicGroup() );
526             instance.setCladogramType( configuration.getCladogramType() );
527             instance.setOvPlacement( configuration.getOvPlacement() );
528             instance.setPrintLineWidth( configuration.getPrintLineWidth() );
529             instance.setNodeLabelDirection( configuration.getNodeLabelDirection() );
530             instance.setBackgroundColorGradient( configuration.isBackgroundColorGradient() );
531             if ( configuration.getNumberOfDigitsAfterCommaForBranchLengthValues() >= 0 ) {
532                 instance.setNumberOfDigitsAfterCommaForBranchLength( configuration
533                         .getNumberOfDigitsAfterCommaForBranchLengthValues() );
534             }
535             if ( configuration.getNumberOfDigitsAfterCommaForConfidenceValues() >= 0 ) {
536                 instance.setNumberOfDigitsAfterCommaForConfidenceValues( configuration
537                         .getNumberOfDigitsAfterCommaForConfidenceValues() );
538             }
539             instance.setTaxonomyExtraction( configuration.getTaxonomyExtraction() );
540             instance.setReplaceUnderscoresInNhParsing( configuration.isReplaceUnderscoresInNhParsing() );
541             instance.setInternalNumberAreConfidenceForNhParsing( configuration
542                     .isInternalNumberAreConfidenceForNhParsing() );
543             instance.setEditable( configuration.isEditable() );
544             instance.setColorLabelsSameAsParentBranch( configuration.isColorLabelsSameAsParentBranch() );
545             instance.setShowDomainLabels( configuration.isShowDomainLabels() );
546             instance.setShowAnnotationRefSource( configuration.isShowAnnotationRefSource() );
547             instance.setAbbreviateScientificTaxonNames( configuration.isAbbreviateScientificTaxonNames() );
548             if ( configuration.getMinConfidenceValue() != MIN_CONFIDENCE_DEFAULT ) {
549                 instance.setMinConfidenceValue( configuration.getMinConfidenceValue() );
550             }
551             if ( configuration.getBaseFontSize() > 0 ) {
552                 instance.setBaseFont( instance.getBaseFont().deriveFont( ( float ) configuration.getBaseFontSize() ) );
553             }
554             if ( !ForesterUtil.isEmpty( configuration.getBaseFontFamilyName() ) ) {
555                 instance.setBaseFont( new Font( configuration.getBaseFontFamilyName(), Font.PLAIN, instance
556                         .getBaseFont().getSize() ) );
557             }
558             if ( configuration.getPhylogenyGraphicsType() != null ) {
559                 instance.setPhylogenyGraphicsType( configuration.getPhylogenyGraphicsType() );
560             }
561             if ( configuration.getDefaultNodeFill() != null ) {
562                 instance.setDefaultNodeFill( configuration.getDefaultNodeFill() );
563             }
564             if ( configuration.getDefaultNodeShape() != null ) {
565                 instance.setDefaultNodeShape( configuration.getDefaultNodeShape() );
566             }
567             if ( configuration.getDefaultNodeShapeSize() >= 0 ) {
568                 instance.setDefaultNodeShapeSize( configuration.getDefaultNodeShapeSize() );
569             }
570             instance.setShowDefaultNodeShapesInternal( configuration.isShowDefaultNodeShapesInternal() );
571             instance.setShowDefaultNodeShapesExternal( configuration.isShowDefaultNodeShapesExternal() );
572             instance.setShowDefaultNodeShapesForMarkedNodes( configuration.isShowDefaultNodeShapesForMarkedNodes() );
573             if ( configuration.getExtDescNodeDataToReturn() != null ) {
574                 instance.setExtDescNodeDataToReturn( configuration.getExtDescNodeDataToReturn() );
575             }
576             instance.setRightLineUpDomains( configuration.isRightLineUpDomains() );
577             instance.setLineUpRendarableNodeData( configuration.isLineUpRendarableNodeData() );
578             instance.setAllowErrorsInDistanceToParent( false );
579         }
580         return instance;
581     }
582
583     final static Options createDefaultInstance() {
584         return new Options();
585     }
586
587     final boolean isColorAllFoundNodesWhenColoringSubtree() {
588         return _color_all_found_nodes_when_coloring_subtree;
589     }
590     
591     final void setColorAllFoundNodesWhenColoringSubtree( final boolean color_all_found_nodes_when_coloring_subtree ) {
592         _color_all_found_nodes_when_coloring_subtree = color_all_found_nodes_when_coloring_subtree;
593     }
594 }