JAL-845 linked protein/dna 'slave' further PoC functionality
[jalview.git] / src / jalview / viewmodel / AlignmentViewport.java
index 617800b..ed63e0f 100644 (file)
@@ -20,7 +20,6 @@
  */
 package jalview.viewmodel;
 
-import jalview.analysis.AAFrequency;
 import jalview.analysis.Conservation;
 import jalview.api.AlignCalcManagerI;
 import jalview.api.AlignViewportI;
@@ -35,7 +34,6 @@ import jalview.datamodel.SequenceCollectionI;
 import jalview.datamodel.SequenceGroup;
 import jalview.datamodel.SequenceI;
 import jalview.schemes.Blosum62ColourScheme;
-import jalview.schemes.ClustalxColourScheme;
 import jalview.schemes.ColourSchemeI;
 import jalview.schemes.PIDColourScheme;
 import jalview.schemes.ResidueProperties;
@@ -46,6 +44,7 @@ import jalview.workers.StrucConsensusThread;
 import java.awt.Color;
 import java.util.ArrayList;
 import java.util.BitSet;
+import java.util.HashMap;
 import java.util.Hashtable;
 import java.util.List;
 import java.util.Map;
@@ -60,6 +59,11 @@ import java.util.Vector;
  */
 public abstract class AlignmentViewport implements AlignViewportI
 {
+  /*
+   * A viewport that is a slave of (driven by) this one in some sense.
+   */
+  AlignViewportI slave = null;
+
   /**
    * alignment displayed in the viewport. Please use get/setter
    */
@@ -214,15 +218,18 @@ public abstract class AlignmentViewport implements AlignViewportI
     // calculation till later or to do all calculations in thread.
     // via changecolour
     globalColourScheme = cs;
-    boolean recalc=false;
-    if (cs!=null)
+    boolean recalc = false;
+    if (cs != null)
     {
       cs.setConservationApplied(recalc = getConservationSelected());
-      if (getAbovePIDThreshold() || cs instanceof PIDColourScheme || cs instanceof Blosum62ColourScheme)
+      if (getAbovePIDThreshold() || cs instanceof PIDColourScheme
+              || cs instanceof Blosum62ColourScheme)
       {
         recalc = true;
         cs.setThreshold(threshold, ignoreGapsInConsensusCalculation);
-      } else {
+      }
+      else
+      {
         cs.setThreshold(0, ignoreGapsInConsensusCalculation);
       }
       if (recalc)
@@ -247,7 +254,7 @@ public abstract class AlignmentViewport implements AlignViewportI
                 || cs instanceof Blosum62ColourScheme)
         {
           sg.cs.setThreshold(threshold, getIgnoreGapsConsensus());
-          recalc=true;
+          recalc = true;
         }
         else
         {
@@ -257,16 +264,19 @@ public abstract class AlignmentViewport implements AlignViewportI
         if (getConservationSelected())
         {
           sg.cs.setConservationApplied(true);
-          recalc=true;
+          recalc = true;
         }
         else
         {
           sg.cs.setConservation(null);
           // sg.cs.setThreshold(0, getIgnoreGapsConsensus());
         }
-        if (recalc) {
+        if (recalc)
+        {
           sg.recalcConservation();
-        } else {
+        }
+        else
+        {
           sg.cs.alignmentChanged(sg, hiddenRepSequences);
         }
       }
@@ -302,13 +312,15 @@ public abstract class AlignmentViewport implements AlignViewportI
    * view
    */
   protected Hashtable[] hStrucConsensus = null;
-  
+
   protected Conservation hconservation = null;
+
   @Override
   public void setConservation(Conservation cons)
   {
     hconservation = cons;
   }
+
   /**
    * percentage gaps allowed in a column before all amino acid properties should
    * be considered unconserved
@@ -439,7 +451,9 @@ public abstract class AlignmentViewport implements AlignViewportI
           AlignmentAnnotation alignmentAnnotation)
   {
     if (!alignmentAnnotation.autoCalculated)
+    {
       return false;
+    }
     if (calculator.workingInvolvedWith(alignmentAnnotation))
     {
       // System.err.println("grey out ("+alignmentAnnotation.label+")");
@@ -795,7 +809,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   protected boolean showConsensus = true;
 
-  Hashtable sequenceColours;
+  private Map<SequenceI, Color> sequenceColours = new HashMap<SequenceI, Color>();
 
   /**
    * Property change listener for changes in alignment
@@ -891,11 +905,12 @@ public abstract class AlignmentViewport implements AlignViewportI
         selectionGroup = new SequenceGroup();
         selectionGroup.setEndRes(alignment.getWidth() - 1);
       }
-      Vector tmp = alignment.getHiddenSequences().showAll(
+      List<SequenceI> tmp = alignment.getHiddenSequences().showAll(
               hiddenRepSequences);
-      for (int t = 0; t < tmp.size(); t++)
+      for (SequenceI seq : tmp)
       {
-        selectionGroup.addSequence((SequenceI) tmp.elementAt(t), false);
+        selectionGroup.addSequence(seq, false);
+        setSequenceAnnotationsVisible(seq, true);
       }
 
       hasHiddenRows = false;
@@ -910,7 +925,8 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   public void showSequence(int index)
   {
-    Vector tmp = alignment.getHiddenSequences().showSequence(index,
+    List<SequenceI> tmp = alignment.getHiddenSequences().showSequence(
+            index,
             hiddenRepSequences);
     if (tmp.size() > 0)
     {
@@ -920,9 +936,10 @@ public abstract class AlignmentViewport implements AlignViewportI
         selectionGroup.setEndRes(alignment.getWidth() - 1);
       }
 
-      for (int t = 0; t < tmp.size(); t++)
+      for (SequenceI seq : tmp)
       {
-        selectionGroup.addSequence((SequenceI) tmp.elementAt(t), false);
+        selectionGroup.addSequence(seq, false);
+        setSequenceAnnotationsVisible(seq, true);
       }
       // JBPNote: refactor: only update flag if we modified visiblity (used to
       // do this regardless)
@@ -956,12 +973,30 @@ public abstract class AlignmentViewport implements AlignViewportI
       for (int i = 0; i < seq.length; i++)
       {
         alignment.getHiddenSequences().hideSequence(seq[i]);
+        setSequenceAnnotationsVisible(seq[i], false);
       }
       hasHiddenRows = true;
       firePropertyChange("alignment", null, alignment.getSequences());
     }
   }
 
+  /**
+   * Set visibility for any annotations for the given sequence.
+   * 
+   * @param sequenceI
+   */
+  protected void setSequenceAnnotationsVisible(SequenceI sequenceI,
+          boolean visible)
+  {
+    for (AlignmentAnnotation ann : alignment.getAlignmentAnnotation())
+    {
+      if (ann.sequenceRef == sequenceI)
+      {
+        ann.visible = visible;
+      }
+    }
+  }
+
   public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
   {
     int sSize = sg.getSize();
@@ -1235,6 +1270,28 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   }
 
+  @Override
+  public List<AlignmentAnnotation> getVisibleAlignmentAnnotation(boolean selectedOnly)
+  {
+    ArrayList<AlignmentAnnotation> ala = new ArrayList<AlignmentAnnotation>();
+    AlignmentAnnotation[] aa;
+    if ((aa=alignment.getAlignmentAnnotation())!=null)
+    {
+      for (AlignmentAnnotation annot:aa)
+      {
+        AlignmentAnnotation clone = new AlignmentAnnotation(annot);
+        if (selectedOnly && selectionGroup!=null)
+        {
+          colSel.makeVisibleAnnotation(selectionGroup.getStartRes(), selectionGroup.getEndRes(),clone);
+        } else {
+          colSel.makeVisibleAnnotation(clone);
+        }
+        ala.add(clone);
+      }
+    }
+    return ala;
+  }
+
   /**
    * @return the padGaps
    */
@@ -1373,15 +1430,15 @@ public abstract class AlignmentViewport implements AlignViewportI
       {
         conservation = new AlignmentAnnotation("Conservation",
                 "Conservation of total alignment less than "
-                        + getConsPercGaps() + "% gaps",
-                new Annotation[1], 0f, 11f,
-                AlignmentAnnotation.BAR_GRAPH);
+                        + getConsPercGaps() + "% gaps", new Annotation[1],
+                0f, 11f, AlignmentAnnotation.BAR_GRAPH);
         conservation.hasText = true;
         conservation.autoCalculated = true;
         alignment.addAnnotation(conservation);
       }
     }
   }
