Merge branch 'develop' into features/r2_11_2_alphafold/JAL-2349_JAL-3855
authorJim Procter <j.procter@dundee.ac.uk>
Wed, 16 Feb 2022 13:27:25 +0000 (13:27 +0000)
committerJim Procter <j.procter@dundee.ac.uk>
Wed, 16 Feb 2022 13:27:25 +0000 (13:27 +0000)
combined new logic for 2.11.2 3d-beacons with original hack to resolve PAE and CIF
 Conflicts:
src/jalview/ws/dbsources/EBIAlfaFold.java

1  2 
src/jalview/datamodel/AlignmentAnnotation.java
src/jalview/io/AppletFormatAdapter.java
src/jalview/renderer/AnnotationRenderer.java
src/jalview/ws/SequenceFetcher.java
src/jalview/ws/dbsources/EBIAlfaFold.java
test/jalview/ws/seqfetcher/DbRefFetcherTest.java

@@@ -20,6 -20,8 +20,8 @@@
   */
  package jalview.datamodel;
  
+ import java.util.Locale;
  import jalview.analysis.Rna;
  import jalview.analysis.SecStrConsensus.SimpleBP;
  import jalview.analysis.WUSSParseException;
@@@ -280,8 -282,6 +282,8 @@@ public class AlignmentAnnotatio
  
    public static final int LINE_GRAPH = 2;
  
 +  public static final int CUSTOMRENDERER = 4;
 +
    public boolean belowAlignment = true;
  
    public SequenceGroup groupRef = null;
    {
      if (seqname && this.sequenceRef != null)
      {
-       int i = description.toLowerCase().indexOf("<html>");
+       int i = description.toLowerCase(Locale.ROOT).indexOf("<html>");
        if (i > -1)
        {
          // move the html tag to before the sequence reference.
   */
  package jalview.io;
  
+ import java.util.Locale;
  import jalview.api.AlignExportSettingsI;
  import jalview.api.AlignmentViewPanel;
  import jalview.datamodel.Alignment;
  import jalview.datamodel.AlignmentAnnotation;
  import jalview.datamodel.AlignmentI;
  import jalview.datamodel.AlignmentView;
 +import jalview.datamodel.SeqDistanceContactMatrix;
  import jalview.datamodel.PDBEntry.Type;
  import jalview.datamodel.SequenceI;
  import jalview.ext.jmol.JmolParser;
@@@ -444,7 -445,7 +446,7 @@@ public class AppletFormatAdapte
      
      String data = dataObject.toString();
      DataSourceType protocol = DataSourceType.PASTE;
-     String ft = data.toLowerCase().trim();
+     String ft = data.toLowerCase(Locale.ROOT).trim();
      if (ft.indexOf("http:") == 0 || ft.indexOf("https:") == 0
              || ft.indexOf("file:") == 0)
      {
@@@ -30,8 -30,6 +30,8 @@@ import jalview.datamodel.Annotation
  import jalview.datamodel.ColumnSelection;
  import jalview.datamodel.HiddenColumns;
  import jalview.datamodel.ProfilesI;
 +import jalview.renderer.api.AnnotationRendererFactoryI;
 +import jalview.renderer.api.AnnotationRowRendererI;
  import jalview.schemes.ColourSchemeI;
  import jalview.schemes.NucleotideColourScheme;
  import jalview.schemes.ResidueProperties;
@@@ -157,7 -155,6 +157,7 @@@ public class AnnotationRendere
      hStrucConsensus = null;
      fadedImage = null;
      annotationPanel = null;
 +    rendererFactoryI = null;
    }
  
    void drawStemAnnot(Graphics g, Annotation[] row_annotations, int lastSSX,
        useClip = false;
      }
  
 +    rendererFactoryI = AnnotationRendererFactory.getRendererFactory();
      updateFromAlignViewport(av);
    }
  
      return null;
    }
  
 +  boolean rna = false;
 +
 +  private AnnotationRendererFactoryI rendererFactoryI;
 +
    /**
     * Render the annotation rows associated with an alignment.
     * 
                      row.graphMin, row.graphMax, y, renderHistogram,
                      renderProfile, normaliseProfile);
            }
 +          else
 +          {
 +            AnnotationRowRendererI renderer = rendererFactoryI
 +                    .getRendererFor(row);
 +            if (renderer != null)
 +            {
 +              renderer.renderRow(g, charWidth, charHeight,
 +                      hasHiddenColumns, av, hiddenColumns, columnSelection,
 +                      row, row_annotations, startRes, endRes, row.graphMin,
 +                      row.graphMax, y);
 +            }
 +            if (debugRedraw)
 +            {
 +              if (renderer == null)
 +              {
 +                System.err.println("No renderer found for "
 +                        + row.toString());
 +              }
 +              else
 +              {
 +                System.err.println("rendered with "
 +                        + renderer.getClass().toString());
 +              }
 +            }
 +
 +          }
          }
        }
        else
                        .deriveFont(AffineTransform.getScaleInstance(sx, sy));
                g.setFont(font);
                g.drawChars(dc, 0, dc.length, x * charWidth, hght);
+               g.setFont(ofont);
                ht += newHeight;
              }
            }
  package jalview.ws;
  
  import jalview.ext.ensembl.EnsemblGene;
 +import jalview.ws.dbsources.EBIAlfaFold;
  import jalview.ws.dbsources.EmblCdsSource;
  import jalview.ws.dbsources.EmblSource;
  import jalview.ws.dbsources.Pdb;
  import jalview.ws.dbsources.PfamFull;
  import jalview.ws.dbsources.PfamSeed;
  import jalview.ws.dbsources.RfamSeed;
+ import jalview.ws.dbsources.TDBeacons;
  import jalview.ws.dbsources.Uniprot;
  import jalview.ws.seqfetcher.ASequenceFetcher;
  import jalview.ws.seqfetcher.DbSourceProxy;
@@@ -55,11 -55,12 +56,13 @@@ public class SequenceFetcher extends AS
      addDBRefSourceImpl(EmblSource.class);
      addDBRefSourceImpl(EmblCdsSource.class);
      addDBRefSourceImpl(Uniprot.class);
+     // not a sequence source yet
+     // addDBRefSourceImpl(TDBeacons.class);
      addDBRefSourceImpl(Pdb.class);
      addDBRefSourceImpl(PfamFull.class);
      addDBRefSourceImpl(PfamSeed.class);
      addDBRefSourceImpl(RfamSeed.class);
 +    addDBRefSourceImpl(EBIAlfaFold.class);
    }
  
    /**
  package jalview.ws.dbsources;
  
  import jalview.api.FeatureSettingsModelI;
 +import jalview.bin.Cache;
++import jalview.bin.Console;
  import jalview.datamodel.AlignmentAnnotation;
  import jalview.datamodel.AlignmentI;
 +import jalview.datamodel.ContactMatrix;
 +import jalview.datamodel.ContactMatrixI;
  import jalview.datamodel.DBRefEntry;
  import jalview.datamodel.DBRefSource;
  import jalview.datamodel.PDBEntry;
  import jalview.datamodel.PDBEntry.Type;
+ import jalview.datamodel.SequenceFeature;
  import jalview.datamodel.SequenceI;
+ import jalview.datamodel.features.SequenceFeaturesI;
  import jalview.io.DataSourceType;
  import jalview.io.FileFormat;
  import jalview.io.FileFormatI;
  import jalview.io.FormatAdapter;
  import jalview.io.PDBFeatureSettings;
 +import jalview.javascript.json.JSON;
  import jalview.structure.StructureImportSettings;
  import jalview.util.HttpUtils;
  import jalview.util.MessageManager;
 +import jalview.util.Platform;
 +import jalview.ws.datamodel.alphafold.PAEContactMatrix;
  import jalview.ws.ebi.EBIFetchClient;
  import jalview.ws.utils.UrlDownloadClient;
  
 +import java.io.BufferedReader;
  import java.io.File;
 +import java.io.FileInputStream;
  import java.util.ArrayList;
  import java.util.List;
 +import java.util.Map;
 +
 +import org.jmol.adapter.readers.simple.JSONReader;
  
  import com.stevesoft.pat.Regex;
  
@@@ -93,7 -84,9 +96,9 @@@ public class EBIAlfaFold extends EbiFil
    @Override
    public Regex getAccessionValidator()
    {
-     return new Regex("(AF-[A-Z]+[0-9]+[A-Z0-9]+-F1)");
+     Regex validator =  new Regex("(AF-[A-Z]+[0-9]+[A-Z0-9]+-F1)");
+     validator.setIgnoreCase(true);
+     return validator;
    }
  
    /*
      return "https://alphafold.ebi.ac.uk/files/" + id + "-model_v1.cif";
    }
  
 +  public static String getAlphaFoldPaeDownloadUrl(String id)
 +  {
 +    return "https://alphafold.ebi.ac.uk/files/" + id
 +            + "-predicted_aligned_error_v1.json";
 +  }
 +
    /*
     * (non-Javadoc)
     * 
    @Override
    public AlignmentI getSequenceRecords(String queries) throws Exception
    {
+     return getSequenceRecords(queries, null);
+   }
+   public AlignmentI getSequenceRecords(String queries, String retrievalUrl) throws Exception
+   {
      AlignmentI pdbAlignment = null;
      String chain = null;
      String id = null;
      if (!isValidReference(id))
      {
        System.err.println(
 -              "(AFClient) Ignoring invalid pdb query: '" + id + "'");
 +              "(AFClient) Ignoring invalid alphafold query: '" + id + "'");
        stopQuery();
        return null;
      }
      String alphaFoldCif = getAlphaFoldCifDownloadUrl(id);
+     if (retrievalUrl != null)
+     {
+       alphaFoldCif = retrievalUrl;
+     }
  
      try
      {
-       File tmpFile = File.createTempFile(id, "cif");
+       File tmpFile = File.createTempFile(id, ".cif");
++      Console.debug("Retrieving structure file for "+id+" from "+alphaFoldCif);
        UrlDownloadClient.download(alphaFoldCif, tmpFile);
+       
+       // may not need this check ?
        file = tmpFile.getAbsolutePath();
        if (file == null)
        {
          return null;
        }
  
-       // todo get rid of Type and use FileFormatI instead?
-       FileFormatI fileFormat = FileFormat.MMCif;
-       pdbAlignment = new FormatAdapter().readFile(tmpFile,
-               DataSourceType.FILE, fileFormat);
-       if (pdbAlignment != null)
-       {
-         List<SequenceI> toremove = new ArrayList<SequenceI>();
-         for (SequenceI pdbcs : pdbAlignment.getSequences())
-         {
-           String chid = null;
-           // Mapping map=null;
-           for (PDBEntry pid : pdbcs.getAllPDBEntries())
-           {
-             if (pid.getFile() == file)
-             {
-               chid = pid.getChainCode();
-             }
-           }
-           if (chain == null || (chid != null && (chid.equals(chain)
-                   || chid.trim().equals(chain.trim())
-                   || (chain.trim().length() == 0 && chid.equals("_")))))
-           {
-             // FIXME seems to result in 'PDB|1QIP|1qip|A' - 1QIP is redundant.
-             // TODO: suggest simplify naming to 1qip|A as default name defined
-             pdbcs.setName(id + SEPARATOR + pdbcs.getName());
-             // Might need to add more metadata to the PDBEntry object
-             // like below
-             /*
-              * PDBEntry entry = new PDBEntry(); // Construct the PDBEntry
-              * entry.setId(id); if (entry.getProperty() == null)
-              * entry.setProperty(new Hashtable());
-              * entry.getProperty().put("chains", pdbchain.id + "=" +
-              * sq.getStart() + "-" + sq.getEnd());
-              * sq.getDatasetSequence().addPDBId(entry);
-              */
-             // Add PDB DB Refs
-             // We make a DBRefEtntry because we have obtained the PDB file from
-             // a
-             // verifiable source
-             // JBPNote - PDB DBRefEntry should also carry the chain and mapping
-             // information
-             DBRefEntry dbentry = new DBRefEntry(getDbSource(),
-                     getDbVersion(), (chid == null ? id : id + chid));
-             // dbentry.setMap()
-             pdbcs.addDBRef(dbentry);
-           }
-           else
-           {
-             // mark this sequence to be removed from the alignment
-             // - since it's not from the right chain
-             toremove.add(pdbcs);
-           }
-         }
-         // now remove marked sequences
-         for (SequenceI pdbcs : toremove)
-         {
-           pdbAlignment.deleteSequence(pdbcs);
-           if (pdbcs.getAnnotation() != null)
-           {
-             for (AlignmentAnnotation aa : pdbcs.getAnnotation())
-             {
-               pdbAlignment.deleteAnnotation(aa);
-             }
-           }
-         }
-       }
+       pdbAlignment = importDownloadedStructureFromUrl(alphaFoldCif, tmpFile, id, chain, getDbSource(),getDbVersion());
+       
  
        if (pdbAlignment == null || pdbAlignment.getHeight() < 1)
        {
                  { id, ((chain == null) ? "' '" : chain) }));
        }
  
 +      // import PAE as contact matrix - assume this will work if there was a
 +      // model
 +      File pae = File.createTempFile(id, "pae_json");
 +      String paeURL = getAlphaFoldPaeDownloadUrl(id);
