1 // forester -- software libraries and applications
2 // for genomics and evolutionary biology research.
4 // Copyright (C) 2010 Christian M Zmasek
5 // Copyright (C) 2010 Sanford-Burnham Medical Research Institute
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.
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.
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
22 // Contact: phylosoft @ gmail . com
23 // WWW: www.phylosoft.org/forester
25 package org.forester.analysis;
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;
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;
44 public final class AncestralTaxonomyInference {
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>();
53 synchronized private static void clearCachesIfTooLarge() {
54 if ( getSnTaxCacheMap().size() > MAX_CACHE_SIZE ) {
55 getSnTaxCacheMap().clear();
57 if ( getCnTaxCacheMap().size() > MAX_CACHE_SIZE ) {
58 getCnTaxCacheMap().clear();
60 if ( getCodeTaxCacheMap().size() > MAX_CACHE_SIZE ) {
61 getCodeTaxCacheMap().clear();
63 if ( getIdTaxCacheMap().size() > MAX_CACHE_SIZE ) {
64 getIdTaxCacheMap().clear();
68 synchronized private static HashMap<String, UniProtTaxonomy> getCnTaxCacheMap() {
69 return _cn_up_cache_map;
72 synchronized private static HashMap<String, UniProtTaxonomy> getCodeTaxCacheMap() {
73 return _code_up_cache_map;
76 synchronized private static HashMap<String, UniProtTaxonomy> getIdTaxCacheMap() {
77 return _id_up_cache_map;
80 synchronized private static HashMap<String, UniProtTaxonomy> getSnTaxCacheMap() {
81 return _sn_up_cache_map;
84 synchronized private static UniProtTaxonomy getTaxonomies( final HashMap<String, UniProtTaxonomy> cache,
86 final QUERY_TYPE qt ) throws IOException {
87 if ( cache.containsKey( query ) ) {
88 return cache.get( query ).copy();
91 List<UniProtTaxonomy> up_taxonomies = null;
94 up_taxonomies = getTaxonomiesFromId( query );
97 up_taxonomies = getTaxonomiesFromTaxonomyCode( query );
100 up_taxonomies = getTaxonomiesFromScientificName( query );
103 up_taxonomies = getTaxonomiesFromCommonName( query );
106 throw new RuntimeException();
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 );
113 if ( !ForesterUtil.isEmpty( up_tax.getCode() ) ) {
114 getCodeTaxCacheMap().put( up_tax.getCode(), up_tax );
116 if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
117 getCnTaxCacheMap().put( up_tax.getCommonName(), up_tax );
119 if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
120 getIdTaxCacheMap().put( up_tax.getId(), up_tax );
130 synchronized private static List<UniProtTaxonomy> getTaxonomiesFromCommonName( final String query )
132 return UniProtWsTools.getTaxonomiesFromCommonNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
135 synchronized private static List<UniProtTaxonomy> getTaxonomiesFromId( final String query ) throws IOException {
136 return UniProtWsTools.getTaxonomiesFromId( query, MAX_TAXONOMIES_TO_RETURN );
139 synchronized private static List<UniProtTaxonomy> getTaxonomiesFromScientificName( final String query )
141 return UniProtWsTools.getTaxonomiesFromScientificNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
144 synchronized private static List<UniProtTaxonomy> getTaxonomiesFromTaxonomyCode( final String query )
146 return UniProtWsTools.getTaxonomiesFromTaxonomyCode( query, MAX_TAXONOMIES_TO_RETURN );
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 );
161 synchronized private static void inferTaxonomyFromDescendents( final PhylogenyNode n,
162 final SortedSet<String> not_found )
164 if ( n.isExternal() ) {
165 throw new IllegalArgumentException( "attempt to infer taxonomy from descendants of external node" );
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();
185 if ( ( lineage == null ) || ( lineage.length < 1 ) ) {
187 System.out.println( "node " + desc.getNodeData().getTaxonomy().toString() + " has no lineage!" );
188 not_found.add( desc.getNodeData().getTaxonomy().asText().toString() );
191 if ( lineage.length < shortest_lin_length ) {
192 shortest_lin_length = lineage.length;
194 lineages.add( lineage );
197 String msg = "Node(s) with no or inappropriate taxonomic information found";
199 if ( !ForesterUtil.isEmpty( desc.getName() ) ) {
200 node = "\"" + desc.getName() + "\"";
203 node = "[" + desc.getId() + "]";
205 msg = "Node " + node + " has no or inappropriate taxonomic information";
206 final List<PhylogenyNode> e = desc.getAllExternalDescendants();
208 System.out.println();
210 for( final PhylogenyNode object : e ) {
211 System.out.println( x + ":" );
212 System.out.println( object.getName() + " " );
215 System.out.println();
217 throw new IllegalArgumentException( msg );
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 ] ) ) {
229 last_common_lineage = lineage_0;
232 if ( last_common_lineage == null ) {
233 System.out.println( "No common lineage for:" );
235 for( final String[] strings : lineages ) {
236 System.out.print( counter + ": " );
238 for( final String string : strings ) {
239 System.out.print( string + " " );
241 System.out.println();
245 final Taxonomy tax = new Taxonomy();
246 n.getNodeData().setTaxonomy( tax );
247 tax.setScientificName( last_common_lineage );
248 final UniProtTaxonomy up_tax = obtainUniProtTaxonomyFromSn( last_common_lineage );
249 if ( up_tax != null ) {
250 if ( !ForesterUtil.isEmpty( up_tax.getRank() ) ) {
252 tax.setRank( up_tax.getRank().toLowerCase() );
254 catch ( final PhyloXmlDataFormatException ex ) {
258 if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
259 tax.setIdentifier( new Identifier( up_tax.getId(), "uniprot" ) );
261 if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
262 tax.setCommonName( up_tax.getCommonName() );
264 if ( !ForesterUtil.isEmpty( up_tax.getSynonym() ) && !tax.getSynonyms().contains( up_tax.getSynonym() ) ) {
265 tax.getSynonyms().add( up_tax.getSynonym() );
268 for( final PhylogenyNode desc : descs ) {
269 if ( !desc.isExternal() && desc.getNodeData().isHasTaxonomy()
270 && desc.getNodeData().getTaxonomy().isEqual( tax ) ) {
271 desc.getNodeData().setTaxonomy( null );
276 synchronized private static boolean isHasAppropriateId( final Taxonomy tax ) {
277 return ( ( tax.getIdentifier() != null ) && ( !ForesterUtil.isEmpty( tax.getIdentifier().getValue() ) && ( tax
278 .getIdentifier().getProvider().equalsIgnoreCase( "ncbi" )
279 || tax.getIdentifier().getProvider().equalsIgnoreCase( "uniprot" ) || tax.getIdentifier().getProvider()
280 .equalsIgnoreCase( "uniprotkb" ) ) ) );
283 synchronized public static SortedSet<String> obtainDetailedTaxonomicInformation( final Phylogeny phy,
284 final boolean delete )
286 clearCachesIfTooLarge();
287 final SortedSet<String> not_found = new TreeSet<String>();
288 List<PhylogenyNode> not_found_external_nodes = null;
290 not_found_external_nodes = new ArrayList<PhylogenyNode>();
292 for( final PhylogenyNodeIterator iter = phy.iteratorPostorder(); iter.hasNext(); ) {
293 final PhylogenyNode node = iter.next();
294 final QUERY_TYPE qt = null;
296 if ( node.getNodeData().isHasTaxonomy() ) {
297 tax = node.getNodeData().getTaxonomy();
299 else if ( node.isExternal() ) {
300 if ( !ForesterUtil.isEmpty( node.getName() ) ) {
301 not_found.add( node.getName() );
304 not_found.add( node.toString() );
307 not_found_external_nodes.add( node );
310 UniProtTaxonomy up_tax = null;
312 && ( isHasAppropriateId( tax ) || !ForesterUtil.isEmpty( tax.getScientificName() )
313 || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) || !ForesterUtil.isEmpty( tax
314 .getCommonName() ) ) ) {
315 up_tax = obtainUniProtTaxonomy( tax, null, qt );
316 if ( up_tax != null ) {
317 updateTaxonomy( qt, node, tax, up_tax );
320 not_found.add( tax.toString() );
321 if ( delete && node.isExternal() ) {
322 not_found_external_nodes.add( node );
328 for( final PhylogenyNode node : not_found_external_nodes ) {
329 phy.deleteSubtree( node, true );
331 phy.externalNodesHaveChanged();
333 phy.recalculateNumberOfExternalDescendants( true );
338 // TODO this might not be needed anymore
339 // synchronized private static String[] obtainLineagePlusOwnScientificName( final UniProtTaxonomy up_tax ) {
340 // final String[] lineage = up_tax.getLineageAsArray();
341 // final String[] lin_plus_self = new String[ lineage.length + 1 ];
342 // for( int i = 0; i < lineage.length; ++i ) {
343 // lin_plus_self[ i ] = lineage[ i ];
345 // lin_plus_self[ lineage.length ] = up_tax.getScientificName();
346 // return lin_plus_self;
348 synchronized private static UniProtTaxonomy obtainUniProtTaxonomy( final Taxonomy tax, String query, QUERY_TYPE qt )
350 if ( isHasAppropriateId( tax ) ) {
351 query = tax.getIdentifier().getValue();
353 return getTaxonomies( getIdTaxCacheMap(), query, qt );
355 else if ( !ForesterUtil.isEmpty( tax.getScientificName() ) ) {
356 query = tax.getScientificName();
358 return getTaxonomies( getSnTaxCacheMap(), query, qt );
360 else if ( !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ) {
361 query = tax.getTaxonomyCode();
362 qt = QUERY_TYPE.CODE;
363 return getTaxonomies( getCodeTaxCacheMap(), query, qt );
366 query = tax.getCommonName();
368 return getTaxonomies( getCnTaxCacheMap(), query, qt );
372 synchronized private static UniProtTaxonomy obtainUniProtTaxonomyFromSn( final String sn ) throws IOException {
373 UniProtTaxonomy up_tax = null;
374 if ( getSnTaxCacheMap().containsKey( sn ) ) {
375 up_tax = getSnTaxCacheMap().get( sn ).copy();
378 final List<UniProtTaxonomy> up_taxonomies = getTaxonomiesFromScientificName( sn );
379 if ( ( up_taxonomies != null ) && ( up_taxonomies.size() == 1 ) ) {
380 up_tax = up_taxonomies.get( 0 );
381 getSnTaxCacheMap().put( sn, up_tax );
382 if ( !ForesterUtil.isEmpty( up_tax.getCode() ) ) {
383 getCodeTaxCacheMap().put( up_tax.getCode(), up_tax );
385 if ( !ForesterUtil.isEmpty( up_tax.getCommonName() ) ) {
386 getCnTaxCacheMap().put( up_tax.getCommonName(), up_tax );
388 if ( !ForesterUtil.isEmpty( up_tax.getId() ) ) {
389 getIdTaxCacheMap().put( up_tax.getId(), up_tax );
396 synchronized private static void updateTaxonomy( final QUERY_TYPE qt,
397 final PhylogenyNode node,
399 final UniProtTaxonomy up_tax ) {
400 if ( ( qt != QUERY_TYPE.SN ) && !ForesterUtil.isEmpty( up_tax.getScientificName() )
401 && ForesterUtil.isEmpty( tax.getScientificName() ) ) {
402 tax.setScientificName( up_tax.getScientificName() );
404 if ( node.isExternal()
405 && ( ( qt != QUERY_TYPE.CODE ) && !ForesterUtil.isEmpty( up_tax.getCode() ) && ForesterUtil
406 .isEmpty( tax.getTaxonomyCode() ) ) ) {
407 tax.setTaxonomyCode( up_tax.getCode() );
409 if ( ( qt != QUERY_TYPE.CN ) && !ForesterUtil.isEmpty( up_tax.getCommonName() )
410 && ForesterUtil.isEmpty( tax.getCommonName() ) ) {
411 tax.setCommonName( up_tax.getCommonName() );
413 if ( !ForesterUtil.isEmpty( up_tax.getSynonym() ) && !tax.getSynonyms().contains( up_tax.getSynonym() ) ) {
414 tax.getSynonyms().add( up_tax.getSynonym() );
416 if ( !ForesterUtil.isEmpty( up_tax.getRank() ) && ForesterUtil.isEmpty( tax.getRank() ) ) {
418 tax.setRank( up_tax.getRank().toLowerCase() );
420 catch ( final PhyloXmlDataFormatException ex ) {
424 if ( ( qt != QUERY_TYPE.ID ) && !ForesterUtil.isEmpty( up_tax.getId() ) && ( tax.getIdentifier() == null ) ) {
425 tax.setIdentifier( new Identifier( up_tax.getId(), "uniprot" ) );
429 private enum QUERY_TYPE {