JAL-1355
[jalview.git] / src / MCview / PDBfile.java
index fe2851a..3dd567e 100755 (executable)
@@ -1,19 +1,22 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package MCview;
 
@@ -22,19 +25,10 @@ import java.util.*;
 
 import java.awt.*;
 
-import javax.xml.parsers.ParserConfigurationException;
-
-import org.xml.sax.SAXException;
-
-import fr.orsay.lri.varna.exceptions.ExceptionFileFormatOrSyntax;
-import fr.orsay.lri.varna.exceptions.ExceptionLoadingFailed;
-import fr.orsay.lri.varna.exceptions.ExceptionPermissionDenied;
-import fr.orsay.lri.varna.exceptions.ExceptionUnmatchedClosingParentheses;
-
+import jalview.analysis.AlignSeq;
 import jalview.datamodel.*;
 import jalview.io.FileParse;
-import jalview.io.RnamlFile;
-import jalview.ws.jws1.Annotate3D;
+import jalview.util.MessageManager;
 
 public class PDBfile extends jalview.io.AlignFile
 {
@@ -47,12 +41,12 @@ public class PDBfile extends jalview.io.AlignFile
    */
   boolean VisibleChainAnnotation = false;
 
-  public PDBfile(String inFile, String inType) throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed, InterruptedException, ExceptionUnmatchedClosingParentheses
+  public PDBfile(String inFile, String inType) throws IOException
   {
     super(inFile, inType);
   }
 
-  public PDBfile(FileParse source) throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed, InterruptedException, ExceptionUnmatchedClosingParentheses
+  public PDBfile(FileParse source) throws IOException
   {
     super(source);
   }
@@ -62,23 +56,23 @@ public class PDBfile extends jalview.io.AlignFile
     return null;
   }
 