-       UrlDownloadClient.download(paeURL, pae);
++      
++      if (retrievalUrl!=null) {
++        // manufacture the PAE url from a url like ...-model-vN.cif
++        paeURL = retrievalUrl.replace("model","predicted_aligned_error").replace(".cif",".json");
++      }
++      Console.debug("Downloading pae from " + paeURL
++              + " to " + pae.toString() + "");
++
++      try {
++        UrlDownloadClient.download(paeURL, pae);        
 +      if (!importPaeJSONAsContactMatrix(pdbAlignment, pae))
 +      {
-         Cache.log.debug("Couln't import contact matrix from " + paeURL
++        Console.warn("Couln't import contact matrix from " + paeURL
 +                + " (stored in " + pae.toString() + ")");
 +      }
++      } catch (Exception pae_ex) {
++        Console.debug("Couldn't download PAE",pae_ex);
++      }
 +
      } catch (Exception ex) // Problem parsing PDB file
      {
        stopQuery();
      return pdbAlignment;
    }
  
 +  private boolean importPaeJSONAsContactMatrix(AlignmentI pdbAlignment,
 +          File pae) throws Exception
 +  {
 +    FileInputStream pae_input = new FileInputStream(pae);
 +
 +    List<Object> pae_obj = (List<Object>) Platform
 +            .parseJSON(pae_input);
 +    if (pae_obj == null)
 +    {
 +      return false;
 +    }
 +    ContactMatrixI matrix = new PAEContactMatrix(
 +            pdbAlignment.getSequenceAt(0), (Map<String, Object>)pae_obj.get(0));
 +
 +    pdbAlignment.getSequenceAt(0).addAlignmentAnnotation(pdbAlignment.addContactList(matrix));
 +    return true;
 +  }
 +
