JAL-629 JAL-4124 JAL-3855 test to check we can import PAE matrices in a variety of...
[jalview.git] / src / jalview / ws / dbsources / EBIAlfaFold.java
index 5575cb8..72fd8d9 100644 (file)
@@ -30,12 +30,15 @@ import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 
+import org.json.simple.JSONArray;
+import org.json.simple.JSONObject;
 import org.json.simple.parser.ParseException;
 
 import com.stevesoft.pat.Regex;
 
 import jalview.api.FeatureSettingsModelI;
 import jalview.bin.Console;
+import jalview.datamodel.AlignedCodonFrame;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.ContactMatrixI;
@@ -43,11 +46,14 @@ import jalview.datamodel.DBRefEntry;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
+import jalview.gui.Desktop;
 import jalview.io.DataSourceType;
 import jalview.io.FileFormat;
 import jalview.io.FileFormatI;
 import jalview.io.FormatAdapter;
 import jalview.io.PDBFeatureSettings;
+import jalview.structure.StructureMapping;
+import jalview.structure.StructureSelectionManager;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.ws.datamodel.alphafold.PAEContactMatrix;
@@ -249,39 +255,91 @@ public class EBIAlfaFold extends EbiFileRetrievedProxy
     Console.debug("Downloading pae from " + paeURL + " to " + pae.toString()
             + "");
     UrlDownloadClient.download(paeURL, pae);
-    addAlphaFoldPAE(pdbAlignment, pae, 0, null);
+    addAlphaFoldPAEToSequence(pdbAlignment, pae, 0, null);
+  }
+
+  public static void addAlphaFoldPAEToSequence(AlignmentI pdbAlignment,
+          File pae, int index, String seqId)
+  {
+    addAlphaFoldPAE(pdbAlignment, pae, index, seqId, false, false);
+  }
+
+  public static void addAlphaFoldPAEToStructure(AlignmentI pdbAlignment,
+          File pae, int index, String structIdOrFile, boolean isStructId)
+  {
+    addAlphaFoldPAE(pdbAlignment, pae, index, structIdOrFile, true,
+            isStructId);
   }
 
   public static void addAlphaFoldPAE(AlignmentI pdbAlignment, File pae,
-          int index, String seqId)
+          int index, String id, boolean isStruct, boolean isStructId)
   {
-    FileInputStream pae_input = null;
+    FileInputStream paeInput = null;
     try
     {
-      pae_input = new FileInputStream(pae);
+      paeInput = new FileInputStream(pae);
     } catch (FileNotFoundException e)
     {
       Console.error(
               "Could not find pAE file '" + pae.getAbsolutePath() + "'", e);
+      return;
     }
 
-    try
+    if (isStruct)
     {
-      if (!importPaeJSONAsContactMatrix(pdbAlignment, pae_input, index,
-              seqId))
+      StructureSelectionManager ssm = StructureSelectionManager
+              .getStructureSelectionManager(Desktop.instance);
+      if (ssm != null)
       {
-        Console.warn("Could not import contact matrix from '"
-                + pae.getAbsolutePath() + "'");
+        String structFile = isStructId ? ssm.findFileForPDBId(id) : id;
+        Console.debug("##### AHA! structFile = " + structFile);
+        Console.debug("##### structFile "
+                + (ssm.isPDBFileRegistered(structFile) ? "IS " : "is NOT ")
+                + "registered.");
+
+        StructureMapping[] smArray = ssm.getMapping(structFile);
+        Console.debug("##### AHA! smArray obtained with " + smArray.length
+                + " elements");
+
+        try
+        {
+          if (!importPaeJSONAsContactMatrixToStructure(smArray, paeInput))
+          {
+            Console.warn("Could not import contact matrix from '"
+                    + pae.getAbsolutePath() + "' to structure.");
+          }
+        } catch (IOException e1)
+        {
+          Console.error("Error when importing pAE file '"
+                  + pae.getAbsolutePath() + "'", e1);
+        } catch (ParseException e2)
+        {
+          Console.error("Error when parsing pAE file '"
+                  + pae.getAbsolutePath() + "'", e2);
+        }
       }
-    } catch (IOException e1)
-    {
-      Console.error("Error when importing pAE file '"
-              + pae.getAbsolutePath() + "'", e1);
-    } catch (ParseException e2)
+
+    }
+    else
     {
-      Console.error(
-              "Error when parsing pAE file '" + pae.getAbsolutePath() + "'",
-              e2);
+      // attach to sequence?!
+      try
+      {
+        if (!importPaeJSONAsContactMatrixToSequence(pdbAlignment, paeInput,
+                index, id))
+        {
+          Console.warn("Could not import contact matrix from '"
+                  + pae.getAbsolutePath() + "' to sequence.");
+        }
+      } catch (IOException e1)
+      {
+        Console.error("Error when importing pAE file '"
+                + pae.getAbsolutePath() + "'", e1);
+      } catch (ParseException e2)
+      {
+        Console.error("Error when parsing pAE file '"
+                + pae.getAbsolutePath() + "'", e2);
+      }
     }
 
   }