+
   private void initQuality()
   {
     if (showQuality)
@@ -1390,21 +1447,20 @@ public abstract class AlignmentViewport implements AlignViewportI
       {
         quality = new AlignmentAnnotation("Quality",
                 "Alignment Quality based on Blosum62 scores",
-                new Annotation[1], 0f, 11f,
-                AlignmentAnnotation.BAR_GRAPH);
+                new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
         quality.hasText = true;
         quality.autoCalculated = true;
         alignment.addAnnotation(quality);
       }
     }
   }
+
   private void initRNAStructure()
   {
-    if (alignment.hasRNAStructure() && strucConsensus==null)
+    if (alignment.hasRNAStructure() && strucConsensus == null)
     {
       strucConsensus = new AlignmentAnnotation("StrucConsensus", "PID",
-              new Annotation[1], 0f, 100f,
-              AlignmentAnnotation.BAR_GRAPH);
+              new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
       strucConsensus.hasText = true;
       strucConsensus.autoCalculated = true;
 
@@ -1414,6 +1470,7 @@ public abstract class AlignmentViewport implements AlignViewportI
       }
     }
   }
+
   /*
    * (non-Javadoc)
    * 
@@ -1514,7 +1571,7 @@ public abstract class AlignmentViewport implements AlignViewportI
         if (aan[an].autoCalculated && aan[an].groupRef != null)
         {
           oldrfs.add(aan[an].groupRef);
-          alignment.deleteAnnotation(aan[an],false);
+          alignment.deleteAnnotation(aan[an], false);
         }
       }
     }
@@ -1554,25 +1611,13 @@ public abstract class AlignmentViewport implements AlignViewportI
   @Override
   public Color getSequenceColour(SequenceI seq)
   {
-    Color sqc=Color.white;
-    if (sequenceColours != null)
-    {
-      sqc = (Color) sequenceColours.get(seq);
-      if (sqc == null) {
-        sqc = Color.white;
-      }
-    }
-    return sqc;
+    Color sqc = sequenceColours.get(seq);
+    return (sqc == null ? Color.white : sqc);
   }
 
   @Override
   public void setSequenceColour(SequenceI seq, Color col)
   {
-    if (sequenceColours == null)
-    {
-      sequenceColours = new Hashtable();
-    }
-
     if (col == null)
     {
       sequenceColours.remove(seq);
@@ -1586,10 +1631,6 @@ public abstract class AlignmentViewport implements AlignViewportI
   @Override
   public void updateSequenceIdColours()
   {
-    if (sequenceColours == null)
-    {
-      sequenceColours = new Hashtable();
-    }
     for (SequenceGroup sg : alignment.getGroups())
     {
       if (sg.idColour != null)
@@ -1605,6 +1646,25 @@ public abstract class AlignmentViewport implements AlignViewportI
   @Override
   public void clearSequenceColours()
   {
-    sequenceColours = null;
+    sequenceColours.clear();
   };
+
+  @Override
+  public AlignViewportI getSlave()
+  {
+    return this.slave;
+  }
+
+  @Override
+  public void setSlave(AlignViewportI sl)
+  {
+    if (this == sl.getSlave())
+    {
+      System.err.println("Ignoring recursive setSlave request");
+    }
+    else
+    {
+      this.slave = sl;
+    }
+  }
 }