+   /**
+    * general purpose structure importer - designed to yield alignment useful for transfer of annotation to associated sequences
+    * @param alphaFoldCif
+    * @param tmpFile
+    * @param id
+    * @param chain
+    * @param dbSource
+    * @param dbVersion
+    * @return
+    * @throws Exception
+    */
+   public static AlignmentI importDownloadedStructureFromUrl(String alphaFoldCif,
+           File tmpFile, String id, String chain, String dbSource, String dbVersion) throws Exception
+   {
+     String file = tmpFile.getAbsolutePath();
+     // todo get rid of Type and use FileFormatI instead?
+     FileFormatI fileFormat = FileFormat.MMCif;
+     AlignmentI pdbAlignment = new FormatAdapter().readFile(tmpFile,
+             DataSourceType.FILE, fileFormat);
+     if (pdbAlignment != null)
+     {
+       List<SequenceI> toremove = new ArrayList<SequenceI>();
+       for (SequenceI pdbcs : pdbAlignment.getSequences())
+       {
+         String chid = null;
+         // Mapping map=null;
+         for (PDBEntry pid : pdbcs.getAllPDBEntries())
+         {
+           if (pid.getFile() == file)
+           {
+             chid = pid.getChainCode();
+           }
+         }
+         if (chain == null || (chid != null && (chid.equals(chain)
+                 || chid.trim().equals(chain.trim())
+                 || (chain.trim().length() == 0 && chid.equals("_")))))
+         {
+           // FIXME seems to result in 'PDB|1QIP|1qip|A' - 1QIP is redundant.
+           // TODO: suggest simplify naming to 1qip|A as default name defined
+           pdbcs.setName(id + SEPARATOR + pdbcs.getName());
+           // Might need to add more metadata to the PDBEntry object
+           // like below
+           /*
+            * PDBEntry entry = new PDBEntry(); // Construct the PDBEntry
+            * entry.setId(id); if (entry.getProperty() == null)
+            * entry.setProperty(new Hashtable());
+            * entry.getProperty().put("chains", pdbchain.id + "=" +
+            * sq.getStart() + "-" + sq.getEnd());
+            * sq.getDatasetSequence().addPDBId(entry);
+            */
+           // Add PDB DB Refs
+           // We make a DBRefEtntry because we have obtained the PDB file from
+           // a
+           // verifiable source
+           // JBPNote - PDB DBRefEntry should also carry the chain and mapping
+           // information
+           if (dbSource != null)
+           {
+             DBRefEntry dbentry = new DBRefEntry(dbSource,
+                     dbVersion, (chid == null ? id : id + chid));
+             // dbentry.setMap()
+             pdbcs.addDBRef(dbentry);
+             // update any feature groups
+             List<SequenceFeature> allsf = pdbcs.getFeatures().getAllFeatures();
+             List<SequenceFeature> newsf = new ArrayList<SequenceFeature>();
+             if (allsf!=null && allsf.size()>0)
+             {
+               for (SequenceFeature f:allsf)
+               {
+                 if (file.equals(f.getFeatureGroup()))
+                 {
+                   f = new SequenceFeature(f, f.type, f.begin, f.end, id, f.score);
+                 }
+                 newsf.add(f);
+               }
+               pdbcs.setSequenceFeatures(newsf);
+             }
+           }
+         }
+         else
+         {
+           // mark this sequence to be removed from the alignment
+           // - since it's not from the right chain
+           toremove.add(pdbcs);
+         }
+       }
+       // now remove marked sequences
+       for (SequenceI pdbcs : toremove)
+       {
+         pdbAlignment.deleteSequence(pdbcs);
+         if (pdbcs.getAnnotation() != null)
+         {
+           for (AlignmentAnnotation aa : pdbcs.getAnnotation())
+           {
+             pdbAlignment.deleteAnnotation(aa);
+           }
+         }
+       }
+     }
+     return pdbAlignment;
+   }
    /*
     * (non-Javadoc)
     * 
    @Override
    public String getTestQuery()
    {
 -    return "1QIP";
 +    return "AF-O15552-F1";
    }
  
    @Override
    public String getDbName()
    {
 -    return "PDB"; // getDbSource();
 +    return "ALPHAFOLD"; // getDbSource();
    }
  
    @Override
    {
      return new PDBFeatureSettings();
    }
  }
   */
  package jalview.ws.seqfetcher;
  
 +import static org.testng.Assert.assertNotEquals;
  import static org.testng.AssertJUnit.assertEquals;
  import static org.testng.AssertJUnit.assertFalse;
  import static org.testng.AssertJUnit.assertNotNull;
  import static org.testng.AssertJUnit.assertTrue;
  
  import jalview.analysis.CrossRef;
 +import jalview.datamodel.AlignmentAnnotation;
  import jalview.datamodel.AlignmentI;
  import jalview.datamodel.DBRefEntry;
  import jalview.datamodel.DBRefSource;
  import jalview.datamodel.FeatureProperties;