@@ -297,24 +355,18 @@ public class EBIAlfaFold extends EbiFileRetrievedProxy
    * @throws IOException
    * @throws Exception
    */
-  public static boolean importPaeJSONAsContactMatrix(
+  public static boolean importPaeJSONAsContactMatrixToSequence(
           AlignmentI pdbAlignment, InputStream pae_input)
           throws IOException, ParseException
   {
-    return importPaeJSONAsContactMatrix(pdbAlignment, pae_input, 0, null);
+    return importPaeJSONAsContactMatrixToSequence(pdbAlignment, pae_input,
+            0, null);
   }
 
-  public static boolean importPaeJSONAsContactMatrix(
+  public static boolean importPaeJSONAsContactMatrixToSequence(
           AlignmentI pdbAlignment, InputStream pae_input, int index,
           String seqId) throws IOException, ParseException
   {
-
-    List<Object> pae_obj = (List<Object>) Platform.parseJSON(pae_input);
-    if (pae_obj == null)
-    {
-      Console.debug("JSON file did not parse properly.");
-      return false;
-    }
     SequenceI sequence = null;
     /* debugging */
     SequenceI[] seqs = pdbAlignment.getSequencesArray();
@@ -325,7 +377,6 @@ public class EBIAlfaFold extends EbiFileRetrievedProxy
       for (int i = 0; i < seqs.length; i++)
       {
         SequenceI s = seqs[i];
-        Console.debug("******* sequences[" + i + "]='" + s.getName() + "'");
       }
     }
     /* end debug */
@@ -336,10 +387,8 @@ public class EBIAlfaFold extends EbiFileRetrievedProxy
       Console.debug("***** Got sequence at index " + seqToGet + ": "
               + (sequence == null ? null : sequence.getName()));
     }
-    else
+    if (sequence == null)
     {
-      Console.debug("***** Looking for sequence with id '" + seqId + "'");
-
       SequenceI[] sequences = pdbAlignment.findSequenceMatch(seqId);
       if (sequences == null || sequences.length < 1)
       {
@@ -352,11 +401,83 @@ public class EBIAlfaFold extends EbiFileRetrievedProxy
         sequence = sequences[0]; // just use the first sequence with this seqId
       }
     }
+
+    JSONObject paeDict = parseJSONtoPAEContactMatrix(pae_input);
+    if (paeDict == null)
+    {
+      Console.debug("JSON file did not parse properly.");
+      return false;
+    }
     ContactMatrixI matrix = new PAEContactMatrix(sequence,
-            (Map<String, Object>) pae_obj.get(0));
+            (Map<String, Object>) paeDict);
 
     AlignmentAnnotation cmannot = sequence.addContactList(matrix);
     pdbAlignment.addAnnotation(cmannot);
+
+    return true;
+  }
+
+  public static JSONObject parseJSONtoPAEContactMatrix(
+          InputStream pae_input) throws IOException,ParseException
+  {
+    Object paeJson = Platform.parseJSON(pae_input);
+    JSONObject paeDict=null;
+    if (paeJson instanceof JSONObject)
+    {
+      Console.debug("***** paeJson is a JSONObject");
+      paeDict = (JSONObject) paeJson;
+    }
+    else if (paeJson instanceof JSONArray)
+    {
+      JSONArray jsonArray = (JSONArray) paeJson;
+      if (jsonArray.size() > 0)
+        paeDict = (JSONObject) jsonArray.get(0);
+    }
+
+    return paeDict;
+  }
+
+  public static boolean importPaeJSONAsContactMatrixToStructure(
+          StructureMapping[] smArray, InputStream paeInput)
+          throws IOException, ParseException
+  {
+    boolean someDone = false;
+    Console.debug("##### smArray.length=" + smArray.length);
+    for (StructureMapping sm : smArray)
+    {
+      Console.debug("##### sm[n]=" + sm.getPdbId());
+      boolean thisDone = importPaeJSONAsContactMatrixToStructure(sm,
+              paeInput);
+      Console.debug("##### thisDone = " + thisDone);
+      someDone |= thisDone;
+    }
+    return someDone;
+  }
+
+  public static boolean importPaeJSONAsContactMatrixToStructure(
+          StructureMapping sm, InputStream paeInput)
+          throws IOException, ParseException
+  {
+
+    JSONObject pae_obj = parseJSONtoPAEContactMatrix(paeInput);
+    if (pae_obj == null)
+    {
+      Console.debug("JSON file did not parse properly.");
+      return false;
+    }
+
+    ContactMatrixI matrix = new PAEContactMatrix(sm.getSequence(),
+            (Map<String, Object>) pae_obj);
+
+    AlignmentAnnotation cmannot = sm.getSequence().addContactList(matrix);
+    // sm.getSequence().addAlignmentAnnotation(cmannot);
+    sm.transfer(cmannot);
+    // return true;
+
+    StructureSelectionManager ssm = StructureSelectionManager
+            .getStructureSelectionManager(Desktop.instance);
+    List<AlignedCodonFrame> acfList = ssm.getSequenceMappings();
+
     return true;
   }