forester/java/src/org/forester/analysis/TaxonomyDataManager.java

   1 // $Id:
   2 //
   3 // forester -- software libraries and applications
   4 // for genomics and evolutionary biology research.
   5 //
   6 // Copyright (C) 2010 Christian M Zmasek
   7 // Copyright (C) 2010 Sanford-Burnham Medical Research Institute
   8 // All rights reserved
   9 //
  10 // This library is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU Lesser General Public
  12 // License as published by the Free Software Foundation; either
  13 // version 2.1 of the License, or (at your option) any later version.
  14 //
  15 // This library is distributed in the hope that it will be useful,
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 // Lesser General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU Lesser General Public
  21 // License along with this library; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  23 //
  24 // Contact: phylosoft @ gmail . com
  25 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  26
  27 package org.forester.analysis;
  28
  29 import java.io.IOException;
  30 import java.net.UnknownHostException;
  31 import java.util.ArrayList;
  32 import java.util.HashMap;
  33 import java.util.List;
  34 import java.util.SortedSet;
  35 import java.util.TreeSet;
  36 import java.util.regex.Matcher;
  37
  38 import javax.swing.JOptionPane;
  39
  40 import org.forester.archaeopteryx.MainFrameApplication;
  41 import org.forester.archaeopteryx.TreePanel;
  42 import org.forester.archaeopteryx.tools.AncestralTaxonomyInferrer;
  43 import org.forester.archaeopteryx.tools.RunnableProcess;
  44 import org.forester.io.parsers.nhx.NHXParser;
  45 import org.forester.io.parsers.phyloxml.PhyloXmlDataFormatException;
  46 import org.forester.io.parsers.util.ParserUtils;
  47 import org.forester.phylogeny.Phylogeny;
  48 import org.forester.phylogeny.PhylogenyNode;
  49 import org.forester.phylogeny.data.Identifier;
  50 import org.forester.phylogeny.data.Taxonomy;
  51 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  52 import org.forester.util.ForesterUtil;
  53 import org.forester.util.TaxonomyUtil;
  54 import org.forester.ws.seqdb.SequenceDbWsTools;
  55 import org.forester.ws.seqdb.UniProtTaxonomy;
  56
  57 public final class TaxonomyDataManager extends RunnableProcess {
  58
  59     enum QUERY_TYPE {
  60         CODE, SN, CN, ID, LIN;
  61     }
  62     private static final int                              MAX_CACHE_SIZE           = 100000;
  63     private static final int                              MAX_TAXONOMIES_TO_RETURN = 2000;
  64     private static final HashMap<String, UniProtTaxonomy> _sn_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
  65     private static final HashMap<String, UniProtTaxonomy> _lineage_up_cache_map    = new HashMap<String, UniProtTaxonomy>();
  66     private static final HashMap<String, UniProtTaxonomy> _code_up_cache_map       = new HashMap<String, UniProtTaxonomy>();
  67     private static final HashMap<String, UniProtTaxonomy> _cn_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
  68     private static final HashMap<String, UniProtTaxonomy> _id_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
  69     private final Phylogeny                               _phy;
  70     private final MainFrameApplication                    _mf;
  71     private final TreePanel                               _treepanel;
  72     private final boolean                                 _delete;
  73     private final boolean                                 _allow_simple_names;
  74
  75     public TaxonomyDataManager( final MainFrameApplication mf, final TreePanel treepanel, final Phylogeny phy ) {
  76         _phy = phy;
  77         _mf = mf;
  78         _treepanel = treepanel;
  79         _delete = false;
  80         _allow_simple_names = false;
  81     }
  82
  83     public TaxonomyDataManager( final MainFrameApplication mf,
  84                                 final TreePanel treepanel,
  85                                 final Phylogeny phy,
  86                                 final boolean delete,
  87                                 final boolean allow_simple_name ) {
  88         _phy = phy;
  89         _mf = mf;
  90         _treepanel = treepanel;
  91         _delete = delete;
  92         _allow_simple_names = allow_simple_name;
  93     }
  94
  95     synchronized static void clearCachesIfTooLarge() {
  96         if ( getSnTaxCacheMap().size() > MAX_CACHE_SIZE ) {
  97             getSnTaxCacheMap().clear();
  98         }
  99         if ( getLineageTaxCacheMap().size() > MAX_CACHE_SIZE ) {
 100             getLineageTaxCacheMap().clear();
 101         }
 102         if ( getCnTaxCacheMap().size() > MAX_CACHE_SIZE ) {
 103             getCnTaxCacheMap().clear();
 104         }
 105         if ( getCodeTaxCacheMap().size() > MAX_CACHE_SIZE ) {
 106             getCodeTaxCacheMap().clear();
 107         }
 108         if ( getIdTaxCacheMap().size() > MAX_CACHE_SIZE ) {
 109             getIdTaxCacheMap().clear();
 110         }
 111     }
 112
 113     synchronized final static HashMap<String, UniProtTaxonomy> getCnTaxCacheMap() {
 114         return _cn_up_cache_map;
 115     }
 116
 117     synchronized final static HashMap<String, UniProtTaxonomy> getCodeTaxCacheMap() {
 118         return _code_up_cache_map;
 119     }
 120
 121     synchronized final static HashMap<String, UniProtTaxonomy> getIdTaxCacheMap() {
 122         return _id_up_cache_map;
 123     }
 124
 125     synchronized final static HashMap<String, UniProtTaxonomy> getLineageTaxCacheMap() {
 126         return _lineage_up_cache_map;
 127     }
 128
 129     synchronized final static HashMap<String, UniProtTaxonomy> getSnTaxCacheMap() {
 130         return _sn_up_cache_map;
 131     }
 132
 133     private final static UniProtTaxonomy obtainTaxonomy( final HashMap<String, UniProtTaxonomy> cache,
 134                                                          final Object query,
 135                                                          final QUERY_TYPE qt ) throws IOException,
 136             AncestralTaxonomyInferenceException {
 137         if ( cache.containsKey( query ) ) {
 138             return cache.get( query ).copy();
 139         }
 140         else {
 141             List<UniProtTaxonomy> up_taxonomies = null;
 142             switch ( qt ) {
 143                 case ID:
 144                     up_taxonomies = getTaxonomiesFromId( ( String ) query );
 145                     break;
 146                 case CODE:
 147                     up_taxonomies = getTaxonomiesFromTaxonomyCode( ( String ) query );
 148                     break;
 149                 case SN:
 150                     up_taxonomies = getTaxonomiesFromScientificName( ( String ) query );
 151                     break;
 152                 case CN:
 153                     up_taxonomies = getTaxonomiesFromCommonName( ( String ) query );
 154                     break;
 155                 case LIN:
 156                     return obtainUniProtTaxonomyFromLineage( ( List<String> ) query );
 157                 default:
 158                     throw new RuntimeException();
 159             }
 160             if ( ( up_taxonomies != null ) && ( up_taxonomies.size() == 1 ) ) {
 161                 final UniProtTaxonomy up_tax = up_taxonomies.get( 0 );
 162                 if ( !ForesterUtil.isEmpty( up_tax.getScientificName() ) ) {
 163                     TaxonomyDataManager.getSnTaxCacheMap().put( up_tax.getScientificName(), up_tax );
 164                 }
 165                 if ( !ForesterUtil.isEmpty( up_tax.getCode() ) ) {
 166                     TaxonomyDataManager.getCodeTaxCacheMap().put( up_tax.getCode(), up_tax );
 167                 }
 168                 if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
 169                     TaxonomyDataManager.getCnTaxCacheMap().put( up_tax.getCommonName(), up_tax );
 170                 }
 171                 if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
 172                     TaxonomyDataManager.getIdTaxCacheMap().put( up_tax.getId(), up_tax );
 173                 }
 174                 return up_tax;
 175             }
 176             else {
 177                 return null;
 178             }
 179         }
 180     }
 181
 182     private final static List<UniProtTaxonomy> getTaxonomiesFromCommonName( final String query ) throws IOException {
 183         return SequenceDbWsTools.getTaxonomiesFromCommonNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
 184     }
 185
 186     private final static List<UniProtTaxonomy> getTaxonomiesFromId( final String query ) throws IOException {
 187         return SequenceDbWsTools.getTaxonomiesFromId( query, MAX_TAXONOMIES_TO_RETURN );
 188     }
 189
 190     private final static List<UniProtTaxonomy> getTaxonomiesFromScientificName( final String query ) throws IOException {
 191         if ( query.equalsIgnoreCase( UniProtTaxonomy.BACTERIA ) || query.equalsIgnoreCase( UniProtTaxonomy.ARCHAEA )
 192                 || query.equalsIgnoreCase( UniProtTaxonomy.VIRUSES )
 193                 || query.equalsIgnoreCase( UniProtTaxonomy.EUKARYOTA ) || query.equalsIgnoreCase( UniProtTaxonomy.X ) ) {
 194             final List<UniProtTaxonomy> l = new ArrayList<UniProtTaxonomy>();
 195             l.add( UniProtTaxonomy.createSpecialFromScientificName( query ) );
 196             return l;
 197         }
 198         return SequenceDbWsTools.getTaxonomiesFromScientificNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
 199     }
 200
 201     private final static List<UniProtTaxonomy> getTaxonomiesFromTaxonomyCode( final String query ) throws IOException {
 202         if ( ( query.indexOf( "XX" ) == 3 ) && TaxonomyUtil.isHasTaxIdFromFakeTaxCode( query ) ) {
 203             final int id = TaxonomyUtil.getTaxIdFromFakeTaxCode( query );
 204             return SequenceDbWsTools.getTaxonomiesFromId( String.valueOf( id ), MAX_TAXONOMIES_TO_RETURN );
 205         }
 206         return SequenceDbWsTools.getTaxonomiesFromTaxonomyCode( query, MAX_TAXONOMIES_TO_RETURN );
 207     }
 208
 209     static final boolean isHasAppropriateId( final Taxonomy tax ) {
 210         return ( ( tax.getIdentifier() != null ) && ( !ForesterUtil.isEmpty( tax.getIdentifier().getValue() ) && ( tax
 211                 .getIdentifier().getProvider().equalsIgnoreCase( "ncbi" )
 212                 || tax.getIdentifier().getProvider().equalsIgnoreCase( "uniprot" ) || tax.getIdentifier().getProvider()
 213                 .equalsIgnoreCase( "uniprotkb" ) ) ) );
 214     }
 215
 216     synchronized final private static SortedSet<String> obtainDetailedTaxonomicInformation( final Phylogeny phy,
 217                                                                                             final boolean delete,
 218                                                                                             final boolean allow_to_use_basic_node_names )
 219             throws IOException, AncestralTaxonomyInferenceException {
 220         clearCachesIfTooLarge();
 221         final SortedSet<String> not_found = new TreeSet<String>();
 222         List<PhylogenyNode> not_found_external_nodes = null;
 223         if ( delete ) {
 224             not_found_external_nodes = new ArrayList<PhylogenyNode>();
 225         }
 226         for( final PhylogenyNodeIterator iter = phy.iteratorPostorder(); iter.hasNext(); ) {
 227             final PhylogenyNode node = iter.next();
 228             final QUERY_TYPE qt = null;
 229             Taxonomy tax = null;
 230             if ( node.getNodeData().isHasTaxonomy() ) {
 231                 tax = node.getNodeData().getTaxonomy();
 232             }
 233             else if ( allow_to_use_basic_node_names && !ForesterUtil.isEmpty( node.getName() ) ) {
 234                 // Nothing to be done.
 235             }
 236             else if ( node.isExternal() ) {
 237                 if ( !ForesterUtil.isEmpty( node.getName() ) ) {
 238                     not_found.add( node.getName() );
 239                 }
 240                 else {
 241                     not_found.add( node.toString() );
 242                 }
 243                 if ( delete ) {
 244                     not_found_external_nodes.add( node );
 245                 }
 246             }
 247             UniProtTaxonomy uniprot_tax = null;
 248             if ( ( ( tax != null ) && ( isHasAppropriateId( tax ) || !ForesterUtil.isEmpty( tax.getScientificName() )
 249                     || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) || !ForesterUtil.isEmpty( tax.getCommonName() ) ) )
 250                     || ( allow_to_use_basic_node_names && !ForesterUtil.isEmpty( node.getName() ) ) ) {
 251                 if ( ( ( tax != null ) && ( isHasAppropriateId( tax )
 252                         || !ForesterUtil.isEmpty( tax.getScientificName() )
 253                         || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) || !ForesterUtil
 254                         .isEmpty( tax.getCommonName() ) ) ) ) {
 255                     uniprot_tax = obtainUniProtTaxonomy( tax, null, qt );
 256                 }
 257                 else {
 258                     uniprot_tax = obtainUniProtTaxonomy( node.getName(), qt );
 259                 }
 260                 if ( uniprot_tax != null ) {
 261                     if ( tax == null ) {
 262                         tax = new Taxonomy();
 263                         node.getNodeData().addTaxonomy( tax );
 264                     }
 265                     updateTaxonomy( qt, node, tax, uniprot_tax );
 266                 }
 267                 else {
 268                     if ( tax != null ) {
 269                         not_found.add( tax.toString() );
 270                     }
 271                     else {
 272                         not_found.add( node.getName() );
 273                     }
 274                     if ( delete && node.isExternal() ) {
 275                         not_found_external_nodes.add( node );
 276                     }
 277                 }
 278             }
 279         }
 280         if ( delete ) {
 281             for( final PhylogenyNode node : not_found_external_nodes ) {
 282                 phy.deleteSubtree( node, true );
 283             }
 284             phy.externalNodesHaveChanged();
 285             phy.clearHashIdToNodeMap();
 286             phy.recalculateNumberOfExternalDescendants( true );
 287         }
 288         return not_found;
 289     }
 290
 291     public final static UniProtTaxonomy obtainUniProtTaxonomy( final Taxonomy tax, Object query, QUERY_TYPE qt )
 292             throws IOException, AncestralTaxonomyInferenceException {
 293         if ( tax == null ) {
 294             throw new IllegalArgumentException( "illegal attempt to use empty taxonomy object" );
 295         }
 296         if ( TaxonomyDataManager.isHasAppropriateId( tax ) ) {
 297             query = tax.getIdentifier().getValue();
 298             qt = QUERY_TYPE.ID;
 299             return obtainTaxonomy( TaxonomyDataManager.getIdTaxCacheMap(), query, qt );
 300         }
 301         else if ( !ForesterUtil.isEmpty( tax.getScientificName() ) ) {
 302             if ( !ForesterUtil.isEmpty( tax.getLineage() ) ) {
 303                 query = tax.getLineage();
 304                 qt = QUERY_TYPE.LIN;
 305                 return obtainTaxonomy( TaxonomyDataManager.getLineageTaxCacheMap(), query, qt );
 306             }
 307             else {
 308                 query = tax.getScientificName();
 309                 qt = QUERY_TYPE.SN;
 310                 return obtainTaxonomy( TaxonomyDataManager.getSnTaxCacheMap(), query, qt );
 311             }
 312         }
 313         else if ( !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ) {
 314             query = tax.getTaxonomyCode();
 315             qt = QUERY_TYPE.CODE;
 316             return obtainTaxonomy( TaxonomyDataManager.getCodeTaxCacheMap(), query, qt );
 317         }
 318         else {
 319             query = tax.getCommonName();
 320             qt = QUERY_TYPE.CN;
 321             return obtainTaxonomy( TaxonomyDataManager.getCnTaxCacheMap(), query, qt );
 322         }
 323     }
 324
 325     public final static UniProtTaxonomy obtainUniProtTaxonomy( final String simple_name, QUERY_TYPE qt )
 326             throws IOException, AncestralTaxonomyInferenceException {
 327         if ( ForesterUtil.isEmpty( simple_name ) ) {
 328             throw new IllegalArgumentException( "illegal attempt to use empty simple name" );
 329         }
 330         UniProtTaxonomy ut = null;
 331         final String code = ParserUtils.extractTaxonomyCodeFromNodeName( simple_name,
 332                                                                          NHXParser.TAXONOMY_EXTRACTION.AGGRESSIVE );
 333         if ( !ForesterUtil.isEmpty( code ) ) {
 334             qt = QUERY_TYPE.CODE;
 335             ut = obtainTaxonomy( TaxonomyDataManager.getCodeTaxCacheMap(), code, qt );
 336         }
 337         if ( ut == null ) {
 338             final String sn = ParserUtils.extractScientificNameFromNodeName( simple_name );
 339             if ( !ForesterUtil.isEmpty( sn ) ) {
 340                 qt = QUERY_TYPE.SN;
 341                 ut = obtainTaxonomy( TaxonomyDataManager.getSnTaxCacheMap(), sn, qt );
 342             }
 343         }
 344         if ( ut == null ) {
 345             final String id = ParserUtils
 346                     .extractUniprotTaxonomyIdFromNodeName( simple_name,
 347                                                            NHXParser.TAXONOMY_EXTRACTION.PFAM_STYLE_RELAXED );
 348             if ( !ForesterUtil.isEmpty( id ) ) {
 349                 qt = QUERY_TYPE.ID;
 350                 ut = obtainTaxonomy( TaxonomyDataManager.getIdTaxCacheMap(), id, qt );
 351             }
 352         }
 353         if ( ut == null ) {
 354             String sn = "";
 355             final Matcher m = ParserUtils.TAXOMONY_SN_PATTERN_GENUS.matcher( simple_name );
 356             if ( m.matches() ) {
 357                 sn = m.group( 1 );
 358             }
 359             if ( !ForesterUtil.isEmpty( sn ) ) {
 360                 qt = QUERY_TYPE.SN;
 361                 ut = obtainTaxonomy( TaxonomyDataManager.getSnTaxCacheMap(), sn, qt );
 362             }
 363         }
 364         return ut;
 365     }
 366
 367     static final UniProtTaxonomy obtainUniProtTaxonomyFromLineage( final List<String> lineage )
 368             throws AncestralTaxonomyInferenceException, IOException {
 369         final String lineage_str = ForesterUtil.stringListToString( lineage, ">" );
 370         if ( TaxonomyDataManager.getLineageTaxCacheMap().containsKey( lineage_str ) ) {
 371             return TaxonomyDataManager.getLineageTaxCacheMap().get( lineage_str ).copy();
 372         }
 373         else {
 374             final List<UniProtTaxonomy> matching_taxonomies = new ArrayList<UniProtTaxonomy>();
 375             final List<UniProtTaxonomy> up_taxonomies = getTaxonomiesFromScientificName( lineage
 376                     .get( lineage.size() - 1 ) );
 377             if ( ( up_taxonomies != null ) && ( up_taxonomies.size() > 0 ) ) {
 378                 for( final UniProtTaxonomy up_taxonomy : up_taxonomies ) {
 379                     boolean match = true;
 380                     I: for( int i = 0; i < lineage.size(); ++i ) {
 381                         if ( ( i == up_taxonomy.getLineage().size() )
 382                                 || !lineage.get( i ).equalsIgnoreCase( up_taxonomy.getLineage().get( i ) ) ) {
 383                             match = false;
 384                             break I;
 385                         }
 386                     }
 387                     if ( match ) {
 388                         matching_taxonomies.add( up_taxonomy );
 389                     }
 390                 }
 391                 if ( matching_taxonomies.isEmpty() ) {
 392                     throw new AncestralTaxonomyInferenceException( "lineage \""
 393                             + ForesterUtil.stringListToString( lineage, " > " ) + "\" not found" );
 394                 }
 395                 //in case of more than one (e.g. "Xenopus" Genus and Subgenus), keep shorter, less specific  one:
 396                 int shortest = Integer.MAX_VALUE;
 397                 UniProtTaxonomy least_specific_up_tax = null;
 398                 for( final UniProtTaxonomy m : matching_taxonomies ) {
 399                     final int s = m.getLineage().size();
 400                     if ( s < shortest ) {
 401                         shortest = s;
 402                         least_specific_up_tax = m;
 403                     }
 404                 }
 405                 TaxonomyDataManager.getLineageTaxCacheMap().put( lineage_str, least_specific_up_tax );
 406                 if ( !ForesterUtil.isEmpty( least_specific_up_tax.getScientificName() ) ) {
 407                     TaxonomyDataManager.getSnTaxCacheMap().put( least_specific_up_tax.getScientificName(),
 408                                                                 least_specific_up_tax );
 409                 }
 410                 if ( !ForesterUtil.isEmpty( least_specific_up_tax.getCode() ) ) {
 411                     TaxonomyDataManager.getCodeTaxCacheMap().put( least_specific_up_tax.getCode(),
 412                                                                   least_specific_up_tax );
 413                 }
 414                 if ( !ForesterUtil.isEmpty( least_specific_up_tax.getCommonName() ) ) {
 415                     TaxonomyDataManager.getCnTaxCacheMap().put( least_specific_up_tax.getCommonName(),
 416                                                                 least_specific_up_tax );
 417                 }
 418                 if ( !ForesterUtil.isEmpty( least_specific_up_tax.getId() ) ) {
 419                     TaxonomyDataManager.getIdTaxCacheMap().put( least_specific_up_tax.getId(), least_specific_up_tax );
 420                 }
 421                 return least_specific_up_tax;
 422             }
 423             else {
 424                 throw new AncestralTaxonomyInferenceException( "taxonomy \"" + ( lineage.get( lineage.size() - 1 ) )
 425                         + "\" not found" );
 426             }
 427         }
 428     }
 429
 430     synchronized final private static void updateTaxonomy( final QUERY_TYPE qt,
 431                                                            final PhylogenyNode node,
 432                                                            final Taxonomy tax,
 433                                                            final UniProtTaxonomy up_tax )
 434             throws PhyloXmlDataFormatException {
 435         if ( ( qt != QUERY_TYPE.SN ) && !ForesterUtil.isEmpty( up_tax.getScientificName() )
 436                 && ForesterUtil.isEmpty( tax.getScientificName() ) ) {
 437             tax.setScientificName( up_tax.getScientificName() );
 438         }
 439         if ( node.isExternal() && ( qt != QUERY_TYPE.CODE ) && !ForesterUtil.isEmpty( up_tax.getCode() )
 440                 && ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ) {
 441             tax.setTaxonomyCode( up_tax.getCode() );
 442         }
 443         if ( ( qt != QUERY_TYPE.CN ) && !ForesterUtil.isEmpty( up_tax.getCommonName() )
 444                 && ForesterUtil.isEmpty( tax.getCommonName() ) ) {
 445             tax.setCommonName( up_tax.getCommonName() );
 446         }
 447         if ( !ForesterUtil.isEmpty( up_tax.getSynonym() ) && !tax.getSynonyms().contains( up_tax.getSynonym() ) ) {
 448             tax.getSynonyms().add( up_tax.getSynonym() );
 449         }
 450         if ( !ForesterUtil.isEmpty( up_tax.getRank() ) && ForesterUtil.isEmpty( tax.getRank() ) ) {
 451             try {
 452                 tax.setRank( up_tax.getRank().toLowerCase() );
 453             }
 454             catch ( final PhyloXmlDataFormatException ex ) {
 455                 tax.setRank( "" );
 456             }
 457         }
 458         if ( ( qt != QUERY_TYPE.ID ) && !ForesterUtil.isEmpty( up_tax.getId() )
 459                 && ( ( tax.getIdentifier() == null ) || ForesterUtil.isEmpty( tax.getIdentifier().getValue() ) ) ) {
 460             tax.setIdentifier( new Identifier( up_tax.getId(), "uniprot" ) );
 461         }
 462         if ( up_tax.getLineage() != null ) {
 463             tax.setLineage( new ArrayList<String>() );
 464             for( final String lin : up_tax.getLineage() ) {
 465                 if ( !ForesterUtil.isEmpty( lin ) ) {
 466                     tax.getLineage().add( lin );
 467                 }
 468             }
 469         }
 470     }
 471
 472     private final void execute() {
 473         start( _mf, "taxonomy data" );
 474         SortedSet<String> not_found = null;
 475         try {
 476             not_found = obtainDetailedTaxonomicInformation( _phy, _delete, _allow_simple_names );
 477         }
 478         catch ( final UnknownHostException e ) {
 479             JOptionPane.showMessageDialog( _mf,
 480                                            "Could not connect to \"" + getBaseUrl() + "\"",
 481                                            "Network error during taxonomic information gathering",
 482                                            JOptionPane.ERROR_MESSAGE );
 483             return;
 484         }
 485         catch ( final IOException e ) {
 486             e.printStackTrace();
 487             JOptionPane.showMessageDialog( _mf,
 488                                            e.toString(),
 489                                            "Failed to obtain taxonomic information",
 490                                            JOptionPane.ERROR_MESSAGE );
 491             return;
 492         }
 493         catch ( final AncestralTaxonomyInferenceException e ) {
 494             e.printStackTrace();
 495             JOptionPane.showMessageDialog( _mf,
 496                                            e.toString(),
 497                                            "Failed to obtain taxonomic information",
 498                                            JOptionPane.ERROR_MESSAGE );
 499             return;
 500         }
 501         finally {
 502             end( _mf );
 503         }
 504         if ( ( _phy == null ) || _phy.isEmpty() ) {
 505             try {
 506                 JOptionPane.showMessageDialog( _mf,
 507                                                "None of the external node taxonomies could be resolved",
 508                                                "Taxonomy Tool Failed",
 509                                                JOptionPane.WARNING_MESSAGE );
 510             }
 511             catch ( final Exception e ) {
 512                 // Not important if this fails, do nothing.
 513             }
 514             return;
 515         }
 516         _treepanel.setTree( _phy );
 517         _mf.showWhole();
 518         _treepanel.setEdited( true );
 519         if ( ( not_found != null ) && ( not_found.size() > 0 ) ) {
 520             int max = not_found.size();
 521             boolean more = false;
 522             if ( max > 20 ) {
 523                 more = true;
 524                 max = 20;
 525             }
 526             final StringBuffer sb = new StringBuffer();
 527             sb.append( "Not all taxonomies could be resolved.\n" );
 528             if ( not_found.size() == 1 ) {
 529                 if ( _delete ) {
 530                     sb.append( "The following taxonomy was not found and deleted (if external):\n" );
 531                 }
 532                 else {
 533                     sb.append( "The following taxonomy was not found:\n" );
 534                 }
 535             }
 536             else {
 537                 if ( _delete ) {
 538                     sb.append( "The following taxonomies were not found and deleted (if external) (total: "
 539                             + not_found.size() + "):\n" );
 540                 }
 541                 else {
 542                     sb.append( "The following taxonomies were not found (total: " + not_found.size() + "):\n" );
 543                 }
 544             }
 545             int i = 0;
 546             for( final String string : not_found ) {
 547                 if ( i > 19 ) {
 548                     break;
 549                 }
 550                 sb.append( string );
 551                 sb.append( "\n" );
 552                 ++i;
 553             }
 554             if ( more ) {
 555                 sb.append( "..." );
 556             }
 557             try {
 558                 JOptionPane.showMessageDialog( _mf,
 559                                                sb.toString(),
 560                                                "Taxonomy Tool Completed",
 561                                                JOptionPane.WARNING_MESSAGE );
 562             }
 563             catch ( final Exception e ) {
 564                 // Not important if this fails, do nothing.
 565             }
 566         }
 567         else {
 568             try {
 569                 JOptionPane.showMessageDialog( _mf,
 570                                                "Taxonomy tool successfully completed",
 571                                                "Taxonomy Tool Completed",
 572                                                JOptionPane.INFORMATION_MESSAGE );
 573             }
 574             catch ( final Exception e ) {
 575                 // Not important if this fails, do nothing.
 576             }
 577         }
 578     }
 579
 580     private final String getBaseUrl() {
 581         return AncestralTaxonomyInferrer.getBaseUrl();
 582     }
 583
 584     @Override
 585     public void run() {
 586         execute();
 587     }
 588 }