forester/java/src/org/forester/analysis/AncestralTaxonomyInference.java

   1 // forester -- software libraries and applications
   2 // for genomics and evolutionary biology research.
   3 //
   4 // Copyright (C) 2010 Christian M Zmasek
   5 // Copyright (C) 2010 Sanford-Burnham Medical Research Institute
   6 // All rights reserved
   7 //
   8 // This library is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU Lesser General Public
  10 // License as published by the Free Software Foundation; either
  11 // version 2.1 of the License, or (at your option) any later version.
  12 //
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 // Lesser General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Lesser General Public
  19 // License along with this library; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  21 //
  22 // Contact: phylosoft @ gmail . com
  23 // WWW: www.phylosoft.org/forester
  24
  25 package org.forester.analysis;
  26
  27 import java.io.IOException;
  28 import java.util.ArrayList;
  29 import java.util.HashMap;
  30 import java.util.List;
  31 import java.util.SortedSet;
  32 import java.util.TreeSet;
  33
  34 import org.forester.io.parsers.phyloxml.PhyloXmlDataFormatException;
  35 import org.forester.phylogeny.Phylogeny;
  36 import org.forester.phylogeny.PhylogenyNode;
  37 import org.forester.phylogeny.data.Identifier;
  38 import org.forester.phylogeny.data.Taxonomy;
  39 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  40 import org.forester.util.ForesterUtil;
  41 import org.forester.ws.uniprot.UniProtTaxonomy;
  42 import org.forester.ws.uniprot.UniProtWsTools;
  43
  44 public final class AncestralTaxonomyInference {
  45
  46     private static final int                              MAX_CACHE_SIZE           = 100000;
  47     private static final int                              MAX_TAXONOMIES_TO_RETURN = 100;
  48     private static final HashMap<String, UniProtTaxonomy> _sn_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
  49     private static final HashMap<String, UniProtTaxonomy> _code_up_cache_map       = new HashMap<String, UniProtTaxonomy>();
  50     private static final HashMap<String, UniProtTaxonomy> _cn_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
  51     private static final HashMap<String, UniProtTaxonomy> _id_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
  52
  53     synchronized private static void clearCachesIfTooLarge() {
  54         if ( getSnTaxCacheMap().size() > MAX_CACHE_SIZE ) {
  55             getSnTaxCacheMap().clear();
  56         }
  57         if ( getCnTaxCacheMap().size() > MAX_CACHE_SIZE ) {
  58             getCnTaxCacheMap().clear();
  59         }
  60         if ( getCodeTaxCacheMap().size() > MAX_CACHE_SIZE ) {
  61             getCodeTaxCacheMap().clear();
  62         }
  63         if ( getIdTaxCacheMap().size() > MAX_CACHE_SIZE ) {
  64             getIdTaxCacheMap().clear();
  65         }
  66     }
  67
  68     synchronized private static HashMap<String, UniProtTaxonomy> getCnTaxCacheMap() {
  69         return _cn_up_cache_map;
  70     }
  71
  72     synchronized private static HashMap<String, UniProtTaxonomy> getCodeTaxCacheMap() {
  73         return _code_up_cache_map;
  74     }
  75
  76     synchronized private static HashMap<String, UniProtTaxonomy> getIdTaxCacheMap() {
  77         return _id_up_cache_map;
  78     }
  79
  80     synchronized private static HashMap<String, UniProtTaxonomy> getSnTaxCacheMap() {
  81         return _sn_up_cache_map;
  82     }
  83
  84     synchronized private static UniProtTaxonomy getTaxonomies( final HashMap<String, UniProtTaxonomy> cache,
  85                                                                final String query,
  86                                                                final QUERY_TYPE qt ) throws IOException {
  87         if ( cache.containsKey( query ) ) {
  88             return cache.get( query ).copy();
  89         }
  90         else {
  91             List<UniProtTaxonomy> up_taxonomies = null;
  92             switch ( qt ) {
  93                 case ID:
  94                     up_taxonomies = getTaxonomiesFromId( query );
  95                     break;
  96                 case CODE:
  97                     up_taxonomies = getTaxonomiesFromTaxonomyCode( query );
  98                     break;
  99                 case SN:
 100                     up_taxonomies = getTaxonomiesFromScientificName( query );
 101                     break;
 102                 case CN:
 103                     up_taxonomies = getTaxonomiesFromCommonName( query );
 104                     break;
 105                 default:
 106                     throw new RuntimeException();
 107             }
 108             if ( ( up_taxonomies != null ) && ( up_taxonomies.size() == 1 ) ) {
 109                 final UniProtTaxonomy up_tax = up_taxonomies.get( 0 );
 110                 if ( !ForesterUtil.isEmpty( up_tax.getScientificName() ) ) {
 111                     getSnTaxCacheMap().put( up_tax.getScientificName(), up_tax );
 112                 }
 113                 if ( !ForesterUtil.isEmpty( up_tax.getCode() ) ) {
 114                     getCodeTaxCacheMap().put( up_tax.getCode(), up_tax );
 115                 }
 116                 if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
 117                     getCnTaxCacheMap().put( up_tax.getCommonName(), up_tax );
 118                 }
 119                 if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
 120                     getIdTaxCacheMap().put( up_tax.getId(), up_tax );
 121                 }
 122                 return up_tax;
 123             }
 124             else {
 125                 return null;
 126             }
 127         }
 128     }
 129
 130     synchronized private static List<UniProtTaxonomy> getTaxonomiesFromCommonName( final String query )
 131             throws IOException {
 132         return UniProtWsTools.getTaxonomiesFromCommonNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
 133     }
 134
 135     synchronized private static List<UniProtTaxonomy> getTaxonomiesFromId( final String query ) throws IOException {
 136         return UniProtWsTools.getTaxonomiesFromId( query, MAX_TAXONOMIES_TO_RETURN );
 137     }
 138
 139     synchronized private static List<UniProtTaxonomy> getTaxonomiesFromScientificName( final String query )
 140             throws IOException {
 141         return UniProtWsTools.getTaxonomiesFromScientificNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
 142     }
 143
 144     synchronized private static List<UniProtTaxonomy> getTaxonomiesFromTaxonomyCode( final String query )
 145             throws IOException {
 146         return UniProtWsTools.getTaxonomiesFromTaxonomyCode( query, MAX_TAXONOMIES_TO_RETURN );
 147     }
 148
 149     synchronized public static SortedSet<String> inferTaxonomyFromDescendents( final Phylogeny phy ) throws IOException {
 150         clearCachesIfTooLarge();
 151         final SortedSet<String> not_found = new TreeSet<String>();
 152         for( final PhylogenyNodeIterator iter = phy.iteratorPostorder(); iter.hasNext(); ) {
 153             final PhylogenyNode node = iter.next();
 154             if ( !node.isExternal() ) {
 155                 inferTaxonomyFromDescendents( node, not_found );
 156             }
 157         }
 158         return not_found;
 159     }
 160
 161     synchronized private static void inferTaxonomyFromDescendents( final PhylogenyNode n,
 162                                                                    final SortedSet<String> not_found )
 163             throws IOException {
 164         if ( n.isExternal() ) {
 165             throw new IllegalArgumentException( "attempt to infer taxonomy from descendants of external node" );
 166         }
 167         n.getNodeData().setTaxonomy( null );
 168         final List<PhylogenyNode> descs = n.getDescendants();
 169         final List<String[]> lineages = new ArrayList<String[]>();
 170         int shortest_lin_length = Integer.MAX_VALUE;
 171         for( final PhylogenyNode desc : descs ) {
 172             if ( desc.getNodeData().isHasTaxonomy()
 173                     && ( isHasAppropriateId( desc.getNodeData().getTaxonomy() )
 174                             || !ForesterUtil.isEmpty( desc.getNodeData().getTaxonomy().getScientificName() )
 175                             || !ForesterUtil.isEmpty( desc.getNodeData().getTaxonomy().getTaxonomyCode() ) || !ForesterUtil
 176                             .isEmpty( desc.getNodeData().getTaxonomy().getCommonName() ) ) ) {
 177                 final QUERY_TYPE qt = null;
 178                 final String query = null;
 179                 final UniProtTaxonomy up_tax = obtainUniProtTaxonomy( desc.getNodeData().getTaxonomy(), query, qt );
 180                 String[] lineage = null;
 181                 if ( up_tax != null ) {
 182                     //lineage = obtainLineagePlusOwnScientificName( up_tax );
 183                     lineage = up_tax.getLineageAsArray();
 184                 }
 185                 if ( ( lineage == null ) || ( lineage.length < 1 ) ) {
 186                     //TODO remove me
 187                     System.out.println( "node " + desc.getNodeData().getTaxonomy().toString() + " has no lineage!" );
 188                     not_found.add( desc.getNodeData().getTaxonomy().asText().toString() );
 189                     return;
 190                 }
 191                 if ( lineage.length < shortest_lin_length ) {
 192                     shortest_lin_length = lineage.length;
 193                 }
 194                 lineages.add( lineage );
 195             }
 196             else {
 197                 String msg = "Node(s) with no or inappropriate taxonomic information found";
 198                 String node = "";
 199                 if ( !ForesterUtil.isEmpty( desc.getName() ) ) {
 200                     node = "\"" + desc.getName() + "\"";
 201                 }
 202                 else {
 203                     node = "[" + desc.getId() + "]";
 204                 }
 205                 msg = "Node " + node + " has no or inappropriate taxonomic information";
 206                 final List<PhylogenyNode> e = desc.getAllExternalDescendants();
 207                 //TODO remove me!
 208                 System.out.println();
 209                 int x = 0;
 210                 for( final PhylogenyNode object : e ) {
 211                     System.out.println( x + ":" );
 212                     System.out.println( object.getName() + "  " );
 213                     x++;
 214                 }
 215                 System.out.println();
 216                 //
 217                 throw new IllegalArgumentException( msg );
 218             }
 219         }
 220         String last_common_lineage = null;
 221         if ( shortest_lin_length > 0 ) {
 222             I: for( int i = 0; i < shortest_lin_length; ++i ) {
 223                 final String lineage_0 = lineages.get( 0 )[ i ];
 224                 for( int j = 1; j < lineages.size(); ++j ) {
 225                     if ( !lineage_0.equals( lineages.get( j )[ i ] ) ) {
 226                         break I;
 227                     }
 228                 }
 229                 last_common_lineage = lineage_0;
 230             }
 231         }
 232         if ( last_common_lineage == null ) {
 233             System.out.println( "No common lineage for:" );
 234             int counter = 0;
 235             for( final String[] strings : lineages ) {
 236                 System.out.print( counter + ": " );
 237                 ++counter;
 238                 for( final String string : strings ) {
 239                     System.out.print( string + " " );
 240                 }
 241                 System.out.println();
 242             }
 243             return;
 244         }
 245         // if ( !n.getNodeData().isHasTaxonomy() ) {
 246         // n.getNodeData().setTaxonomy( new Taxonomy() );
 247         // }
 248         final Taxonomy tax = new Taxonomy();
 249         n.getNodeData().setTaxonomy( tax );
 250         tax.setScientificName( last_common_lineage );
 251         final UniProtTaxonomy up_tax = obtainUniProtTaxonomyFromSn( last_common_lineage );
 252         if ( up_tax != null ) {
 253             if ( !ForesterUtil.isEmpty( up_tax.getRank() ) ) {
 254                 try {
 255                     tax.setRank( up_tax.getRank().toLowerCase() );
 256                 }
 257                 catch ( final PhyloXmlDataFormatException ex ) {
 258                     tax.setRank( "" );
 259                 }
 260             }
 261             if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
 262                 tax.setIdentifier( new Identifier( up_tax.getId(), "uniprot" ) );
 263             }
 264             if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
 265                 tax.setCommonName( up_tax.getCommonName() );
 266             }
 267             if ( !ForesterUtil.isEmpty( up_tax.getSynonym() ) && !tax.getSynonyms().contains( up_tax.getSynonym() ) ) {
 268                 tax.getSynonyms().add( up_tax.getSynonym() );
 269             }
 270         }
 271         for( final PhylogenyNode desc : descs ) {
 272             if ( !desc.isExternal() && desc.getNodeData().isHasTaxonomy()
 273                     && desc.getNodeData().getTaxonomy().isEqual( tax ) ) {
 274                 desc.getNodeData().setTaxonomy( null );
 275             }
 276         }
 277     }
 278
 279     synchronized private static boolean isHasAppropriateId( final Taxonomy tax ) {
 280         return ( ( tax.getIdentifier() != null ) && ( !ForesterUtil.isEmpty( tax.getIdentifier().getValue() ) && ( tax
 281                 .getIdentifier().getProvider().equalsIgnoreCase( "ncbi" )
 282                 || tax.getIdentifier().getProvider().equalsIgnoreCase( "uniprot" ) || tax.getIdentifier().getProvider()
 283                 .equalsIgnoreCase( "uniprotkb" ) ) ) );
 284     }
 285
 286     synchronized public static SortedSet<String> obtainDetailedTaxonomicInformation( final Phylogeny phy,
 287                                                                                      final boolean delete )
 288             throws IOException {
 289         clearCachesIfTooLarge();
 290         final SortedSet<String> not_found = new TreeSet<String>();
 291         List<PhylogenyNode> not_found_external_nodes = null;
 292         if ( delete ) {
 293             not_found_external_nodes = new ArrayList<PhylogenyNode>();
 294         }
 295         for( final PhylogenyNodeIterator iter = phy.iteratorPostorder(); iter.hasNext(); ) {
 296             final PhylogenyNode node = iter.next();
 297             final QUERY_TYPE qt = null;
 298             Taxonomy tax = null;
 299             if ( node.getNodeData().isHasTaxonomy() ) {
 300                 tax = node.getNodeData().getTaxonomy();
 301             }
 302             else if ( node.isExternal() ) {
 303                 if ( !ForesterUtil.isEmpty( node.getName() ) ) {
 304                     not_found.add( node.getName() );
 305                 }
 306                 else {
 307                     not_found.add( node.toString() );
 308                 }
 309                 if ( delete ) {
 310                     not_found_external_nodes.add( node );
 311                 }
 312             }
 313             UniProtTaxonomy up_tax = null;
 314             if ( ( tax != null )
 315                     && ( isHasAppropriateId( tax ) || !ForesterUtil.isEmpty( tax.getScientificName() )
 316                             || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) || !ForesterUtil.isEmpty( tax
 317                             .getCommonName() ) ) ) {
 318                 up_tax = obtainUniProtTaxonomy( tax, null, qt );
 319                 if ( up_tax != null ) {
 320                     updateTaxonomy( qt, node, tax, up_tax );
 321                 }
 322                 else {
 323                     not_found.add( tax.toString() );
 324                     if ( delete && node.isExternal() ) {
 325                         not_found_external_nodes.add( node );
 326                     }
 327                 }
 328             }
 329         }
 330         if ( delete ) {
 331             for( final PhylogenyNode node : not_found_external_nodes ) {
 332                 phy.deleteSubtree( node, false );
 333             }
 334             phy.recalculateNumberOfExternalDescendants( true );
 335         }
 336         return not_found;
 337     }
 338
 339     // TODO this might not be needed anymore
 340     //  synchronized private static String[] obtainLineagePlusOwnScientificName( final UniProtTaxonomy up_tax ) {
 341     //      final String[] lineage = up_tax.getLineageAsArray();
 342     //      final String[] lin_plus_self = new String[ lineage.length + 1 ];
 343     //      for( int i = 0; i < lineage.length; ++i ) {
 344     //          lin_plus_self[ i ] = lineage[ i ];
 345     //      }
 346     //      lin_plus_self[ lineage.length ] = up_tax.getScientificName();
 347     //      return lin_plus_self;
 348     //  }
 349     synchronized private static UniProtTaxonomy obtainUniProtTaxonomy( final Taxonomy tax, String query, QUERY_TYPE qt )
 350             throws IOException {
 351         if ( isHasAppropriateId( tax ) ) {
 352             query = tax.getIdentifier().getValue();
 353             qt = QUERY_TYPE.ID;
 354             return getTaxonomies( getIdTaxCacheMap(), query, qt );
 355         }
 356         else if ( !ForesterUtil.isEmpty( tax.getScientificName() ) ) {
 357             query = tax.getScientificName();
 358             qt = QUERY_TYPE.SN;
 359             return getTaxonomies( getSnTaxCacheMap(), query, qt );
 360         }
 361         else if ( !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ) {
 362             query = tax.getTaxonomyCode();
 363             qt = QUERY_TYPE.CODE;
 364             return getTaxonomies( getCodeTaxCacheMap(), query, qt );
 365         }
 366         else {
 367             query = tax.getCommonName();
 368             qt = QUERY_TYPE.CN;
 369             return getTaxonomies( getCnTaxCacheMap(), query, qt );
 370         }
 371     }
 372
 373     synchronized private static UniProtTaxonomy obtainUniProtTaxonomyFromSn( final String sn ) throws IOException {
 374         UniProtTaxonomy up_tax = null;
 375         if ( getSnTaxCacheMap().containsKey( sn ) ) {
 376             up_tax = getSnTaxCacheMap().get( sn ).copy();
 377         }
 378         else {
 379             final List<UniProtTaxonomy> up_taxonomies = getTaxonomiesFromScientificName( sn );
 380             if ( ( up_taxonomies != null ) && ( up_taxonomies.size() == 1 ) ) {
 381                 up_tax = up_taxonomies.get( 0 );
 382                 getSnTaxCacheMap().put( sn, up_tax );
 383                 if ( !ForesterUtil.isEmpty( up_tax.getCode() ) ) {
 384                     getCodeTaxCacheMap().put( up_tax.getCode(), up_tax );
 385                 }
 386                 if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
 387                     getCnTaxCacheMap().put( up_tax.getCommonName(), up_tax );
 388                 }
 389                 if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
 390                     getIdTaxCacheMap().put( up_tax.getId(), up_tax );
 391                 }
 392             }
 393         }
 394         return up_tax;
 395     }
 396
 397     synchronized private static void updateTaxonomy( final QUERY_TYPE qt,
 398                                                      final PhylogenyNode node,
 399                                                      final Taxonomy tax,
 400                                                      final UniProtTaxonomy up_tax ) {
 401         if ( ( qt != QUERY_TYPE.SN ) && !ForesterUtil.isEmpty( up_tax.getScientificName() )
 402                 && ForesterUtil.isEmpty( tax.getScientificName() ) ) {
 403             tax.setScientificName( up_tax.getScientificName() );
 404         }
 405         if ( node.isExternal()
 406                 && ( ( qt != QUERY_TYPE.CODE ) && !ForesterUtil.isEmpty( up_tax.getCode() ) && ForesterUtil
 407                         .isEmpty( tax.getTaxonomyCode() ) ) ) {
 408             tax.setTaxonomyCode( up_tax.getCode() );
 409         }
 410         if ( ( qt != QUERY_TYPE.CN ) && !ForesterUtil.isEmpty( up_tax.getCommonName() )
 411                 && ForesterUtil.isEmpty( tax.getCommonName() ) ) {
 412             tax.setCommonName( up_tax.getCommonName() );
 413         }
 414         if ( !ForesterUtil.isEmpty( up_tax.getSynonym() ) && !tax.getSynonyms().contains( up_tax.getSynonym() ) ) {
 415             tax.getSynonyms().add( up_tax.getSynonym() );
 416         }
 417         if ( !ForesterUtil.isEmpty( up_tax.getRank() ) && ForesterUtil.isEmpty( tax.getRank() ) ) {
 418             try {
 419                 tax.setRank( up_tax.getRank().toLowerCase() );
 420             }
 421             catch ( final PhyloXmlDataFormatException ex ) {
 422                 tax.setRank( "" );
 423             }
 424         }
 425         if ( ( qt != QUERY_TYPE.ID ) && !ForesterUtil.isEmpty( up_tax.getId() ) && ( tax.getIdentifier() == null ) ) {
 426             tax.setIdentifier( new Identifier( up_tax.getId(), "uniprot" ) );
 427         }
 428     }
 429
 430     private enum QUERY_TYPE {
 431         CODE, SN, CN, ID;
 432     }
 433 }