JAL-2009 Codes to enable storing inserted residues as features to their base residue...
[jalview.git] / src / jalview / structure / StructureSelectionManager.java
index 846ec9c..9d06aef 100644 (file)
@@ -32,11 +32,13 @@ import jalview.datamodel.Annotation;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SearchResults;
 import jalview.datamodel.SequenceI;
+import jalview.gui.IProgressIndicator;
 import jalview.io.AppletFormatAdapter;
 import jalview.util.MappingUtils;
 import jalview.util.MessageManager;
 import jalview.ws.sifts.SiftsClient;
 import jalview.ws.sifts.SiftsException;
+import jalview.ws.sifts.SiftsSettings;
 
 import java.io.PrintStream;
 import java.util.ArrayList;
@@ -69,6 +71,12 @@ public class StructureSelectionManager
 
   private boolean addTempFacAnnot = false;
 
+  private IProgressIndicator progressIndicator;
+
+  private SiftsClient siftsClient = null;
+
+  private long progressSessionId;
+
   /*
    * Set of any registered mappings between (dataset) sequences.
    */
@@ -326,9 +334,9 @@ public class StructureSelectionManager
    * @param forStructureView
    *          when true, record the mapping for use in mouseOvers
    * 
-   * @param sequence
+   * @param sequenceArray
    *          - one or more sequences to be mapped to pdbFile
-   * @param targetChains
+   * @param targetChainIds
    *          - optional chain specification for mapping each sequence to pdb
    *          (may be nill, individual elements may be nill)
    * @param pdbFile
