JAL-2136 New Phyre2 branch + attempt to resynced with develop
[jalview.git] / src / jalview / structure / StructureSelectionManager.java
index db0b47e..5645057 100644 (file)
@@ -41,6 +41,7 @@ import jalview.io.DataSourceType;
 import jalview.io.StructureFile;
 import jalview.util.MappingUtils;
 import jalview.util.MessageManager;
+import jalview.ws.phyre2.Phyre2Client;
 import jalview.ws.sifts.SiftsClient;
 import jalview.ws.sifts.SiftsException;
 import jalview.ws.sifts.SiftsSettings;
@@ -51,6 +52,7 @@ import java.util.Arrays;
 import java.util.Collections;
 import java.util.Enumeration;
 import java.util.HashMap;
+import java.util.Hashtable;
 import java.util.IdentityHashMap;
 import java.util.List;
 import java.util.Map;
@@ -80,6 +82,7 @@ public class StructureSelectionManager
 
   private long progressSessionId;
 
+
   /*
    * Set of any registered mappings between (dataset) sequences.
    */
@@ -89,6 +92,8 @@ public class StructureSelectionManager
 
   private List<SelectionListener> sel_listeners = new ArrayList<SelectionListener>();
 
+  private Map<String, String> phyre2ModelTemplates = new Hashtable<String, String>();
+
   /**
    * @return true if will try to use external services for processing secondary
    *         structure
@@ -325,11 +330,14 @@ public class StructureSelectionManager
    * @return null or the structure data parsed as a pdb file
    */
   synchronized public StructureFile setMapping(SequenceI[] sequence,
-          String[] targetChains, String pdbFile, DataSourceType protocol)
+          String[] targetChains, String pdbFile, DataSourceType protocol,
+          IProgressIndicator progress)
   {
-    return setMapping(true, sequence, targetChains, pdbFile, protocol);
+    return computeMapping(true, sequence, targetChains, pdbFile, protocol,
+            progress);
   }
 
+
   /**
    * create sequence structure mappings between each sequence and the given
    * pdbFile (retrieved via the given protocol).
@@ -341,17 +349,27 @@ public class StructureSelectionManager
    *          - one or more sequences to be mapped to pdbFile
    * @param targetChainIds
    *          - optional chain specification for mapping each sequence to pdb
-   *          (may be nill, individual elements may be nill)
+   *          (may be null, individual elements may be null)
    * @param pdbFile
    *          - structure data resource
-   * @param sourceType
+   * @param protocol
    *          - how to resolve data from resource
    * @return null or the structure data parsed as a pdb file
    */
   synchronized public StructureFile setMapping(boolean forStructureView,
           SequenceI[] sequenceArray, String[] targetChainIds,
-          String pdbFile, DataSourceType sourceType)
+          String pdbFile, DataSourceType protocol)
   {
+    return computeMapping(forStructureView, sequenceArray, targetChainIds,
+            pdbFile, protocol, null);
+  }
+
+  synchronized public StructureFile computeMapping(
+          boolean forStructureView, SequenceI[] sequenceArray,
+          String[] targetChainIds, String pdbFile, DataSourceType protocol,
+          IProgressIndicator progress)
+  {
+    long progressSessionId = System.currentTimeMillis() * 3;
     /*
      * There will be better ways of doing this in the future, for now we'll use
      * the tried and tested MCview pdb mapping
@@ -386,11 +404,12 @@ public class StructureSelectionManager
     boolean isMapUsingSIFTs = SiftsSettings.isMapWithSifts();
     try
     {
-      sourceType = AppletFormatAdapter.checkProtocol(pdbFile);
-      pdb = new JmolParser(pdbFile, sourceType);
+      pdb = new JmolParser(pdbFile,
+              AppletFormatAdapter.checkProtocol(pdbFile));
+
 
       if (pdb.getId() != null && pdb.getId().trim().length() > 0
-              && DataSourceType.FILE == sourceType)
+              && DataSourceType.FILE == protocol)
       {
         registerPDBFile(pdb.getId().trim(), pdbFile);
       }
@@ -439,7 +458,7 @@ public class StructureSelectionManager
         {
           if (targetChainId.trim().length() == 0)
           {
-            targetChainId = " ";
+            targetChainId = StructureMapping.NO_CHAIN;
           }
           else
           {
@@ -459,7 +478,7 @@ public class StructureSelectionManager
        */
       float max = -10;
       AlignSeq maxAlignseq = null;
-      String maxChainId = " ";
+      String maxChainId = StructureMapping.NO_CHAIN; // space
       PDBChain maxChain = null;
       boolean first = true;
       for (PDBChain chain : pdb.getChains())
@@ -494,17 +513,19 @@ public class StructureSelectionManager
         continue;
       }
 
-      if (sourceType == DataSourceType.PASTE)
+      if (protocol.equals(DataSourceType.PASTE))
       {
         pdbFile = "INLINE" + pdb.getId();
       }
-
+      boolean phyre2Template = isPhyre2Template(pdbFile);
       List<StructureMapping> seqToStrucMapping = new ArrayList<StructureMapping>();
