JAL-3148 show/hide features on structure independent of alignment
[jalview.git] / src / jalview / structures / models / AAStructureBindingModel.java
index 84475fe..0b19d51 100644 (file)
 package jalview.structures.models;
 
 import jalview.api.AlignmentViewPanel;
-import jalview.api.SequenceRenderer;
+import jalview.api.SequenceRendererI;
 import jalview.api.StructureSelectionManagerProvider;
 import jalview.api.structures.JalviewStructureDisplayI;
 import jalview.datamodel.AlignmentI;
-import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
+import jalview.gui.AlignmentPanel;
+import jalview.gui.SequenceRenderer;
 import jalview.io.DataSourceType;
 import jalview.schemes.ColourSchemeI;
 import jalview.structure.AtomSpec;
@@ -44,6 +46,8 @@ import java.util.Arrays;
 import java.util.BitSet;
 import java.util.List;
 
+import org.springframework.web.filter.ShallowEtagHeaderFilter;
+
 /**
  * 
  * A base class to hold common function for protein structure model binding.
@@ -53,11 +57,31 @@ import java.util.List;
  * @author gmcarstairs
  *
  */
-public abstract class AAStructureBindingModel extends
-        SequenceStructureBindingModel implements StructureListener,
-        StructureSelectionManagerProvider
+public abstract class AAStructureBindingModel
+        extends SequenceStructureBindingModel
+        implements StructureListener, StructureSelectionManagerProvider
 {
+  public enum ColourBy 
+  {
+    Sequence, Chain, ChargeAndCysteine, Jalview, Viewer 
+  }
+
+  /*
+   * selected colour menu option
+   */
+  private ColourBy colourBy = ColourBy.Sequence;
 
+  /*
+   * selected colour scheme, if a Jalview colour scheme is selected
+   */
+  private ColourSchemeI colourScheme;
+  
+  /*
+   * flag for whether to include feature colouring, if using a Jalview colour
+   * scheme (independently of whether features are shown on alignment)
+   */
+  private boolean showFeatures;
+  
   private StructureSelectionManager ssm;
 
   /*
@@ -80,9 +104,7 @@ public abstract class AAStructureBindingModel extends
    * datasource protocol for access to PDBEntrylatest
    */
   DataSourceType protocol = null;
-
-  protected boolean colourBySequence = true;
-
+  
   private boolean nucleotide;
 
   private boolean finishedInit = false;
@@ -142,7 +164,6 @@ public abstract class AAStructureBindingModel extends
    * @param ssm
    * @param pdbentry
    * @param sequenceIs
-   * @param chains
    * @param protocol
    */
   public AAStructureBindingModel(StructureSelectionManager ssm,
@@ -154,8 +175,60 @@ public abstract class AAStructureBindingModel extends
     this.nucleotide = Comparison.isNucleotide(sequenceIs);
     this.pdbEntry = pdbentry;
     this.protocol = protocol;
+    resolveChains();
   }
 
+  private boolean resolveChains()
+  {
+    /**
+     * final count of chain mappings discovered
+     */
+    int chainmaps = 0;
+    // JBPNote: JAL-2693 - this should be a list of chain mappings per
+    // [pdbentry][sequence]
+    String[][] newchains = new String[pdbEntry.length][];
+    int pe = 0;
+    for (PDBEntry pdb : pdbEntry)
+    {
+      SequenceI[] seqsForPdb = sequence[pe];
+      if (seqsForPdb != null)
+      {
+        newchains[pe] = new String[seqsForPdb.length];
+        int se = 0;
+        for (SequenceI asq : seqsForPdb)
+        {
+          String chain = (chains != null && chains[pe] != null)
+                  ? chains[pe][se]
+                  : null;
+          SequenceI sq = (asq.getDatasetSequence() == null) ? asq
+                  : asq.getDatasetSequence();
+          if (sq.getAllPDBEntries() != null)
+          {
+            for (PDBEntry pdbentry : sq.getAllPDBEntries())
+            {
+              if (pdb.getFile() != null && pdbentry.getFile() != null
+                      && pdb.getFile().equals(pdbentry.getFile()))
+              {
+                String chaincode = pdbentry.getChainCode();
+                if (chaincode != null && chaincode.length() > 0)
+                {
+                  chain = chaincode;
+                  chainmaps++;
+                  break;
+                }
+              }
+            }
+          }
+          newchains[pe][se] = chain;
+          se++;
+        }
+        pe++;
+      }
+    }
+
+    chains = newchains;
+    return chainmaps > 0;
+  }
   public StructureSelectionManager getSsm()
   {
     return ssm;
@@ -283,14 +356,19 @@ public abstract class AAStructureBindingModel extends
 
   }
 
+  public void setColourBy(ColourBy option)
+  {
+        colourBy = option;
+  }
+  
   public boolean isColourBySequence()
   {
-    return colourBySequence;
+    return colourBy == ColourBy.Sequence;
   }
-
-  public void setColourBySequence(boolean colourBySequence)
+  
+  protected boolean isJalviewColourScheme()
   {
-    this.colourBySequence = colourBySequence;
+        return colourBy == ColourBy.Jalview;
   }
 
   protected void addSequenceAndChain(int pe, SequenceI[] seq,
@@ -300,7 +378,8 @@ 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>();
@@ -532,7 +611,7 @@ public abstract class AAStructureBindingModel extends
           BitSet matched, SuperposeData[] structures)
   {
     int refStructure = -1;
-    String[] files = getPdbFile();
+    String[] files = getStructureFiles();
     if (files == null)
     {
       return -1;
@@ -638,8 +717,8 @@ public abstract class AAStructureBindingModel extends
 
     if (waiting)
     {
-      System.err
-              .println("Timed out waiting for structure viewer to load file "
+      System.err.println(
+              "Timed out waiting for structure viewer to load file "
                       + notLoaded);
       return false;
     }
@@ -657,10 +736,8 @@ public abstract class AAStructureBindingModel extends
         {
           for (SequenceI s : seqs)
           {
-            if (s == seq
-                    || (s.getDatasetSequence() != null && s
-                            .getDatasetSequence() == seq
-                            .getDatasetSequence()))
+            if (s == seq || (s.getDatasetSequence() != null
+                    && s.getDatasetSequence() == seq.getDatasetSequence()))
             {
               return true;
             }
@@ -698,9 +775,40 @@ public abstract class AAStructureBindingModel extends
     return null;
   }
 
-  public abstract void setJalviewColourScheme(ColourSchemeI cs);
+  /**
+   * Sets the selected colour scheme, possibly with reference to the given
+   * alignment view
+   * 
+   * @param cs
+   * @param ap
+   * @param showFeats
+   */
+  public void setJalviewColourScheme(ColourSchemeI cs, AlignmentViewPanel ap,
+          boolean showFeats)
+  {
+    colourBy = ColourBy.Jalview;
+    colourScheme = cs;
+    showFeatures = showFeats;
+    
+    if (!showFeats && (cs == null || cs.isSimple())) 
+    {
+      setSimpleColourScheme(cs);
+    } 
+    else
+    {
+      colourBySequence(ap, new SequenceRenderer(ap.getAlignViewport(), cs), showFeatures);
+    }
+  }
 
   /**
+   * Sets a colour scheme which is determined solely by the residue at each 
+   * position
+   * 
+   * @param cs
+   */
+  protected abstract void setSimpleColourScheme(ColourSchemeI cs);
+  
+  /**
    * Constructs and sends a command to align structures against a reference
    * structure, based on one or more sequence alignments. May optionally return
    * an error or warning message for the alignment command.
@@ -716,39 +824,40 @@ public abstract class AAStructureBindingModel extends
    *          an array of corresponding hidden columns for each alignment
    * @return
    */
-  public abstract String superposeStructures(AlignmentI[] alignments, int[] structureIndices,
-          ColumnSelection[] hiddenCols);
+  public abstract String superposeStructures(AlignmentI[] alignments,
+          int[] structureIndices, HiddenColumns[] hiddenCols);
 
   public abstract void setBackgroundColour(Color col);
 
   protected abstract StructureMappingcommandSet[] getColourBySequenceCommands(
-          String[] files, SequenceRenderer sr, AlignmentViewPanel avp);
-
-  /**
-   * returns the current sequenceRenderer that should be used to colour the
-   * structures
-   * 
-   * @param alignment
-   * 
-   * @return
-   */
-  public abstract SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment);
+          String[] files, SequenceRendererI sr, AlignmentViewPanel avp, boolean showFeatures);
 
   protected abstract void colourBySequence(
           StructureMappingcommandSet[] colourBySequenceCommands);
 
-  public abstract void colourByChain();
+  public void colourByChain()
+  {
+    colourBy = ColourBy.Chain;
+  }
 
-  public abstract void colourByCharge();
+  public void colourByCharge()
+  {
+    colourBy = ColourBy.ChargeAndCysteine;
+  }
+
+  public void colourBySequence(AlignmentViewPanel alignmentv, boolean showFeatures)
+  {
+    colourBySequence(alignmentv, alignmentv.getSequenceRenderer(), showFeatures);
+  }
 
   /**
-   * colour any structures associated with sequences in the given alignment
-   * using the getFeatureRenderer() and getSequenceRenderer() renderers but only
-   * if colourBySequence is enabled.
+   * Colours any structures associated with sequences in the given alignment view
+   * using the getFeatureRenderer() and getSequenceRenderer() renderers
    */
-  public void colourBySequence(AlignmentViewPanel alignmentv)
+  public void colourBySequence(AlignmentViewPanel alignmentv, SequenceRendererI sr, boolean showFeats)
   {
-    if (!colourBySequence || !isLoadingFinished())
+    showFeatures = showFeats;
+    if (!isLoadingFinished())
     {
       return;
     }
@@ -756,12 +865,10 @@ public abstract class AAStructureBindingModel extends
     {
       return;
     }
-    String[] files = getPdbFile();
-  
-    SequenceRenderer sr = getSequenceRenderer(alignmentv);
-  
+    String[] files = getStructureFiles();
+
     StructureMappingcommandSet[] colourBySequenceCommands = getColourBySequenceCommands(
-            files, sr, alignmentv);
+            files, sr, alignmentv, showFeatures);
     colourBySequence(colourBySequenceCommands);
   }
 
@@ -772,4 +879,44 @@ public abstract class AAStructureBindingModel extends
 
   public abstract jalview.api.FeatureRenderer getFeatureRenderer(
           AlignmentViewPanel alignment);
+
+@Override
+public void updateColours(Object source) {
+    AlignmentPanel ap = (AlignmentPanel) source;
+    
+    /*
+     * ignore events from panels not used to colour this view
+     */
+    if (!getViewer().isUsedForColourBy(ap))
+    {
+      return;
+    }
+    
+    /*
+     * no need to update colours if structure colouring is not
+     * viewport dependent
+     */
+    if (!isColourBySequence() && !isJalviewColourScheme())
+    {
+      return;
+    }
+    if (!showFeatures && (colourScheme == null || colourScheme.isSimple()))
+    {
+      return;
+    }
+    
+    if (!isLoadingFromArchive())
+    {
+      if (isColourBySequence())
+      {
+        colourBySequence(ap, new SequenceRenderer(ap.getAlignViewport()), 
+                showFeatures);
+      } 
+      else
+      {
+        colourBySequence(ap, new SequenceRenderer(ap.getAlignViewport(), 
+                colourScheme), showFeatures);
+      }
+    }
+  }
 }