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             // final QUERY_TYPE qt = null;
 155             // Taxonomy tax = null;
 156             // if ( node.getNodeData().isHasTaxonomy() ) {
 157             // tax = node.getNodeData().getTaxonomy();
 158             // }
 159             // UniProtTaxonomy up_tax = null;
 160             // if ( ( tax != null )
 161             // && ( isHasAppropriateId( tax ) || !ForesterUtil.isEmpty(
 162             // tax.getScientificName() )
 163             // || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ||
 164             // !ForesterUtil.isEmpty( tax
 165             // .getCommonName() ) ) ) {
 166             // final String query = null;
 167             // up_tax = obtainUniProtTaxonomy( tax, query, qt );
 168             // if ( up_tax == null ) {
 169             // not_found.add( query );
 170             // }
 171             // else {
 172             // updateTaxonomy( qt, node, tax, up_tax );
 173             // }
 174             // }
 175             if ( !node.isExternal() ) {
 176                 inferTaxonomyFromDescendents( node, not_found );
 177             }
 178         }
 179         return not_found;
 180     }
 181
 182     synchronized private static void inferTaxonomyFromDescendents( final PhylogenyNode n,
 183                                                                    final SortedSet<String> not_found )
 184             throws IOException {
 185         if ( n.isExternal() ) {
 186             throw new IllegalArgumentException( "attempt to infer taxonomy from descendants of external node" );
 187         }
 188         n.getNodeData().setTaxonomy( null );
 189         final List<PhylogenyNode> descs = n.getDescendants();
 190         final List<String[]> lineages = new ArrayList<String[]>();
 191         int shortest_lin_length = Integer.MAX_VALUE;
 192         for( final PhylogenyNode desc : descs ) {
 193             if ( desc.getNodeData().isHasTaxonomy()
 194                     && ( isHasAppropriateId( desc.getNodeData().getTaxonomy() )
 195                             || !ForesterUtil.isEmpty( desc.getNodeData().getTaxonomy().getScientificName() )
 196                             || !ForesterUtil.isEmpty( desc.getNodeData().getTaxonomy().getTaxonomyCode() ) || !ForesterUtil
 197                             .isEmpty( desc.getNodeData().getTaxonomy().getCommonName() ) ) ) {
 198                 final QUERY_TYPE qt = null;
 199                 final String query = null;
 200                 final UniProtTaxonomy up_tax = obtainUniProtTaxonomy( desc.getNodeData().getTaxonomy(), query, qt );
 201                 String[] lineage = null;
 202                 if ( up_tax != null ) {
 203                     lineage = obtainLineagePlusOwnScientificName( up_tax );
 204                 }
 205                 if ( ( lineage == null ) || ( lineage.length < 1 ) ) {
 206                     not_found.add( desc.getNodeData().getTaxonomy().asText().toString() );
 207                     return;
 208                 }
 209                 if ( lineage.length < shortest_lin_length ) {
 210                     shortest_lin_length = lineage.length;
 211                 }
 212                 lineages.add( lineage );
 213             }
 214             else {
 215                 String msg = "Node(s) with no or inappropriate taxonomic information found";
 216                 if ( !ForesterUtil.isEmpty( desc.getName() ) ) {
 217                     msg = "Node " + desc.getName() + " has no or inappropriate taxonomic information";
 218                 }
 219                 throw new IllegalArgumentException( msg );
 220             }
 221         }
 222         String last_common_lineage = null;
 223         if ( shortest_lin_length > 0 ) {
 224             I: for( int i = 0; i < shortest_lin_length; ++i ) {
 225                 final String lineage_0 = lineages.get( 0 )[ i ];
 226                 for( int j = 1; j < lineages.size(); ++j ) {
 227                     if ( !lineage_0.equals( lineages.get( j )[ i ] ) ) {
 228                         break I;
 229                     }
 230                 }
 231                 last_common_lineage = lineage_0;
 232             }
 233         }
 234         if ( last_common_lineage == null ) {
 235             return;
 236         }
 237         // if ( !n.getNodeData().isHasTaxonomy() ) {
 238         // n.getNodeData().setTaxonomy( new Taxonomy() );
 239         // }
 240         final Taxonomy tax = new Taxonomy();
 241         n.getNodeData().setTaxonomy( tax );
 242         tax.setScientificName( last_common_lineage );
 243         final UniProtTaxonomy up_tax = obtainUniProtTaxonomyFromSn( last_common_lineage );
 244         if ( up_tax != null ) {
 245             if ( !ForesterUtil.isEmpty( up_tax.getRank() ) ) {
 246                 try {
 247                     tax.setRank( up_tax.getRank().toLowerCase() );
 248                 }
 249                 catch ( final PhyloXmlDataFormatException ex ) {
 250                     tax.setRank( "" );
 251                 }
 252             }
 253             if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
 254                 tax.setIdentifier( new Identifier( up_tax.getId(), "uniprot" ) );
 255             }
 256             if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
 257                 tax.setCommonName( up_tax.getCommonName() );
 258             }
 259             if ( !ForesterUtil.isEmpty( up_tax.getSynonym() ) && !tax.getSynonyms().contains( up_tax.getSynonym() ) ) {
 260                 tax.getSynonyms().add( up_tax.getSynonym() );
 261             }
 262         }
 263         for( final PhylogenyNode desc : descs ) {
 264             if ( !desc.isExternal() && desc.getNodeData().isHasTaxonomy()
 265                     && desc.getNodeData().getTaxonomy().isEqual( tax ) ) {
 266                 desc.getNodeData().setTaxonomy( null );
 267             }
 268         }
 269     }
 270
 271     synchronized private static boolean isHasAppropriateId( final Taxonomy tax ) {
 272         return ( ( tax.getIdentifier() != null ) && ( !ForesterUtil.isEmpty( tax.getIdentifier().getValue() ) && ( tax
 273                 .getIdentifier().getProvider().equalsIgnoreCase( "ncbi" )
 274                 || tax.getIdentifier().getProvider().equalsIgnoreCase( "uniprot" ) || tax.getIdentifier().getProvider()
 275                 .equalsIgnoreCase( "uniprotkb" ) ) ) );
 276     }
 277
 278     synchronized public static SortedSet<String> obtainDetailedTaxonomicInformation( final Phylogeny phy,
 279                                                                                      final boolean delete )
 280             throws IOException {
 281         clearCachesIfTooLarge();
 282         final SortedSet<String> not_found = new TreeSet<String>();
 283         List<PhylogenyNode> not_found_external_nodes = null;
 284         if ( delete ) {
 285             not_found_external_nodes = new ArrayList<PhylogenyNode>();
 286         }
 287         for( final PhylogenyNodeIterator iter = phy.iteratorPostorder(); iter.hasNext(); ) {
 288             final PhylogenyNode node = iter.next();
 289             final QUERY_TYPE qt = null;
 290             Taxonomy tax = null;
 291             if ( node.getNodeData().isHasTaxonomy() ) {
 292                 tax = node.getNodeData().getTaxonomy();
 293             }
 294             else if ( node.isExternal() ) {
 295                 if ( !ForesterUtil.isEmpty( node.getName() ) ) {
 296                     not_found.add( node.getName() );
 297                 }
 298                 else {
 299                     not_found.add( node.toString() );
 300                 }
 301                 if ( delete ) {
 302                     not_found_external_nodes.add( node );
 303                 }
 304             }
 305             UniProtTaxonomy up_tax = null;
 306             if ( ( tax != null )
 307                     && ( isHasAppropriateId( tax ) || !ForesterUtil.isEmpty( tax.getScientificName() )
 308                             || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) || !ForesterUtil.isEmpty( tax
 309                             .getCommonName() ) ) ) {
 310                 up_tax = obtainUniProtTaxonomy( tax, null, qt );
 311                 if ( up_tax != null ) {
 312                     updateTaxonomy( qt, node, tax, up_tax );
 313                 }
 314                 else {
 315                     not_found.add( tax.toString() );
 316                     if ( delete && node.isExternal() ) {
 317                         not_found_external_nodes.add( node );
 318                     }
 319                 }
 320             }
 321         }
 322         if ( delete ) {
 323             for( PhylogenyNode node : not_found_external_nodes ) {
 324                 phy.deleteSubtree( node, false );
 325             }
 326             phy.recalculateNumberOfExternalDescendants( true );
 327         }
 328         return not_found;
 329     }
 330
 331     synchronized private static String[] obtainLineagePlusOwnScientificName( final UniProtTaxonomy up_tax ) {
 332         final String[] lineage = up_tax.getLineage();
 333         final String[] lin_plus_self = new String[ lineage.length + 1 ];
 334         for( int i = 0; i < lineage.length; ++i ) {
 335             lin_plus_self[ i ] = lineage[ i ];
 336         }
 337         lin_plus_self[ lineage.length ] = up_tax.getScientificName();
 338         return lin_plus_self;
 339     }
 340
 341     synchronized private static UniProtTaxonomy obtainUniProtTaxonomy( final Taxonomy tax, String query, QUERY_TYPE qt )
 342             throws IOException {
 343         if ( isHasAppropriateId( tax ) ) {
 344             query = tax.getIdentifier().getValue();
 345             qt = QUERY_TYPE.ID;
 346             return getTaxonomies( getIdTaxCacheMap(), query, qt );
 347         }
 348         else if ( !ForesterUtil.isEmpty( tax.getScientificName() ) ) {
 349             query = tax.getScientificName();
 350             qt = QUERY_TYPE.SN;
 351             return getTaxonomies( getSnTaxCacheMap(), query, qt );
 352         }
 353         else if ( !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ) {
 354             query = tax.getTaxonomyCode();
 355             qt = QUERY_TYPE.CODE;
 356             return getTaxonomies( getCodeTaxCacheMap(), query, qt );
 357         }
 358         else {
 359             query = tax.getCommonName();
 360             qt = QUERY_TYPE.CN;
 361             return getTaxonomies( getCnTaxCacheMap(), query, qt );
 362         }
 363     }
 364
 365     synchronized private static UniProtTaxonomy obtainUniProtTaxonomyFromSn( final String sn ) throws IOException {
 366         UniProtTaxonomy up_tax = null;
 367         if ( getSnTaxCacheMap().containsKey( sn ) ) {
 368             up_tax = getSnTaxCacheMap().get( sn ).copy();
 369         }
 370         else {
 371             final List<UniProtTaxonomy> up_taxonomies = getTaxonomiesFromScientificName( sn );
 372             if ( ( up_taxonomies != null ) && ( up_taxonomies.size() == 1 ) ) {
 373                 up_tax = up_taxonomies.get( 0 );
 374                 getSnTaxCacheMap().put( sn, up_tax );
 375                 if ( !ForesterUtil.isEmpty( up_tax.getCode() ) ) {
 376                     getCodeTaxCacheMap().put( up_tax.getCode(), up_tax );
 377                 }
 378                 if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
 379                     getCnTaxCacheMap().put( up_tax.getCommonName(), up_tax );
 380                 }
 381                 if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
 382                     getIdTaxCacheMap().put( up_tax.getId(), up_tax );
 383                 }
 384             }
 385         }
 386         return up_tax;
 387     }
 388
 389     synchronized private static void updateTaxonomy( final QUERY_TYPE qt,
 390                                                      final PhylogenyNode node,
 391                                                      final Taxonomy tax,
 392                                                      final UniProtTaxonomy up_tax ) {
 393         if ( ( qt != QUERY_TYPE.SN ) && !ForesterUtil.isEmpty( up_tax.getScientificName() )
 394                 && ForesterUtil.isEmpty( tax.getScientificName() ) ) {
 395             tax.setScientificName( up_tax.getScientificName() );
 396         }
 397         if ( node.isExternal()
 398                 && ( ( qt != QUERY_TYPE.CODE ) && !ForesterUtil.isEmpty( up_tax.getCode() ) && ForesterUtil
 399                         .isEmpty( tax.getTaxonomyCode() ) ) ) {
 400             tax.setTaxonomyCode( up_tax.getCode() );
 401         }
 402         if ( ( qt != QUERY_TYPE.CN ) && !ForesterUtil.isEmpty( up_tax.getCommonName() )
 403                 && ForesterUtil.isEmpty( tax.getCommonName() ) ) {
 404             tax.setCommonName( up_tax.getCommonName() );
 405         }
 406         if ( !ForesterUtil.isEmpty( up_tax.getSynonym() ) && !tax.getSynonyms().contains( up_tax.getSynonym() ) ) {
 407             tax.getSynonyms().add( up_tax.getSynonym() );
 408         }
 409         if ( !ForesterUtil.isEmpty( up_tax.getRank() ) && ForesterUtil.isEmpty( tax.getRank() ) ) {
 410             try {
 411                 tax.setRank( up_tax.getRank().toLowerCase() );
 412             }
 413             catch ( final PhyloXmlDataFormatException ex ) {
 414                 tax.setRank( "" );
 415             }
 416         }
 417         if ( ( qt != QUERY_TYPE.ID ) && !ForesterUtil.isEmpty( up_tax.getId() ) && ( tax.getIdentifier() == null ) ) {
 418             tax.setIdentifier( new Identifier( up_tax.getId(), "uniprot" ) );
 419         }
 420     }
 421
 422     private enum QUERY_TYPE {
 423         CODE, SN, CN, ID;
 424     }
 425 }