-  public void parse() throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed, InterruptedException
+  public void parse() throws IOException
   {
     // TODO set the filename sensibly - try using data source name.
     id = safeName(getDataName());
-  
-      chains = new Vector();
-
-      PDBChain tmpchain;
-      String line=null;
-      boolean modelFlag = false;
-      boolean terFlag = false;
-      String lastID = "";
-
-      int index = 0;
-      String atomnam = null;
-      try
-      {
+
+    chains = new Vector();
+    ArrayList<SequenceI> rna = new ArrayList<SequenceI>(), prot = new ArrayList<SequenceI>();
+    PDBChain tmpchain;
+    String line = null;
+    boolean modelFlag = false;
+    boolean terFlag = false;
+    String lastID = "";
+
+    int index = 0;
+    String atomnam = null;
+    try
+    {
       while ((line = nextLine()) != null)
       {
         if (line.indexOf("HEADER") == 0)
@@ -167,6 +161,12 @@ public class PDBfile extends jalview.io.AlignFile
         dataset.setName(id + "|" + dataset.getName());
         PDBEntry entry = new PDBEntry();
         entry.setId(id);
+        entry.setProperty(new Hashtable());
+        if (((PDBChain) chains.elementAt(i)).id != null)
+        {
+          entry.getProperty().put("CHAIN",
+                  ((PDBChain) chains.elementAt(i)).id);
+        }
         if (inFile != null)
         {
           entry.setFile(inFile.getAbsolutePath());
@@ -181,56 +181,195 @@ public class PDBfile extends jalview.io.AlignFile
         // maintain reference to
         // dataset
         seqs.addElement(chainseq);
-       if(isRNA(chainseq)==true)
-       {
-          String path =inFile.getPath();
-          System.out.println("this is a PDB format and RNA sequence");
-          Annotate3D an3d = new Annotate3D(path);
-          System.out.println(id);
-          //BufferedWriter r = an3d.getReader();
-          
-         // BufferedReader in = new BufferedReader(new FileReader("temp.rnaml"));
-          
-          //String str;
-         // while ((str = in.readLine()) != null) {
-                   // System.out.println(str);
-                   // System.out.println("toto");
-
-                   // }
-          //String type = "File";
-          //RnamlFile rnaml =new RnamlFile("temp.rnaml",type);
-          System.out.println("Create rnamfile object");
-          //rnaml.parse("temp");
-          //this.annotations =rnaml.getAnnot();
-          
-       }
-        
+        if (isRNA(chainseq) == true)
+        {
+          rna.add(chainseq);
+        }
+        else
+        {
+          prot.add(chainseq);
+        }
+
         AlignmentAnnotation[] chainannot = chainseq.getAnnotation();
-        
+
         if (chainannot != null)
         {
           for (int ai = 0; ai < chainannot.length; ai++)
           {
-        
+
             chainannot[ai].visible = VisibleChainAnnotation;
             annotations.addElement(chainannot[ai]);
           }
         }
       }
+      if (rna.size() > 0)
+        try
+        {
+          processPdbFileWithAnnotate3d(rna);
+        } catch (Exception x)
+        {
+          System.err
+                  .println("Exceptions when dealing with RNA in pdb file");
+          x.printStackTrace();
+
+        }
+      ;
+      if (prot.size() > 0)
+        try
+        {
+          processPdbFileWithJmol(prot);
+        } catch (Exception x)
+        {
+          System.err
+                  .println("Exceptions when dealing with RNA in pdb file");
+          x.printStackTrace();
+
+        }
+      ;
+      if (prot.size() > 0)
+        try
+        {
+          processPdbFileWithJmol(prot);
+        } catch (Exception x)
+        {
+          System.err
+                  .println("Exceptions when dealing with RNA in pdb file");
+          x.printStackTrace();
+
+        }
+      ;
     } catch (OutOfMemoryError er)
     {
       System.out.println("OUT OF MEMORY LOADING PDB FILE");
-      throw new IOException("Out of memory loading PDB File");
-    }
-    catch (NumberFormatException ex)
+      throw new IOException(MessageManager.getString("exception.outofmemory_loading_pdb_file"));
+    } catch (NumberFormatException ex)
     {
-      if (line!=null) {
+      if (line != null)
+      {
         System.err.println("Couldn't read number from line:");
         System.err.println(line);
       }
     }
   }
 
+  private void processPdbFileWithJmol(ArrayList<SequenceI> prot)
+          throws Exception
+  {
+    try
+    {
+      Class cl = Class.forName("jalview.ext.jmol.PDBFileWithJmol");
+      if (cl != null)
+      {
+        Object jmf = cl.getConstructor(new Class[]
+        { FileParse.class }).newInstance(new Object[]
+        { new FileParse(getDataName(), type) });
+        Alignment al = new Alignment((SequenceI[]) cl.getMethod(
+                "getSeqsAsArray", new Class[]
+                {}).invoke(jmf));
+        cl.getMethod("addAnnotations", new Class[]
+        { Alignment.class }).invoke(jmf, al);
+        replaceMatchingSeqsWith(prot, al, AlignSeq.PEP);
+      }
+    } catch (ClassNotFoundException q)
+    {
+    }
+  }
+
+  private void processPdbFileWithAnnotate3d(ArrayList<SequenceI> rna)
+          throws Exception
+  {
+    // System.out.println("this is a PDB format and RNA sequence");
+    // note: we use reflection here so that the applet can compile and run
+    // without the HTTPClient bits and pieces needed for accessing Annotate3D
+    // web service
+    try
+    {
+      Class cl = Class.forName("jalview.ws.jws1.Annotate3D");
+      if (cl != null)
+      {
+        // TODO: use the PDB ID of the structure if one is available, to save
+        // bandwidth and avoid uploading the whole structure to the service
+        Object annotate3d = cl.getConstructor(new Class[]
+        {}).newInstance(new Object[]
+        {});
+        AlignmentI al = ((AlignmentI) cl.getMethod("getRNAMLFor",
+                new Class[]
+                { FileParse.class }).invoke(annotate3d, new Object[]
+        { new FileParse(getDataName(), type) }));
+        replaceMatchingSeqsWith(rna, al, AlignSeq.DNA);
+      }
+    } catch (ClassNotFoundException x)
+    {
+      // ignore classnotfounds - occurs in applet
+    }
+    ;
+  }
+
+  private void replaceMatchingSeqsWith(ArrayList<SequenceI> ochains,
+          AlignmentI al, String dnaOrProtein)
+  {
+    if (al != null && al.getHeight() > 0)
+    {
+      ArrayList<SequenceI> matches = new ArrayList<SequenceI>();
+      ArrayList<AlignSeq> aligns = new ArrayList<AlignSeq>();
+
+      for (SequenceI sq : ochains)
+      {
+        SequenceI bestm = null;
+        AlignSeq bestaseq = null;
+        int bestscore = 0;
+        for (SequenceI msq : al.getSequences())
+        {
+          AlignSeq aseq = AlignSeq.doGlobalNWAlignment(msq, sq,
+                  dnaOrProtein);
+          if (bestm == null || aseq.getMaxScore() > bestscore)
+          {
+            bestscore = aseq.getMaxScore();
+            bestaseq = aseq;
+            bestm = msq;
+          }
+        }
+        System.out.println("Best Score for " + (matches.size() + 1) + " :"
+                + bestscore);
+        matches.add(bestm);
+        aligns.add(bestaseq);
+        al.deleteSequence(bestm);
+      }
+      for (int p = 0, pSize = seqs.size(); p < pSize; p++)
+      {
+        SequenceI sq, sp = seqs.get(p);
+        int q;
+        if ((q = ochains.indexOf(sp)) > -1)
+        {
+          seqs.set(p, sq = matches.get(q));
+          sq.setName(sp.getName());
+          sq.setDescription(sp.getDescription());
+          sq.transferAnnotation(sp, aligns.get(q).getMappingFromS1(false));
+          int inspos = -1;
+          for (int ap = 0; ap < annotations.size();)
+          {
+            if (((AlignmentAnnotation) annotations.get(ap)).sequenceRef == sp)
+            {
+              if (inspos == -1)
+              {
+                inspos = ap;
+              }
+              annotations.remove(ap);
+            }
+            else
+            {
+              ap++;
+            }
+          }
+          if (sq.getAnnotation() != null)
+          {
+            annotations.addAll(inspos, Arrays.asList(sq.getAnnotation()));
+          }
+        }
+      }
+    }
+  }
+
   /**
    * make a friendly ID string.
    * 
@@ -300,17 +439,19 @@ public class PDBfile extends jalview.io.AlignFile
               1.0f / (float) i, .4f, 1.0f));
     }
   }
+
   public boolean isRNA(SequenceI seqs)
   {
-         for (int i=0;i<seqs.getLength();i++){
-                 if((seqs.getCharAt(i)!='A') &&(seqs.getCharAt(i)!='C')&&(seqs.getCharAt(i)!='G')&&(seqs.getCharAt(i)!='U'))
-                 {
-                         return false;
-                 }
-         }
-        
-                 return true;
-         
-         
+    for (int i = 0; i < seqs.getLength(); i++)
+    {
+      if ((seqs.getCharAt(i) != 'A') && (seqs.getCharAt(i) != 'C')
+              && (seqs.getCharAt(i) != 'G') && (seqs.getCharAt(i) != 'U'))
+      {
+        return false;
+      }
+    }
+
+    return true;
+
   }
 }