in progress
[jalview.git] / forester / java / src / org / forester / analysis / TaxonomyDataManager.java
index 0e48458..fac9f85 100644 (file)
@@ -38,6 +38,7 @@ import javax.swing.JOptionPane;
 
 import org.forester.archaeopteryx.MainFrameApplication;
 import org.forester.archaeopteryx.TreePanel;
+import org.forester.archaeopteryx.tools.AncestralTaxonomyInferrer;
 import org.forester.archaeopteryx.tools.RunnableProcess;
 import org.forester.io.parsers.phyloxml.PhyloXmlDataFormatException;
 import org.forester.phylogeny.Phylogeny;
@@ -46,8 +47,8 @@ import org.forester.phylogeny.data.Identifier;
 import org.forester.phylogeny.data.Taxonomy;
 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
 import org.forester.util.ForesterUtil;
-import org.forester.ws.uniprot.UniProtTaxonomy;
-import org.forester.ws.uniprot.UniProtWsTools;
+import org.forester.ws.seqdb.SequenceDbWsTools;
+import org.forester.ws.seqdb.UniProtTaxonomy;
 
 public final class TaxonomyDataManager extends RunnableProcess {
 
@@ -61,12 +62,11 @@ public final class TaxonomyDataManager extends RunnableProcess {
     private static final HashMap<String, UniProtTaxonomy> _code_up_cache_map       = new HashMap<String, UniProtTaxonomy>();
     private static final HashMap<String, UniProtTaxonomy> _cn_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
     private static final HashMap<String, UniProtTaxonomy> _id_up_cache_map         = new HashMap<String, UniProtTaxonomy>();
-
-    private final Phylogeny            _phy;
-    private final MainFrameApplication _mf;
-    private final TreePanel            _treepanel;
-    private final boolean              _delete;
-    private final boolean _allow_simple_names;
+    private final Phylogeny                               _phy;
+    private final MainFrameApplication                    _mf;
+    private final TreePanel                               _treepanel;
+    private final boolean                                 _delete;
+    private final boolean                                 _allow_simple_names;
 
     public TaxonomyDataManager( final MainFrameApplication mf, final TreePanel treepanel, final Phylogeny phy ) {
         _phy = phy;
@@ -77,10 +77,10 @@ public final class TaxonomyDataManager extends RunnableProcess {
     }
 
     public TaxonomyDataManager( final MainFrameApplication mf,
-                                 final TreePanel treepanel,
-                                 final Phylogeny phy,
-                                 final boolean delete,
-                                 final boolean allow_simple_name ) {
+                                final TreePanel treepanel,
+                                final Phylogeny phy,
+                                final boolean delete,
+                                final boolean allow_simple_name ) {
         _phy = phy;
         _mf = mf;
         _treepanel = treepanel;
@@ -88,7 +88,6 @@ public final class TaxonomyDataManager extends RunnableProcess {
         _allow_simple_names = allow_simple_name;
     }
 
-    
     synchronized static void clearCachesIfTooLarge() {
         if ( getSnTaxCacheMap().size() > MAX_CACHE_SIZE ) {
             getSnTaxCacheMap().clear();
@@ -127,9 +126,9 @@ public final class TaxonomyDataManager extends RunnableProcess {
         return _sn_up_cache_map;
     }
 
-    private final static UniProtTaxonomy getTaxonomies( final HashMap<String, UniProtTaxonomy> cache,
-                                                  final Object query,
-                                                  final QUERY_TYPE qt ) throws IOException,
+    private final static UniProtTaxonomy obtainTaxonomy( final HashMap<String, UniProtTaxonomy> cache,
+                                                         final Object query,
+                                                         final QUERY_TYPE qt ) throws IOException,
             AncestralTaxonomyInferenceException {
         if ( cache.containsKey( query ) ) {
             return cache.get( query ).copy();
@@ -177,21 +176,19 @@ public final class TaxonomyDataManager extends RunnableProcess {
     }
 
     private final static List<UniProtTaxonomy> getTaxonomiesFromCommonName( final String query ) throws IOException {
-        return UniProtWsTools.getTaxonomiesFromCommonNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
+        return SequenceDbWsTools.getTaxonomiesFromCommonNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
     }
 
     private final static List<UniProtTaxonomy> getTaxonomiesFromId( final String query ) throws IOException {
-        return UniProtWsTools.getTaxonomiesFromId( query, MAX_TAXONOMIES_TO_RETURN );
+        return SequenceDbWsTools.getTaxonomiesFromId( query, MAX_TAXONOMIES_TO_RETURN );
     }
 
-   
     private final static List<UniProtTaxonomy> getTaxonomiesFromScientificName( final String query ) throws IOException {
-        return UniProtWsTools.getTaxonomiesFromScientificNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
+        return SequenceDbWsTools.getTaxonomiesFromScientificNameStrict( query, MAX_TAXONOMIES_TO_RETURN );
     }
 
-    
     private final static List<UniProtTaxonomy> getTaxonomiesFromTaxonomyCode( final String query ) throws IOException {
-        return UniProtWsTools.getTaxonomiesFromTaxonomyCode( query, MAX_TAXONOMIES_TO_RETURN );
+        return SequenceDbWsTools.getTaxonomiesFromTaxonomyCode( query, MAX_TAXONOMIES_TO_RETURN );
     }
 
     static final boolean isHasAppropriateId( final Taxonomy tax ) {
@@ -202,8 +199,8 @@ public final class TaxonomyDataManager extends RunnableProcess {
     }
 
     synchronized final private static SortedSet<String> obtainDetailedTaxonomicInformation( final Phylogeny phy,
-                                                                                      final boolean delete,
-                                                                                      final boolean allow_to_use_basic_node_names )
+                                                                                            final boolean delete,
+                                                                                            final boolean allow_to_use_basic_node_names )
             throws IOException, AncestralTaxonomyInferenceException {
         clearCachesIfTooLarge();
         final SortedSet<String> not_found = new TreeSet<String>();
@@ -233,17 +230,30 @@ public final class TaxonomyDataManager extends RunnableProcess {
                 }
             }
             UniProtTaxonomy uniprot_tax = null;
-            if ( ( ( tax != null )
-                    && ( isHasAppropriateId( tax ) || !ForesterUtil.isEmpty( tax.getScientificName() )
-                            || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) || !ForesterUtil.isEmpty( tax
-                            .getCommonName() ) ) ) ||
-                            ( allow_to_use_basic_node_names && !ForesterUtil.isEmpty( node.getName() ) ) ) {
-                uniprot_tax = obtainUniProtTaxonomy( tax, null, qt );
+            if ( ( ( tax != null ) && ( isHasAppropriateId( tax ) || !ForesterUtil.isEmpty( tax.getScientificName() )
+                    || !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) || !ForesterUtil.isEmpty( tax.getCommonName() ) ) )
+                    || ( allow_to_use_basic_node_names && !ForesterUtil.isEmpty( node.getName() ) ) ) {
+                if ( tax != null ) {
+                    uniprot_tax = obtainUniProtTaxonomy( tax, null, qt );
+                }
+                else {
+                    uniprot_tax = obtainUniProtTaxonomy( node.getName(), qt );
+                }
                 if ( uniprot_tax != null ) {
+                    if ( tax == null ) {
+                        tax = new Taxonomy();
+                        node.getNodeData().addTaxonomy( tax );
+                        node.setName( "" );
+                    }
                     updateTaxonomy( qt, node, tax, uniprot_tax );
                 }
                 else {
-                    not_found.add( tax.toString() );
+                    if ( tax != null ) {
+                        not_found.add( tax.toString() );
+                    }
+                    else {
+                        not_found.add( node.getName() );
+                    }
                     if ( delete && node.isExternal() ) {
                         not_found_external_nodes.add( node );
                     }
@@ -255,7 +265,7 @@ public final class TaxonomyDataManager extends RunnableProcess {
                 phy.deleteSubtree( node, true );
             }
             phy.externalNodesHaveChanged();
-            phy.hashIDs();
+            phy.clearHashIdToNodeMap();
             phy.recalculateNumberOfExternalDescendants( true );
         }
         return not_found;
@@ -264,37 +274,53 @@ public final class TaxonomyDataManager extends RunnableProcess {
     public final static UniProtTaxonomy obtainUniProtTaxonomy( final Taxonomy tax, Object query, QUERY_TYPE qt )
             throws IOException, AncestralTaxonomyInferenceException {
         if ( tax == null ) {
-            throw new IllegalArgumentException( "illegal attempt to use empty taxonomy object");
+            throw new IllegalArgumentException( "illegal attempt to use empty taxonomy object" );
         }
-        
-        
         if ( TaxonomyDataManager.isHasAppropriateId( tax ) ) {
             query = tax.getIdentifier().getValue();
             qt = QUERY_TYPE.ID;
-            return getTaxonomies( TaxonomyDataManager.getIdTaxCacheMap(), query, qt );
+            return obtainTaxonomy( TaxonomyDataManager.getIdTaxCacheMap(), query, qt );
         }
         else if ( !ForesterUtil.isEmpty( tax.getScientificName() ) ) {
             if ( !ForesterUtil.isEmpty( tax.getLineage() ) ) {
                 query = tax.getLineage();
                 qt = QUERY_TYPE.LIN;
-                return getTaxonomies( TaxonomyDataManager.getLineageTaxCacheMap(), query, qt );
+                return obtainTaxonomy( TaxonomyDataManager.getLineageTaxCacheMap(), query, qt );
             }
             else {
                 query = tax.getScientificName();
                 qt = QUERY_TYPE.SN;
-                return getTaxonomies( TaxonomyDataManager.getSnTaxCacheMap(), query, qt );
+                return obtainTaxonomy( TaxonomyDataManager.getSnTaxCacheMap(), query, qt );
             }
         }
         else if ( !ForesterUtil.isEmpty( tax.getTaxonomyCode() ) ) {
             query = tax.getTaxonomyCode();
             qt = QUERY_TYPE.CODE;
-            return getTaxonomies( TaxonomyDataManager.getCodeTaxCacheMap(), query, qt );
+            return obtainTaxonomy( TaxonomyDataManager.getCodeTaxCacheMap(), query, qt );
         }
         else {
             query = tax.getCommonName();
             qt = QUERY_TYPE.CN;
-            return getTaxonomies( TaxonomyDataManager.getCnTaxCacheMap(), query, qt );
+            return obtainTaxonomy( TaxonomyDataManager.getCnTaxCacheMap(), query, qt );
+        }
+    }
+
+    public final static UniProtTaxonomy obtainUniProtTaxonomy( final String simple_name, QUERY_TYPE qt )
+            throws IOException, AncestralTaxonomyInferenceException {
+        if ( ForesterUtil.isEmpty( simple_name ) ) {
+            throw new IllegalArgumentException( "illegal attempt to use empty simple name" );
+        }
+        qt = QUERY_TYPE.SN;
+        UniProtTaxonomy ut = obtainTaxonomy( TaxonomyDataManager.getSnTaxCacheMap(), simple_name, qt );
+        if ( ut == null ) {
+            qt = QUERY_TYPE.CODE;
+            ut = obtainTaxonomy( TaxonomyDataManager.getCodeTaxCacheMap(), simple_name, qt );
+        }
+        if ( ut == null ) {
+            qt = QUERY_TYPE.CN;
+            ut = obtainTaxonomy( TaxonomyDataManager.getCnTaxCacheMap(), simple_name, qt );
         }
+        return ut;
     }
 
     static final UniProtTaxonomy obtainUniProtTaxonomyFromLineage( final List<String> lineage )
@@ -347,9 +373,10 @@ public final class TaxonomyDataManager extends RunnableProcess {
     }
 
     synchronized final private static void updateTaxonomy( final QUERY_TYPE qt,
-                                                     final PhylogenyNode node,
-                                                     final Taxonomy tax,
-                                                     final UniProtTaxonomy up_tax ) {
+                                                           final PhylogenyNode node,
+                                                           final Taxonomy tax,
+                                                           final UniProtTaxonomy up_tax )
+            throws PhyloXmlDataFormatException {
         if ( ( qt != QUERY_TYPE.SN ) && !ForesterUtil.isEmpty( up_tax.getScientificName() )
                 && ForesterUtil.isEmpty( tax.getScientificName() ) ) {
             tax.setScientificName( up_tax.getScientificName() );
@@ -386,7 +413,7 @@ public final class TaxonomyDataManager extends RunnableProcess {
             }
         }
     }
-   
+
     private final void execute() {
         start( _mf, "taxonomy data" );
         SortedSet<String> not_found = null;
@@ -496,7 +523,7 @@ public final class TaxonomyDataManager extends RunnableProcess {
     }
 
     private final String getBaseUrl() {
-        return UniProtWsTools.BASE_URL;
+        return AncestralTaxonomyInferrer.getBaseUrl();
     }
 
     @Override