+ import jalview.datamodel.Sequence;
  import jalview.datamodel.SequenceFeature;
  import jalview.datamodel.SequenceI;
  import jalview.gui.JvOptionPane;
  import jalview.util.DBRefUtils;
+ import jalview.ws.DBRefFetcher;
  import jalview.ws.SequenceFetcher;
 +import jalview.ws.dbsources.EBIAlfaFold;
  import jalview.ws.dbsources.Pdb;
  import jalview.ws.dbsources.Uniprot;
  
@@@ -45,7 -44,6 +47,7 @@@ import java.util.ArrayList
  import java.util.Arrays;
  import java.util.List;
  
 +import org.junit.Assert;
  import org.testng.annotations.AfterClass;
  import org.testng.annotations.BeforeClass;
  import org.testng.annotations.Test;
@@@ -70,7 -68,7 +72,7 @@@ public class DbRefFetcherTes
    @BeforeClass(alwaysRun = true)
    public static void setUpBeforeClass() throws Exception
    {
-     jalview.bin.Cache.initLogger();
+     jalview.bin.Console.initLogger();
    }
  
    /**
    {
    }
  
+   @Test(groups= {"Network"})
+   public void checkUniprotCanonicalFlagSet()
+   {
+     // TODO - mock this  - for moment it is a live request.
+     SequenceI uniprotSeq = new Sequence("FER1_SPIOL",
+             "MAATTTTMMGMATTFVPKPQAPPMMAALPSNTGRSLFGLKTGSRGGRMTMAAYKVTLVTPTGNVEFQCPDDV"
+             + "YILDAAEEEGIDLPYSCRAGSCSSCAGKLKTGSLNQDDQSFLDDDQIDEGWVLTCAAYPVSDVTIETHKEEE"
+             + "LTA");
+     DBRefFetcher dbr = new DBRefFetcher(new SequenceI[] { uniprotSeq });
+     dbr.fetchDBRefs(true);
+     List<DBRefEntry> primRefs = uniprotSeq.getPrimaryDBRefs();
+     assertNotNull(primRefs);
+     assertTrue(primRefs.size()>0);
+     boolean canonicalUp=false;
+     for (DBRefEntry ref:primRefs) {
+       assertEquals(DBRefSource.UNIPROT, ref.getCanonicalSourceName());
+       canonicalUp |= ref.isCanonical();
+     }
+     assertTrue("No Canonical Uniprot reference detected", canonicalUp);
+   }
    /**
     * Tests that standard protein database sources include Uniprot (as the first)
     * and also PDB. (Additional sources are dependent on availability of DAS
      assertEquals(dr.get(0).getSource() + "|" + dr.get(0).getAccessionId(),
              proteinSeq.getName());
    }
 +
 +  /**
 +   * Tests retrieval of one entry from EMBLCDS. Test is dependent on
 +   * availability of network and the EMBLCDS service.
 +   * 
 +   * @throws Exception
 +   */
 +  @Test(groups = { "External" })
 +  public void testAlphaFoldClien() throws Exception
 +  {
 +    DbSourceProxy alphafold = new EBIAlfaFold();
 +    AlignmentI resp = alphafold.getSequenceRecords(alphafold.getTestQuery());
 +    assertNotNull(resp);
 +    assertEquals("One sequence only",resp.getHeight(), 1);
 +    for (AlignmentAnnotation aa:resp.getAlignmentAnnotation()) {
 +      if (aa.graph == AlignmentAnnotation.CUSTOMRENDERER)
 +      {
 +        assertTrue("Contact map didn't provide valid contact",resp.getContactListFor(aa, 1).getContactAt(1)!=-1d);
 +        // test passes
 +        return;
 +      }
 +    }
 +    Assert.fail();
 +  }
 +
  }