forester/java/src/org/forester/archaeopteryx/NodePanel.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 // 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: www.phylosoft.org/
  25
  26 package org.forester.archaeopteryx;
  27
  28 import java.awt.Color;
  29 import java.util.List;
  30 import java.util.SortedMap;
  31 import java.util.SortedSet;
  32
  33 import javax.swing.JEditorPane;
  34 import javax.swing.JPanel;
  35 import javax.swing.JScrollPane;
  36 import javax.swing.JSplitPane;
  37 import javax.swing.JTree;
  38 import javax.swing.event.TreeSelectionEvent;
  39 import javax.swing.event.TreeSelectionListener;
  40 import javax.swing.text.Position;
  41 import javax.swing.tree.DefaultMutableTreeNode;
  42 import javax.swing.tree.TreePath;
  43
  44 import org.forester.phylogeny.PhylogenyMethods;
  45 import org.forester.phylogeny.PhylogenyNode;
  46 import org.forester.phylogeny.data.Annotation;
  47 import org.forester.phylogeny.data.BinaryCharacters;
  48 import org.forester.phylogeny.data.BranchWidth;
  49 import org.forester.phylogeny.data.Date;
  50 import org.forester.phylogeny.data.Distribution;
  51 import org.forester.phylogeny.data.Event;
  52 import org.forester.phylogeny.data.PhylogenyData;
  53 import org.forester.phylogeny.data.Point;
  54 import org.forester.phylogeny.data.PropertiesMap;
  55 import org.forester.phylogeny.data.Property;
  56 import org.forester.phylogeny.data.Reference;
  57 import org.forester.phylogeny.data.Sequence;
  58 import org.forester.phylogeny.data.Taxonomy;
  59 import org.forester.phylogeny.data.Uri;
  60 import org.forester.util.ForesterUtil;
  61
  62 class NodePanel extends JPanel implements TreeSelectionListener {
  63
  64     static final String       DIST_ALTITUDE            = "Altitude";
  65     static final String       DIST_ALT_UNIT            = "Altitude unit";
  66     static final String       DIST_LONGITUDE           = "Longitude";
  67     static final String       DIST_LATITUDE            = "Latitude";
  68     static final String       DIST_GEODETIC_DATUM      = "Geodetic datum";
  69     static final String       DIST_DESCRIPTION         = "Description";
  70     static final String       DATE_UNIT                = "Unit";
  71     static final String       DATE_MAX                 = "Max";
  72     static final String       DATE_MIN                 = "Min";
  73     static final String       DATE_VALUE               = "Value";
  74     static final String       DATE_DESCRIPTION         = "Description";
  75     static final String       TAXONOMY_IDENTIFIER      = "Identifier";
  76     static final String       SEQ_ACCESSION            = "Accession";
  77     static final String       CONFIDENCE               = "Confidence";
  78     static final String       PROP                     = "Properties";
  79     static final String       BINARY_CHARACTERS        = "Binary characters";
  80     static final String       REFERENCE                = "Reference";
  81     static final String       LIT_REFERENCE            = "Reference";
  82     static final String       LIT_REFERENCE_DESC       = "Description";
  83     static final String       LIT_REFERENCE_DOI        = "DOI";
  84     static final String       DISTRIBUTION             = "Distribution";
  85     static final String       DATE                     = "Date";
  86     static final String       EVENTS                   = "Events";
  87     static final String       SEQUENCE                 = "Sequence";
  88     static final String       TAXONOMY                 = "Taxonomy";
  89     static final String       BASIC                    = "Basic";
  90     static final String       TAXONOMY_SCIENTIFIC_NAME = "Scientific name";
  91     static final String       SEQ_MOL_SEQ              = "Mol seq";
  92     static final String       SEQ_TYPE                 = "Type";
  93     static final String       SEQ_LOCATION             = "Location";
  94     static final String       SEQ_SYMBOL               = "Symbol";
  95     static final String       SEQ_URI                  = "URI";
  96     static final String       NODE_BRANCH_LENGTH       = "Branch length";
  97     static final String       NODE_BRANCH_WIDTH        = "Branch width";
  98     static final String       NODE_BRANCH_COLOR        = "Branch color";
  99     static final String       NODE_NAME                = "Name";
 100     static final String       TAXONOMY_URI             = "URI";
 101     static final String       TAXONOMY_RANK            = "Rank";
 102     static final String       TAXONOMY_SYNONYM         = "Synonym";
 103     static final String       TAXONOMY_COMMON_NAME     = "Common name";
 104     static final String       TAXONOMY_AUTHORITY       = "Authority";
 105     static final String       TAXONOMY_CODE            = "Code";
 106     static final String       SEQ_NAME                 = "Name";
 107     static final String       EVENTS_GENE_LOSSES       = "Gene losses";
 108     static final String       EVENTS_SPECIATIONS       = "Speciations";
 109     static final String       EVENTS_DUPLICATIONS      = "Duplications";
 110     private static final long serialVersionUID         = 5120159904388100771L;
 111     static final String       CONFIDENCE_TYPE          = "type";
 112     private final JTree       _tree;
 113     private final JEditorPane _pane;
 114
 115     public NodePanel( final PhylogenyNode phylogeny_node ) {
 116         String node_name = "";
 117         if ( !ForesterUtil.isEmpty( phylogeny_node.getName() ) ) {
 118             node_name = phylogeny_node.getName() + " ";
 119         }
 120         final DefaultMutableTreeNode top = new DefaultMutableTreeNode( "Node " + node_name );
 121         createNodes( top, phylogeny_node );
 122         _tree = new JTree( top );
 123         _tree.setEditable( false );
 124         getJTree().setToggleClickCount( 1 );
 125         expandPath( BASIC );
 126         expandPath( TAXONOMY );
 127         expandPath( SEQUENCE );
 128         expandPath( EVENTS );
 129         final JScrollPane tree_view = new JScrollPane( getJTree() );
 130         _pane = new JEditorPane();
 131         _pane.setEditable( false );
 132         final JScrollPane data_view = new JScrollPane( _pane );
 133         final JSplitPane split_pane = new JSplitPane( JSplitPane.VERTICAL_SPLIT );
 134         split_pane.setTopComponent( tree_view );
 135         split_pane.setBottomComponent( data_view );
 136         data_view.setMinimumSize( Constants.NODE_PANEL_SPLIT_MINIMUM_SIZE );
 137         tree_view.setMinimumSize( Constants.NODE_PANEL_SPLIT_MINIMUM_SIZE );
 138         split_pane.setDividerLocation( 400 );
 139         split_pane.setPreferredSize( Constants.NODE_PANEL_SIZE );
 140         add( split_pane );
 141     }
 142
 143     private void expandPath( final String name ) {
 144         final TreePath tp = getJTree().getNextMatch( name, 0, Position.Bias.Forward );
 145         if ( tp != null ) {
 146             getJTree().expandPath( tp );
 147         }
 148     }
 149
 150     private JTree getJTree() {
 151         return _tree;
 152     }
 153
 154     @Override
 155     public void valueChanged( final TreeSelectionEvent e ) {
 156         // Do nothing.
 157     }
 158
 159     private static void addAnnotation( final DefaultMutableTreeNode top, final Annotation ann, final String name ) {
 160         DefaultMutableTreeNode category;
 161         category = new DefaultMutableTreeNode( name );
 162         top.add( category );
 163         addSubelement( category, REFERENCE, ann.getRef() );
 164         addSubelement( category, "Description", ann.getDesc() );
 165         addSubelement( category, "Source", ann.getSource() );
 166         addSubelement( category, "Type", ann.getType() );
 167         addSubelement( category, "Evidence", ann.getEvidence() );
 168         if ( ann.getConfidence() != null ) {
 169             addSubelement( category, CONFIDENCE, ann.getConfidence().asText().toString() );
 170         }
 171         if ( ann.getProperties() != null ) {
 172             addProperties( category, ann.getProperties(), PROP );
 173         }
 174     }
 175
 176     private static void addUri( final DefaultMutableTreeNode top, final Uri uri, final String name ) {
 177         DefaultMutableTreeNode category;
 178         category = new DefaultMutableTreeNode( name );
 179         top.add( category );
 180         addSubelement( category, "Description", uri.getDescription() );
 181         addSubelement( category, "Type", uri.getType() );
 182         addSubelement( category, "URI", uri.getValue().toString() );
 183     }
 184
 185     private static void addAnnotations( final DefaultMutableTreeNode top,
 186                                         final SortedSet<Annotation> annotations,
 187                                         final DefaultMutableTreeNode category ) {
 188         if ( ( annotations != null ) && ( annotations.size() > 0 ) ) {
 189             category.add( new DefaultMutableTreeNode( "Annotations" ) );
 190             final DefaultMutableTreeNode last = top.getLastLeaf();
 191             int i = 0;
 192             for( final PhylogenyData ann : annotations ) {
 193                 addAnnotation( last, ( Annotation ) ann, "Annotation " + ( i++ ) );
 194             }
 195         }
 196     }
 197
 198     private static void addUris( final DefaultMutableTreeNode top,
 199                                  final List<Uri> uris,
 200                                  final DefaultMutableTreeNode category ) {
 201         if ( ( uris != null ) && ( uris.size() > 0 ) ) {
 202             category.add( new DefaultMutableTreeNode( "URIs" ) );
 203             final DefaultMutableTreeNode last = top.getLastLeaf();
 204             int i = 0;
 205             for( final Uri uri : uris ) {
 206                 if ( uri != null ) {
 207                     addUri( last, uri, "URI " + ( i++ ) );
 208                 }
 209             }
 210         }
 211     }
 212
 213     private static void addLineage( final DefaultMutableTreeNode top,
 214                                  final List<String> lineage,
 215                                  final DefaultMutableTreeNode category ) {
 216         if ( ( lineage != null ) && (  lineage.size() > 0 ) ) {
 217
 218             StringBuilder sb = new StringBuilder();
 219             for( final String lin : lineage ) {
 220                 if ( !ForesterUtil.isEmpty( lin ) ) {
 221                     sb.append( lin );
 222                     sb.append( " > " );
 223                 }
 224             }
 225             String str = null;
 226             if (sb.length() > 1 ) {
 227                 str = sb.substring( 0, sb.length() - 3 );
 228             }
 229             if ( !ForesterUtil.isEmpty( str ) ) {
 230                 addSubelement( category, "Lineage", str );
 231             }
 232         }
 233     }
 234
 235
 236
 237     private static void addBasics( final DefaultMutableTreeNode top,
 238                                    final PhylogenyNode phylogeny_node,
 239                                    final String name ) {
 240         final DefaultMutableTreeNode category = new DefaultMutableTreeNode( name );
 241         top.add( category );
 242         addSubelement( category, NODE_NAME, phylogeny_node.getName() );
 243         if ( phylogeny_node.getDistanceToParent() != PhylogenyNode.DISTANCE_DEFAULT ) {
 244             addSubelement( category,
 245                            NODE_BRANCH_LENGTH,
 246                            ForesterUtil.FORMATTER_6.format( phylogeny_node.getDistanceToParent() ) );
 247         }
 248         if ( phylogeny_node.getBranchData().isHasConfidences() ) {
 249             for( final PhylogenyData conf : phylogeny_node.getBranchData().getConfidences() ) {
 250                 addSubelement( category, CONFIDENCE, conf.asText().toString() );
 251             }
 252         }
 253         if ( !phylogeny_node.isExternal() ) {
 254             addSubelement( category, "Children", String.valueOf( phylogeny_node.getNumberOfDescendants() ) );
 255             addSubelement( category,
 256                            "External children",
 257                            String.valueOf( phylogeny_node.getAllExternalDescendants().size() ) );
 258             final SortedMap<Taxonomy, Integer> distinct_tax = PhylogenyMethods
 259                     .obtainDistinctTaxonomyCounts( phylogeny_node );
 260             if ( distinct_tax != null ) {
 261                 final int no_tax = PhylogenyMethods.calculateNumberOfExternalNodesWithoutTaxonomy( phylogeny_node );
 262                 final int tax_count = distinct_tax.size();
 263                 addSubelement( category, "Distinct external taxonomies", String.valueOf( tax_count ) );
 264                 if ( no_tax > 0 ) {
 265                     addSubelement( category, "External nodes without taxonomy", String.valueOf( no_tax ) );
 266                 }
 267                 //TODO remove me... maybe make me into a method?
 268                 //for( final Taxonomy taxonomy : distinct_tax.keySet() ) {
 269                 //    System.out.println( taxonomy + ": " + distinct_tax.get( taxonomy ) );
 270                 //}
 271             }
 272         }
 273         if ( !phylogeny_node.isRoot() ) {
 274             addSubelement( category, "Depth", String.valueOf( PhylogenyMethods.calculateDepth( phylogeny_node ) ) );
 275             final double d = PhylogenyMethods.calculateDistanceToRoot( phylogeny_node );
 276             if ( d > 0 ) {
 277                 addSubelement( category, "Distance to root", String.valueOf( ForesterUtil.FORMATTER_6.format( d ) ) );
 278             }
 279         }
 280         if ( ( phylogeny_node.getBranchData().getBranchWidth() != null )
 281                 && ( phylogeny_node.getBranchData().getBranchWidth().getValue() != BranchWidth.BRANCH_WIDTH_DEFAULT_VALUE ) ) {
 282             addSubelement( category,
 283                            NODE_BRANCH_WIDTH,
 284                            ForesterUtil.FORMATTER_3.format( phylogeny_node.getBranchData().getBranchWidth().getValue() ) );
 285         }
 286         if ( ( phylogeny_node.getBranchData().getBranchColor() != null ) ) {
 287             final Color c = phylogeny_node.getBranchData().getBranchColor().getValue();
 288             addSubelement( category, NODE_BRANCH_COLOR, c.getRed() + ", " + c.getGreen() + ", " + c.getBlue() );
 289         }
 290     }
 291
 292     private static void addBinaryCharacters( final DefaultMutableTreeNode top,
 293                                              final BinaryCharacters bc,
 294                                              final String name ) {
 295         DefaultMutableTreeNode category;
 296         category = new DefaultMutableTreeNode( name );
 297         top.add( category );
 298         addSubelement( category, "Gained", String.valueOf( bc.getGainedCount() ) );
 299         addSubelement( category, "Lost", String.valueOf( bc.getLostCount() ) );
 300         addSubelement( category, "Present", String.valueOf( bc.getPresentCount() ) );
 301         final DefaultMutableTreeNode chars = new DefaultMutableTreeNode( "Lists" );
 302         category.add( chars );
 303         addSubelement( chars, "Gained", bc.getGainedCharactersAsStringBuffer().toString() );
 304         addSubelement( chars, "Lost", bc.getLostCharactersAsStringBuffer().toString() );
 305         addSubelement( chars, "Present", bc.getPresentCharactersAsStringBuffer().toString() );
 306     }
 307
 308     private static void addDate( final DefaultMutableTreeNode top, final Date date, final String name ) {
 309         DefaultMutableTreeNode category;
 310         category = new DefaultMutableTreeNode( name );
 311         top.add( category );
 312         addSubelement( category, DATE_DESCRIPTION, date.getDesc() );
 313         addSubelement( category, DATE_VALUE, String.valueOf( date.getValue() ) );
 314         addSubelement( category, DATE_MIN, String.valueOf( date.getMin() ) );
 315         addSubelement( category, DATE_MAX, String.valueOf( date.getMax() ) );
 316         addSubelement( category, DATE_UNIT, date.getUnit() );
 317     }
 318
 319     private static void addDistribution( final DefaultMutableTreeNode top, final Distribution dist, final String name ) {
 320         DefaultMutableTreeNode category;
 321         category = new DefaultMutableTreeNode( name );
 322         top.add( category );
 323         addSubelement( category, DIST_DESCRIPTION, dist.getDesc() );
 324         if ( ( dist.getPoints() != null ) && ( dist.getPoints().size() > 0 ) ) {
 325             final Point p0 = dist.getPoints().get( 0 );
 326             if ( p0 != null ) {
 327                 addSubelement( category, DIST_GEODETIC_DATUM, p0.getGeodeticDatum() );
 328                 addSubelement( category, DIST_LATITUDE, String.valueOf( p0.getLatitude() ) );
 329                 addSubelement( category, DIST_LONGITUDE, String.valueOf( p0.getLongitude() ) );
 330                 String alt_unit = p0.getAltiudeUnit();
 331                 if ( ForesterUtil.isEmpty( alt_unit ) ) {
 332                     alt_unit = "?";
 333                 }
 334                 addSubelement( category, DIST_ALTITUDE, String.valueOf( p0.getAltitude() ) + alt_unit );
 335             }
 336         }
 337     }
 338
 339     private static void addEvents( final DefaultMutableTreeNode top, final Event events, final String name ) {
 340         DefaultMutableTreeNode category;
 341         category = new DefaultMutableTreeNode( name );
 342         top.add( category );
 343         if ( events.getNumberOfDuplications() > 0 ) {
 344             addSubelement( category, EVENTS_DUPLICATIONS, String.valueOf( events.getNumberOfDuplications() ) );
 345         }
 346         if ( events.getNumberOfSpeciations() > 0 ) {
 347             addSubelement( category, EVENTS_SPECIATIONS, String.valueOf( events.getNumberOfSpeciations() ) );
 348         }
 349         if ( events.getNumberOfGeneLosses() > 0 ) {
 350             addSubelement( category, EVENTS_GENE_LOSSES, String.valueOf( events.getNumberOfGeneLosses() ) );
 351         }
 352         addSubelement( category, "Type", events.getEventType().toString() );
 353         if ( events.getConfidence() != null ) {
 354             addSubelement( category, CONFIDENCE, events.getConfidence().asText().toString() );
 355         }
 356     }
 357
 358     private static void addProperties( final DefaultMutableTreeNode top,
 359                                        final PropertiesMap properties,
 360                                        final String string ) {
 361         final SortedMap<String, Property> properties_map = properties.getProperties();
 362         final DefaultMutableTreeNode category = new DefaultMutableTreeNode( "Properties " );
 363         top.add( category );
 364         for( final String key : properties_map.keySet() ) {
 365             final Property prop = properties_map.get( key );
 366             category.add( new DefaultMutableTreeNode( prop.getRef() + " " + prop.getValue() + " " + prop.getUnit()
 367                     + " [" + prop.getAppliesTo().toString() + "]" ) );
 368         }
 369     }
 370
 371     private static void addReference( final DefaultMutableTreeNode top, final Reference ref, final String name ) {
 372         final DefaultMutableTreeNode category = new DefaultMutableTreeNode( name );
 373         top.add( category );
 374         addSubelement( category, LIT_REFERENCE_DOI, ref.getDoi() );
 375         addSubelement( category, LIT_REFERENCE_DESC, ref.getDescription() );
 376     }
 377
 378     private static void addSequence( final DefaultMutableTreeNode top, final Sequence seq, final String name ) {
 379         final DefaultMutableTreeNode category = new DefaultMutableTreeNode( name );
 380         top.add( category );
 381         addSubelement( category, SEQ_NAME, seq.getName() );
 382         addSubelement( category, SEQ_SYMBOL, seq.getSymbol() );
 383         if ( seq.getAccession() != null ) {
 384             addSubelement( category, SEQ_ACCESSION, seq.getAccession().asText().toString() );
 385         }
 386         addSubelement( category, SEQ_LOCATION, seq.getLocation() );
 387         addSubelement( category, SEQ_TYPE, seq.getType() );
 388         addSubelement( category, SEQ_MOL_SEQ, seq.getMolecularSequence() );
 389         if ( ( seq.getUris() != null ) && !seq.getUris().isEmpty() ) {
 390             addUris( top, seq.getUris(), category );
 391         }
 392         addAnnotations( top, seq.getAnnotations(), category );
 393     }
 394
 395     private static void addSubelement( final DefaultMutableTreeNode node, final String name, final String value ) {
 396         if ( !ForesterUtil.isEmpty( value ) ) {
 397             node.add( new DefaultMutableTreeNode( name + ": " + value ) );
 398         }
 399     }
 400
 401     private static void addTaxonomy( final DefaultMutableTreeNode top, final Taxonomy tax, final String name ) {
 402         final DefaultMutableTreeNode category = new DefaultMutableTreeNode( name );
 403         top.add( category );
 404         if ( tax.getIdentifier() != null ) {
 405             addSubelement( category, TAXONOMY_IDENTIFIER, tax.getIdentifier().asText().toString() );
 406         }
 407         addSubelement( category, TAXONOMY_CODE, tax.getTaxonomyCode() );
 408         addSubelement( category, TAXONOMY_SCIENTIFIC_NAME, tax.getScientificName() );
 409         addSubelement( category, TAXONOMY_AUTHORITY, tax.getAuthority() );
 410         addSubelement( category, TAXONOMY_COMMON_NAME, tax.getCommonName() );
 411         for( final String syn : tax.getSynonyms() ) {
 412             addSubelement( category, TAXONOMY_SYNONYM, syn );
 413         }
 414         addSubelement( category, TAXONOMY_RANK, tax.getRank() );
 415         if ( ( tax.getUris() != null ) && !tax.getUris().isEmpty() ) {
 416             addUris( top, tax.getUris(), category );
 417         }
 418         if ( ( tax.getLineage() != null ) && !tax.getLineage().isEmpty() ) {
 419             addLineage( top, tax.getLineage(), category );
 420         }
 421     }
 422
 423     private static void createNodes( final DefaultMutableTreeNode top, final PhylogenyNode phylogeny_node ) {
 424         addBasics( top, phylogeny_node, BASIC );
 425         // Taxonomy
 426         if ( phylogeny_node.getNodeData().isHasTaxonomy() ) {
 427             addTaxonomy( top, phylogeny_node.getNodeData().getTaxonomy(), TAXONOMY );
 428         }
 429         // Sequence
 430         if ( phylogeny_node.getNodeData().isHasSequence() ) {
 431             addSequence( top, phylogeny_node.getNodeData().getSequence(), SEQUENCE );
 432         }
 433         // Events
 434         if ( phylogeny_node.getNodeData().isHasEvent() ) {
 435             addEvents( top, phylogeny_node.getNodeData().getEvent(), EVENTS );
 436         }
 437         // Date
 438         if ( phylogeny_node.getNodeData().isHasDate() ) {
 439             addDate( top, phylogeny_node.getNodeData().getDate(), DATE );
 440         }
 441         // Distribution
 442         if ( phylogeny_node.getNodeData().isHasDistribution() ) {
 443             addDistribution( top, phylogeny_node.getNodeData().getDistribution(), DISTRIBUTION );
 444         }
 445         // Reference
 446         if ( phylogeny_node.getNodeData().isHasReference() ) {
 447             addReference( top, phylogeny_node.getNodeData().getReference(), LIT_REFERENCE );
 448         }
 449         // BinaryCharacters
 450         if ( phylogeny_node.getNodeData().isHasBinaryCharacters() ) {
 451             addBinaryCharacters( top, phylogeny_node.getNodeData().getBinaryCharacters(), BINARY_CHARACTERS );
 452         }
 453         // Properties
 454         if ( phylogeny_node.getNodeData().isHasProperties() ) {
 455             addProperties( top, phylogeny_node.getNodeData().getProperties(), PROP );
 456         }
 457     }
 458 }