X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructures%2Fmodels%2FAAStructureBindingModel.java;h=70fe60964640d9d5aad37b259ac9e43d8002cf45;hb=ee198b3ca3687f18a2ee186f4e7c7330f4ea30f0;hp=664c903d944e308de5f8238ddf471acb5217943c;hpb=0c5e8f8ba81b913c63b60d7670d66aca661ea4f5;p=jalview.git

diff --git a/src/jalview/structures/models/AAStructureBindingModel.java b/src/jalview/structures/models/AAStructureBindingModel.java
index 664c903..70fe609 100644
--- a/src/jalview/structures/models/AAStructureBindingModel.java
+++ b/src/jalview/structures/models/AAStructureBindingModel.java
@@ -1,17 +1,43 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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.
+ *  
+ * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.structures.models;
 
 import jalview.api.StructureSelectionManagerProvider;
+import jalview.datamodel.AlignmentI;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
+import jalview.io.DataSourceType;
+import jalview.structure.AtomSpec;
 import jalview.structure.StructureListener;
+import jalview.structure.StructureMapping;
 import jalview.structure.StructureSelectionManager;
+import jalview.util.Comparison;
 import jalview.util.MessageManager;
 
-import java.awt.event.ComponentEvent;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 /**
+ * 
  * A base class to hold common function for protein structure model binding.
  * Initial version created by refactoring JMol and Chimera binding models, but
  * other structure viewers could in principle be accommodated in future.
@@ -41,10 +67,43 @@ public abstract class AAStructureBindingModel extends
   /*
    * datasource protocol for access to PDBEntrylatest
    */
-  String protocol = null;
+  DataSourceType protocol = null;
 
   protected boolean colourBySequence = true;
 