@@ -338,7 +346,8 @@ public class StructureSelectionManager
    * @return null or the structure data parsed as a pdb file
    */
   synchronized public PDBfile setMapping(boolean forStructureView,
-          SequenceI[] sequence, String[] targetChains, String pdbFile,
+          SequenceI[] sequenceArray, String[] targetChainIds,
+          String pdbFile,
           String protocol)
   {
     /*
@@ -348,7 +357,7 @@ public class StructureSelectionManager
     boolean parseSecStr = processSecondaryStructure;
     if (isPDBFileRegistered(pdbFile))
     {
-      for (SequenceI sq : sequence)
+      for (SequenceI sq : sequenceArray)
       {
         SequenceI ds = sq;
         while (ds.getDatasetSequence() != null)
@@ -372,10 +381,12 @@ public class StructureSelectionManager
       }
     }
     PDBfile pdb = null;
+    boolean isMapUsingSIFTs = SiftsSettings.isMapWithSifts();
     try
     {
       pdb = new PDBfile(addTempFacAnnot, parseSecStr, secStructServices,
               pdbFile, protocol);
+
       if (pdb.id != null && pdb.id.trim().length() > 0
               && AppletFormatAdapter.FILE.equals(protocol))
       {
@@ -387,36 +398,48 @@ public class StructureSelectionManager
       return null;
     }
 
-    String targetChain;
-    for (int s = 0; s < sequence.length; s++)
+    try
+    {
+      if (isMapUsingSIFTs)
+      {
+        siftsClient = new SiftsClient(pdb);
+      }
+    } catch (SiftsException e)
+    {
+      isMapUsingSIFTs = false;
+      e.printStackTrace();
+    }
+
+    String targetChainId;
+    for (int s = 0; s < sequenceArray.length; s++)
     {
       boolean infChain = true;
-      final SequenceI seq = sequence[s];
-      if (targetChains != null && targetChains[s] != null)
+      final SequenceI seq = sequenceArray[s];
+      if (targetChainIds != null && targetChainIds[s] != null)
       {
         infChain = false;
-        targetChain = targetChains[s];
+        targetChainId = targetChainIds[s];
       }
       else if (seq.getName().indexOf("|") > -1)
       {
-        targetChain = seq.getName().substring(
+        targetChainId = seq.getName().substring(
                 seq.getName().lastIndexOf("|") + 1);
-        if (targetChain.length() > 1)
+        if (targetChainId.length() > 1)
         {
-          if (targetChain.trim().length() == 0)
+          if (targetChainId.trim().length() == 0)
           {
-            targetChain = " ";
+            targetChainId = " ";
           }
           else
           {
             // not a valid chain identifier
-            targetChain = "";
+            targetChainId = "";
           }
         }
       }
       else
       {
-        targetChain = "";
+        targetChainId = "";
       }
 
       /*
@@ -430,7 +453,7 @@ public class StructureSelectionManager
       boolean first = true;
       for (PDBChain chain : pdb.chains)
       {
-        if (targetChain.length() > 0 && !targetChain.equals(chain.id)
+        if (targetChainId.length() > 0 && !targetChainId.equals(chain.id)
                 && !infChain)
         {
           continue; // don't try to map chains don't match.
@@ -446,7 +469,7 @@ public class StructureSelectionManager
         // as.traceAlignment();
 
         if (first || as.maxscore > max
-                || (as.maxscore == max && chain.id.equals(targetChain)))
+                || (as.maxscore == max && chain.id.equals(targetChainId)))
         {
           first = false;
           maxChain = chain;
@@ -465,46 +488,83 @@ public class StructureSelectionManager
         pdbFile = "INLINE" + pdb.id;
       }
 
-      StructureMapping seqToStrucMapping = null;
-      boolean isMapViaSIFTs = Boolean.valueOf(jalview.bin.Cache.getDefault(
-              "MAP_WITH_SIFTS", "false"));
-      if (isMapViaSIFTs)
+      ArrayList<StructureMapping> seqToStrucMapping = new ArrayList<StructureMapping>();
+      if (isMapUsingSIFTs)
       {
-        SiftsClient siftsClient = new SiftsClient(pdb.id);
-        try
+        setProgressBar(null);
+        setProgressBar("Obtaining mapping with SIFTS");
+        jalview.datamodel.Mapping sqmpping = maxAlignseq
+                .getMappingFromS1(false);
+        if (targetChainId != null && !targetChainId.trim().isEmpty())
         {
-          seqToStrucMapping = siftsClient.getSiftsStructureMapping(seq,
-                  pdbFile, maxChainId);
-        } catch (SiftsException e)
+          StructureMapping mapping = getStructureMapping(seq, pdbFile,
+                  targetChainId, pdb, maxChain, sqmpping, maxAlignseq);
+          seqToStrucMapping.add(mapping);
+        }
+        else
         {
-          System.err
-                  .println(">>>>>>> SIFTs mapping could not be obtained... Now mapping with NW alignment");
-          seqToStrucMapping = getNWMappings(seq, pdbFile, maxChainId,
-                  maxChain, pdb, maxAlignseq);
+          for (PDBChain chain : pdb.chains)
+          {
+            StructureMapping mapping = getStructureMapping(seq, pdbFile,
+                    chain.id, pdb, chain, sqmpping, maxAlignseq);
+            seqToStrucMapping.add(mapping);
+          }
         }
       }
       else
       {
-        seqToStrucMapping = getNWMappings(seq, pdbFile,
-                maxChainId, maxChain, pdb,
-                maxAlignseq);
+        setProgressBar(null);
+        setProgressBar("Obtaining mapping with NW alignment");
+        seqToStrucMapping.add(getNWMappings(seq, pdbFile, maxChainId,
+                maxChain, pdb, maxAlignseq));
       }
 
       if (forStructureView)
       {
-        mappings.add(seqToStrucMapping);
+        mappings.addAll(seqToStrucMapping);
       }
     }
     return pdb;
   }
 
-  private StructureMapping getNWMappings(SequenceI seq, String pdbFile,
+  private StructureMapping getStructureMapping(SequenceI seq,
+          String pdbFile, String targetChainId, PDBfile pdb,
+          PDBChain maxChain, jalview.datamodel.Mapping sqmpping,
+          AlignSeq maxAlignseq)
+  {
+    String maxChainId = targetChainId;
+    try
+    {
+      StructureMapping curChainMapping = siftsClient
+              .getSiftsStructureMapping(seq, pdbFile, targetChainId);
+      PDBChain chain = pdb.findChain(targetChainId);
+      if (chain != null)
+      {
+        chain.transferResidueAnnotation(curChainMapping, sqmpping);
+      }
+      return curChainMapping;
+    } catch (SiftsException e)
+    {
+      System.err.println(e.getMessage());
+      System.err.println(">>> Now switching mapping with NW alignment...");
+      setProgressBar(null);
+      setProgressBar(">>> Now switching mapping with NW alignment...");
+      return getNWMappings(seq, pdbFile, maxChainId, maxChain, pdb,
+              maxAlignseq);
+    }
+  }
+
+  private StructureMapping getNWMappings(SequenceI seq,
+          String pdbFile,
           String maxChainId, PDBChain maxChain, PDBfile pdb,
           AlignSeq maxAlignseq)
   {
     final StringBuilder mappingDetails = new StringBuilder(128);
     mappingDetails.append(NEWLINE).append(
             "Sequence \u27f7 Structure mapping details");
+    mappingDetails.append(NEWLINE);
+    mappingDetails
+            .append("Method: inferred with Needleman & Wunsch alignment");
     mappingDetails.append(NEWLINE).append("PDB Sequence is :")
             .append(NEWLINE).append("Sequence = ")
             .append(maxChain.sequence.getSequenceAsString());
@@ -539,32 +599,28 @@ public class StructureSelectionManager
     mappingDetails.append(String.valueOf(maxAlignseq.seq1end
             + (seq.getStart() - 1)));
     mappingDetails.append(NEWLINE);
-    mappingDetails
-            .append("Mapping inferred with Needleman & Wunsch alignment");
-    mappingDetails.append(NEWLINE);
     maxChain.makeExactMapping(maxAlignseq, seq);
     jalview.datamodel.Mapping sqmpping = maxAlignseq
             .getMappingFromS1(false);
     maxChain.transferRESNUMFeatures(seq, null);
 
-    // allocate enough slots to store the mapping from positions in
-    // sequence[s] to the associated chain
-    int[][] mapping = new int[seq.findPosition(seq.getLength()) + 2][2];
+    HashMap<Integer, int[]> mapping = new HashMap<Integer, int[]>();
     int resNum = -10000;
     int index = 0;
+    char insCode = ' ';
 
     do
     {
       Atom tmp = maxChain.atoms.elementAt(index);
-      if (resNum != tmp.resNumber && tmp.alignmentMapping != -1)
+      if ((resNum != tmp.resNumber || insCode != tmp.insCode)
+              && tmp.alignmentMapping != -1)
       {
         resNum = tmp.resNumber;
+        insCode = tmp.insCode;
         if (tmp.alignmentMapping >= -1)
         {
-          // TODO (JAL-1836) address root cause: negative residue no in PDB
-          // file
-          mapping[tmp.alignmentMapping + 1][0] = tmp.resNumber;
-          mapping[tmp.alignmentMapping + 1][1] = tmp.atomIndex;
+          mapping.put(tmp.alignmentMapping + 1, new int[] { tmp.resNumber,
+              tmp.atomIndex });
         }
       }
 
@@ -1183,4 +1239,30 @@ public class StructureSelectionManager
     }
     return null;
   }
+
+  public IProgressIndicator getProgressIndicator()
+  {
+    return progressIndicator;
+  }
+
+  public void setProgressIndicator(IProgressIndicator progressIndicator)
+  {
+    this.progressIndicator = progressIndicator;
+  }
+
+  public long getProgressSessionId()
+  {
+    return progressSessionId;
+  }
+
+  public void setProgressSessionId(long progressSessionId)
+  {
+    this.progressSessionId = progressSessionId;
+  }
+
+  public void setProgressBar(String message)
+  {
+    progressIndicator.setProgressBar(message, progressSessionId);
+  }
+
 }