-      if (isMapUsingSIFTs && seq.isProtein())
+      if (!phyre2Template && isMapUsingSIFTs && seq.isProtein())
       {
-        setProgressBar(null);
-        setProgressBar(MessageManager
-                .getString("status.obtaining_mapping_with_sifts"));
+        if (progress!=null) {
+          progress.setProgressBar(MessageManager
+                .getString("status.obtaining_mapping_with_sifts"),
+                  progressSessionId);
+        }
         jalview.datamodel.Mapping sqmpping = maxAlignseq
                 .getMappingFromS1(false);
         if (targetChainId != null && !targetChainId.trim().isEmpty())
@@ -533,6 +554,9 @@ public class StructureSelectionManager
                                                         // "IEA:Jalview" ?
             maxChain.transferResidueAnnotation(nwMapping, sqmpping);
             ds.addPDBId(maxChain.sequence.getAllPDBEntries().get(0));
+          } catch (Exception e)
+          {
+            e.printStackTrace();
           }
         }
         else
@@ -548,6 +572,9 @@ public class StructureSelectionManager
             } catch (SiftsException e)
             {
               System.err.println(e.getMessage());
+            } catch (Exception e)
+            {
+              e.printStackTrace();
             }
           }
           if (!foundSiftsMappings.isEmpty())
@@ -572,11 +599,31 @@ public class StructureSelectionManager
           }
         }
       }
-      else
+      else if (phyre2Template)
       {
         setProgressBar(null);
         setProgressBar(MessageManager
-                .getString("status.obtaining_mapping_with_nw_alignment"));
+                .getString("status.obtaining_mapping_with_phyre2_template_alignment"));
+        String fastaFile = getPhyre2FastaFileFor(pdbFile);
+        StructureMapping phyre2ModelMapping = new Phyre2Client(pdb)
+                .getStructureMapping(seq, pdbFile, fastaFile,
+                        StructureMapping.NO_CHAIN);
+        seqToStrucMapping.add(phyre2ModelMapping);
+        maxChain.makeExactMapping(maxAlignseq, seq);
+        maxChain.transferRESNUMFeatures(seq, null);
+        jalview.datamodel.Mapping sqmpping = maxAlignseq
+                .getMappingFromS1(false);
+        maxChain.transferResidueAnnotation(phyre2ModelMapping, sqmpping);
+        ds.addPDBId(maxChain.sequence.getAllPDBEntries().get(0));
+      }
+      else
+      {
+        if (progress != null)
+        {
+          progress.setProgressBar(MessageManager
+                                  .getString("status.obtaining_mapping_with_nw_alignment"),
+                  progressSessionId);
+        }
         StructureMapping nwMapping = getNWMappings(seq, pdbFile,
                 maxChainId, maxChain, pdb, maxAlignseq);
         seqToStrucMapping.add(nwMapping);
@@ -592,9 +639,10 @@ public class StructureSelectionManager
     return pdb;
   }
 
-  public void addStructureMapping(StructureMapping sm)
+  public void registerPhyre2Template(String phyre2Template,
+          String fastaMappingFile)
   {
-    mappings.add(sm);
+    phyre2ModelTemplates.put(phyre2Template, fastaMappingFile);
   }
 
   /**
@@ -614,7 +662,7 @@ public class StructureSelectionManager
   private StructureMapping getStructureMapping(SequenceI seq,
           String pdbFile, String targetChainId, StructureFile pdb,
           PDBChain maxChain, jalview.datamodel.Mapping sqmpping,
-          AlignSeq maxAlignseq) throws SiftsException
+          AlignSeq maxAlignseq) throws Exception
   {
     StructureMapping curChainMapping = siftsClient
             .getSiftsStructureMapping(seq, pdbFile, targetChainId);
@@ -839,7 +887,7 @@ public class StructureSelectionManager
                 && sm.pdbchain.equals(atom.getChain()))
         {
           int indexpos = sm.getSeqPos(atom.getPdbResNum());
-          if (lastipos != indexpos && lastseq != sm.sequence)
+          if (lastipos != indexpos || lastseq != sm.sequence)
           {
             results.addResult(sm.sequence, indexpos, indexpos);
             lastipos = indexpos;
@@ -1373,4 +1421,31 @@ public class StructureSelectionManager
     return seqmappings;
   }
 
+  public boolean isPhyre2Template(String structureFile)
+  {
+    if (structureFile == null || phyre2ModelTemplates == null
+            || phyre2ModelTemplates.isEmpty())
+    {
+      return false;
+    }
+    return phyre2ModelTemplates.get(structureFile) != null
+            && !phyre2ModelTemplates.get(structureFile).isEmpty();
+  }
+
+  public String getPhyre2FastaFileFor(String structureFile)
+  {
+    return phyre2ModelTemplates.get(structureFile);
+  }
+
+
+  public static StructureSelectionManager getStructureSelectionManager()
+  {
+    return instances.values().iterator().next();
+  }
+
+  public void addStructureMapping(StructureMapping smapping)
+  {
+    mappings.add(smapping);
+  }
+
 }