+  private boolean nucleotide;
+
+  private boolean finishedInit = false;
+
+  /**
+   * Data bean class to simplify parameterisation in superposeStructures
+   */
+  protected class SuperposeData
+  {
+    /**
+     * Constructor with alignment width argument
+     * 
+     * @param width
+     */
+    public SuperposeData(int width)
+    {
+      pdbResNo = new int[width];
+    }
+
+    public String filename;
+
+    public String pdbId;
+
+    public String chain = "";
+
+    public boolean isRna;
+
+    /*
+     * The pdb residue number (if any) mapped to each column of the alignment
+     */
+    public int[] pdbResNo;
+  }
+
   /**
    * Constructor
    * 
@@ -65,17 +124,18 @@ public abstract class AAStructureBindingModel extends
    * @param pdbentry
    * @param sequenceIs
    * @param chains
-   * @param protocol
+   * @param protocol2
    */
   public AAStructureBindingModel(StructureSelectionManager ssm,
           PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String[][] chains,
-          String protocol)
+          DataSourceType protocol2)
   {
     this.ssm = ssm;
     this.sequence = sequenceIs;
+    this.nucleotide = Comparison.isNucleotide(sequenceIs);
     this.chains = chains;
     this.pdbEntry = pdbentry;
-    this.protocol = protocol;
+    this.protocol = protocol2;
     if (chains == null)
     {
       this.chains = new String[pdbentry.length][];
@@ -99,6 +159,27 @@ public abstract class AAStructureBindingModel extends
   }
 
   /**
+   * Answers true if this binding includes the given PDB id, else false
+   * 
+   * @param pdbId
+   * @return
+   */
+  public boolean hasPdbId(String pdbId)
+  {
+    if (pdbEntry != null)
+    {
+      for (PDBEntry pdb : pdbEntry)
+      {
+        if (pdb.getId().equals(pdbId))
+        {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  /**
    * Returns the number of modelled PDB file entries.
    * 
    * @return
@@ -118,7 +199,7 @@ public abstract class AAStructureBindingModel extends
     return chains;
   }
 
-  public String getProtocol()
+  public DataSourceType getProtocol()
   {
     return protocol;
   }
@@ -142,7 +223,9 @@ public abstract class AAStructureBindingModel extends
   /**
    * Construct a title string for the viewer window based on the data Jalview
    * knows about
-   * @param viewerName TODO
+   * 
+   * @param viewerName
+   *          TODO
    * @param verbose
    * 
    * @return
@@ -150,8 +233,7 @@ public abstract class AAStructureBindingModel extends
   public String getViewerTitle(String viewerName, boolean verbose)
   {
     if (getSequence() == null || getSequence().length < 1
-            || getPdbCount() < 1
-            || getSequence()[0].length < 1)
+            || getPdbCount() < 1 || getSequence()[0].length < 1)
     {
       return ("Jalview " + viewerName + " Window");
     }
@@ -160,9 +242,8 @@ public abstract class AAStructureBindingModel extends
     StringBuilder title = new StringBuilder(64);
     final PDBEntry pdbEntry = getPdbEntry(0);
     title.append(viewerName + " view for " + getSequence()[0][0].getName()
-            + ":"
-            + pdbEntry.getId());
-  
+            + ":" + pdbEntry.getId());
+
     if (verbose)
     {
       if (pdbEntry.getProperty() != null)
@@ -208,8 +289,7 @@ public abstract class AAStructureBindingModel extends
     {
       throw new Error(MessageManager.formatMessage(
               "error.implementation_error_no_pdbentry_from_index",
-              new Object[]
-              { Integer.valueOf(pe).toString() }));
+              new Object[] { Integer.valueOf(pe).toString() }));
     }
     final String nullChain = "TheNullChain";
     List<SequenceI> s = new ArrayList<SequenceI>();
@@ -279,8 +359,8 @@ public abstract class AAStructureBindingModel extends
    * 
    * @returns the pdb entries added to the current set.
    */
-  public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe, SequenceI[][] seq,
-          String[][] chns)
+  public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe,
+          SequenceI[][] seq, String[][] chns)
   {
     List<PDBEntry> v = new ArrayList<PDBEntry>();
     List<int[]> rtn = new ArrayList<int[]>();
@@ -293,8 +373,7 @@ public abstract class AAStructureBindingModel extends
       int r = v.indexOf(pdbe[i]);
       if (r == -1 || r >= getPdbCount())
       {
-        rtn.add(new int[]
-        { v.size(), i });
+        rtn.add(new int[] { v.size(), i });
         v.add(pdbe[i]);
       }
       else
@@ -361,4 +440,225 @@ public abstract class AAStructureBindingModel extends
     }
   }
 
-}
\ No newline at end of file
+  @Override
+  public abstract void highlightAtoms(List<AtomSpec> atoms);
+
+  protected boolean isNucleotide()
+  {
+    return this.nucleotide;
+  }
+
+  /**
+   * Returns a readable description of all mappings for the wrapped pdbfile to
+   * any mapped sequences
+   * 
+   * @param pdbfile
+   * @param seqs
+   * @return
+   */
+  public String printMappings()
+  {
+    if (pdbEntry == null)
+    {
+      return "";
+    }
+    StringBuilder sb = new StringBuilder(128);
+    for (int pdbe = 0; pdbe < getPdbCount(); pdbe++)
+    {
+      String pdbfile = getPdbEntry(pdbe).getFile();
+      List<SequenceI> seqs = Arrays.asList(getSequence()[pdbe]);
+      sb.append(getSsm().printMappings(pdbfile, seqs));
+    }
+    return sb.toString();
+  }
+
+  /**
+   * Returns the mapped structure position for a given aligned column of a given
+   * sequence, or -1 if the column is gapped, beyond the end of the sequence, or
+   * not mapped to structure.
+   * 
+   * @param seq
+   * @param alignedPos
+   * @param mapping
+   * @return
+   */
+  protected int getMappedPosition(SequenceI seq, int alignedPos,
+          StructureMapping mapping)
+  {
+    if (alignedPos >= seq.getLength())
+    {
+      return -1;
+    }
+
+    if (Comparison.isGap(seq.getCharAt(alignedPos)))
+    {
+      return -1;
+    }
+    int seqPos = seq.findPosition(alignedPos);
+    int pos = mapping.getPDBResNum(seqPos);
+    return pos;
+  }
+
+  /**
+   * Helper method to identify residues that can participate in a structure
+   * superposition command. For each structure, identify a sequence in the
+   * alignment which is mapped to the structure. Identify non-gapped columns in
+   * the sequence which have a mapping to a residue in the structure. Returns
+   * the index of the first structure that has a mapping to the alignment.
+   * 
+   * @param alignment
+   *          the sequence alignment which is the basis of structure
+   *          superposition
+   * @param matched
+   *          an array of booleans, indexed by alignment column, where true
+   *          indicates that every structure has a mapped residue present in the
+   *          column (so the column can participate in structure alignment)
+   * @param structures
+   *          an array of data beans corresponding to pdb file index
+   * @return
+   */
+  protected int findSuperposableResidues(AlignmentI alignment,
+          boolean[] matched, SuperposeData[] structures)
+  {
+    int refStructure = -1;
+    String[] files = getPdbFile();
+    for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
+    {
+      StructureMapping[] mappings = getSsm().getMapping(files[pdbfnum]);
+      int lastPos = -1;
+
+      /*
+       * Find the first mapped sequence (if any) for this PDB entry which is in
+       * the alignment
+       */
+      final int seqCountForPdbFile = getSequence()[pdbfnum].length;
+      for (int s = 0; s < seqCountForPdbFile; s++)
+      {
+        for (StructureMapping mapping : mappings)
+        {
+          final SequenceI theSequence = getSequence()[pdbfnum][s];
+          if (mapping.getSequence() == theSequence
+                  && alignment.findIndex(theSequence) > -1)
+          {
+            if (refStructure < 0)
+            {
+              refStructure = pdbfnum;
+            }
+            for (int r = 0; r < matched.length; r++)
+            {
+              if (!matched[r])
+              {
+                continue;
+              }
+              int pos = getMappedPosition(theSequence, r, mapping);
+              if (pos < 1 || pos == lastPos)
+              {
+                matched[r] = false;
+                continue;
+              }
+              lastPos = pos;
+              structures[pdbfnum].pdbResNo[r] = pos;
+            }
+            String chain = mapping.getChain();
+            if (chain != null && chain.trim().length() > 0)
+            {
+              structures[pdbfnum].chain = chain;
+            }
+            structures[pdbfnum].pdbId = mapping.getPdbId();
+            structures[pdbfnum].isRna = theSequence.getRNA() != null;
+            // move on to next pdb file
+            s = seqCountForPdbFile;
+            break;
+          }
+        }
+      }
+    }
+    return refStructure;
+  }
+
+  /**
+   * Returns true if the structure viewer has loaded all of the files of
+   * interest (identified by the file mapping having been set up), or false if
+   * any are still not loaded after a timeout interval.
+   * 
+   * @param files
+   */
+  protected boolean waitForFileLoad(String[] files)
+  {
+    /*
+     * give up after 10 secs plus 1 sec per file
+     */
+    long starttime = System.currentTimeMillis();
+    long endTime = 10000 + 1000 * files.length + starttime;
+    String notLoaded = null;
+
+    boolean waiting = true;
+    while (waiting && System.currentTimeMillis() < endTime)
+    {
+      waiting = false;
+      for (String file : files)
+      {
+        notLoaded = file;
+        if (file == null)
+        {
+          continue;
+        }
+        try
+        {
+          StructureMapping[] sm = getSsm().getMapping(file);
+          if (sm == null || sm.length == 0)
+          {
+            waiting = true;
+          }
+        } catch (Throwable x)
+        {
+          waiting = true;
+        }
+      }
+    }
+
+    if (waiting)
+    {
+      System.err
+              .println("Timed out waiting for structure viewer to load file "
+                      + notLoaded);
+      return false;
+    }
+    return true;
+  }
+
+  @Override
+  public boolean isListeningFor(SequenceI seq)
+  {
+    if (sequence != null)
+    {
+      for (SequenceI[] seqs : sequence)
+      {
+        if (seqs != null)
+        {
+          for (SequenceI s : seqs)
+          {
+            if (s == seq
+                    || (s.getDatasetSequence() != null && s
+                            .getDatasetSequence() == seq
+                            .getDatasetSequence()))
+            {
+              return true;
+            }
+          }
+        }
+      }
+    }
+    return false;
+  }
+
+  public boolean isFinishedInit()
+  {
+    return finishedInit;
+  }
+
+  public void setFinishedInit(boolean fi)
+  {
+    this.finishedInit = fi;
+  }
+}