GPL license added
[jalview.git] / src / jalview / gui / AlignViewport.java
index 0c9be38..1f5ec79 100755 (executable)
@@ -1,11 +1,31 @@
+/*\r
+* Jalview - A Sequence Alignment Editor and Viewer\r
+* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+*\r
+* This program is free software; you can redistribute it and/or\r
+* modify it under the terms of the GNU General Public License\r
+* as published by the Free Software Foundation; either version 2\r
+* of the License, or (at your option) any later version.\r
+*\r
+* This program is distributed in the hope that it will be useful,\r
+* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+* GNU General Public License for more details.\r
+*\r
+* You should have received a copy of the GNU General Public License\r
+* along with this program; if not, write to the Free Software\r
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+*/\r
+\r
 package jalview.gui;\r
 \r
 import java.awt.*;\r
-import jalview.io.*;\r
+import jalview.analysis.*;\r
 import jalview.analysis.NJTree;\r
 import jalview.datamodel.*;\r
 import jalview.schemes.*;\r
 import java.util.*;\r
+import jalview.bin.Cache;\r
 \r
 public class AlignViewport\r
 {\r
@@ -22,6 +42,10 @@ public class AlignViewport
   boolean wrapAlignment=false;\r
   boolean renderGaps = true;\r
   boolean showSequenceFeatures = false;\r
+  boolean showAnnotation = true;\r
+  boolean showConservation = true;\r
+  boolean showQuality = true;\r
+  boolean showIdentity = true;\r
 \r
   boolean colourAppliesToAllGroups = true;\r
   ColourSchemeI globalColourScheme = null;\r
@@ -30,7 +54,6 @@ public class AlignViewport
 \r
   SequenceGroup selectionGroup = new SequenceGroup();\r
 \r
-  RendererI renderer = new SequenceRenderer(this);\r
 \r
   int             charHeight;\r
   int             charWidth;\r
@@ -42,41 +65,68 @@ public class AlignViewport
 \r
   ColumnSelection colSel = new ColumnSelection();\r
 \r
-  String visibleConsensus;\r
-\r
   int threshold;\r
   int increment;\r
 \r
   NJTree currentTree = null;\r
 \r
+  boolean scaleAboveWrapped = false;\r
+  boolean scaleLeftWrapped  = true;\r
+  boolean scaleRightWrapped = true;\r
 \r
-  public AlignViewport(AlignmentI da,\r
-                       boolean showText,\r
-                       boolean showBoxes,\r
-                       boolean wrapAlignment) {\r
-    this(0,da.getWidth()-1,0,da.getHeight()-1,\r
-         showText,\r
-         showBoxes,\r
-         wrapAlignment);\r
 \r
-    setAlignment(da);\r
+  public AlignViewport(AlignmentI al)\r
+  {\r
+    setAlignment(al);\r
+    this.startRes = 0;\r
+    this.endRes = al.getWidth()-1;\r
+    this.startSeq = 0;\r
+    this.endSeq = al.getHeight()-1;\r
+\r
+    updateFromPreferences();\r
+\r
   }\r
 \r
-  public AlignViewport(int startRes, int endRes,\r
-                       int startSeq, int endSeq,\r
-                       boolean showText,\r
-                       boolean showBoxes,\r
-                       boolean wrapAlignment) {\r
+  public void updateFromPreferences()\r
+  {\r
+    showFullId = Preferences.showFullId;\r
+    showAnnotation = Preferences.showAnnotation;\r
+    showConservation = Preferences.showConservation;\r
+    showQuality = Preferences.showQuality;\r
+    showIdentity = Preferences.showIdentity;\r
+    showFullId = Preferences.showFullId;\r
+    String fontName = Preferences.fontName;\r
+    String fontStyle = Preferences.fontStyle;\r
+    String fontSize = Cache.getProperty("FONT_SIZE");\r
+    if (fontName != null && fontStyle != null && fontSize != null)\r
+    {\r
+      int style = 0;\r
+      if(fontStyle.equals("bold"))\r
+        style = 1;\r
+      else if(fontStyle.equals("italic"))\r
+        style = 2;\r
+      setFont(new Font(fontName, style, Integer.parseInt(fontSize)));\r
+    }\r
+    else\r
+      setFont(font);\r
+\r
+    alignment.setGapCharacter(Preferences.gapSymbol);\r
 \r
-    this.startRes = startRes;\r
-    this.endRes   = endRes;\r
-    this.startSeq = startSeq;\r
-    this.endSeq   = endSeq;\r
-    this.showText      = showText;\r
-    this.showBoxes     = showBoxes;\r
-    this.wrapAlignment = wrapAlignment;\r
+    // We must set conservation and consensus before setting colour,\r
+    // as Blosum and Clustal require this to be done\r
+    updateConservation();\r
+    updateConsensus();\r
+    if(Preferences.defaultColour!=null)\r
+    {\r
+      globalColourScheme = ColourSchemeProperty.getColour(alignment, Preferences.defaultColour);\r
+      if(globalColourScheme instanceof UserColourScheme)\r
+      {\r
+        globalColourScheme = UserDefinedColours.loadDefaultColours();\r
+      }\r
+      if(globalColourScheme!=null)\r
+        globalColourScheme.setConsensus( vconsensus );\r
+   }\r
 \r
-    setFont( font );\r
  }\r
 \r
  public void showSequenceFeatures(boolean b)\r
@@ -84,31 +134,141 @@ public class AlignViewport
    showSequenceFeatures = b;\r
  }\r
 \r
-  public String getVisibleConsensus()\r
+  public Vector vconsensus;\r
+  AlignmentAnnotation consensus;\r
+  AlignmentAnnotation conservation;\r
+  AlignmentAnnotation quality;\r
+\r
+  public int ConsPercGaps = 25; // JBPNote : This should be a scalable property!\r
+\r
+  public void updateConservation()\r
   {\r
-    return visibleConsensus;\r
+    Conservation cons = new jalview.analysis.Conservation("All",\r
+        jalview.schemes.ResidueProperties.propHash, 3,\r
+        alignment.getSequences(), 0,\r
+        alignment.getWidth()-1);\r
+    cons.calculate();\r
+    cons.verdict(false, ConsPercGaps);\r
+    cons.findQuality();\r
+    int alWidth = alignment.getWidth();\r
+    Annotation [] annotations = new Annotation[alWidth];\r
+    Annotation [] qannotations = new Annotation[alWidth];\r
+    String sequence = cons.getConsSequence().getSequence();\r
+    float minR,minG,minB, maxR,maxG,maxB;\r
+    minR = 0.3f;\r
+    minG = 0.0f;\r
+    minB = 0f;\r
+    maxR = 1.0f-minR; maxG=0.9f-minG; maxB=0f-minB; // scalable range for colouring both Conservation and Quality\r
+    float min = 0f;\r
+    float max = 11f;\r
+    float qmin = cons.qualityRange[0].floatValue();\r
+    float qmax = cons.qualityRange[1].floatValue();\r
+\r
+    for (int i = 0; i < alWidth; i++)\r
+    {\r
+      float value = 0;\r
+      try\r
+        {\r
+          value = Integer.parseInt(sequence.charAt(i) + "");\r
+        }\r
+      catch (Exception ex)\r
+        {\r
+          if (sequence.charAt(i) == '*') value = 11;\r
+          if (sequence.charAt(i) == '+') value = 10;\r
+        }\r
+      float vprop = value-min;\r
+      vprop/=max;\r
+      annotations[i] = new Annotation(sequence.charAt(i) + "",\r
+                                      "", ' ', value, new Color(minR+maxR*vprop, minG+maxG*vprop, minB+maxB*vprop));\r
+      // Quality calc\r
+      value = ((Double) cons.quality.get(i)).floatValue();\r
+      vprop = value - qmin;\r
+      vprop/=qmax;\r
+      qannotations[i] = new Annotation(" ",\r
+                                      String.valueOf(value), ' ', value, new Color(minR+maxR*vprop, minG+maxG*vprop, minB+maxB*vprop));\r
+    }\r
+\r
+    if(conservation==null)\r
+    {\r
+      conservation = new AlignmentAnnotation("Conservation",\r
+                                             "Conservation of total alignment less than "+ConsPercGaps+"% gaps",\r
+                                             annotations,\r
+                                             0f, // cons.qualityRange[0].floatValue(),\r
+                                             11f, // cons.qualityRange[1].floatValue()\r
+                                             1);\r
+      if(showConservation)\r
+      alignment.addAnnotation(conservation);\r
+      quality = new AlignmentAnnotation("Quality",\r
+                                        "Alignment Quality based on Blosum62 scores",\r
+                                        qannotations,\r
+                                        cons.qualityRange[0].floatValue(),\r
+                                        cons.qualityRange[1].floatValue(),\r
+                                        1);\r
+      if(showQuality)\r
+        alignment.addAnnotation(quality);\r
+    }\r
+    else {\r
+      conservation.annotations = annotations;\r
+      quality.annotations = qannotations;\r
+      quality.graphMax = cons.qualityRange[1].floatValue();\r
+    }\r
+\r
+\r
   }\r
 \r
-  Vector consensus = new Vector();\r
-  public Vector getConsensus(boolean recalculate)\r
+  public void updateConsensus()\r
   {\r
-    if(recalculate || consensus.size()<1)\r
+    Annotation [] annotations = new Annotation[alignment.getWidth()];\r
+\r
+    // this routine prevents vconsensus becoming a new object each time\r
+    // consenus is calculated. Important for speed of Blosum62\r
+    // and PID colouring of alignment\r
+    if(vconsensus == null)\r
+        vconsensus = alignment.getAAFrequency();\r
+    else\r
     {\r
-      consensus = alignment.getAAFrequency();\r
-      StringBuffer sb = new StringBuffer();\r
-      Hashtable hash = null;\r
-      for (int i = 0; i < consensus.size(); i++)\r
-      {\r
-        hash = (Hashtable) consensus.elementAt(i);\r
-        sb.append(hash.get("maxResidue").toString().charAt(0));\r
-      }\r
-      visibleConsensus = sb.toString();\r
+        Vector temp = alignment.getAAFrequency();\r
+        vconsensus.clear();\r
+        Enumeration e = temp.elements();\r
+        while(e.hasMoreElements())\r
+        {\r
+          vconsensus.add(e.nextElement());\r
+        }\r
     }\r
+    Hashtable hash = null;\r
+    for (int i = 0; i<alignment.getWidth(); i++)\r
+    {\r
+        hash = (Hashtable) vconsensus.elementAt(i);\r
+        float value = Float.parseFloat(hash.get("maxCount").toString());\r
+        value /= Float.parseFloat(hash.get("size").toString());\r
+\r
+        value *= 100;\r
+        String maxRes = hash.get("maxResidue")+" ";\r
+        String mouseOver = hash.get("maxResidue")+" ";\r
+        if(maxRes.length()>2)\r
+        {\r
+          mouseOver = "["+maxRes+"] ";\r
+          maxRes = "+ ";\r
+        }\r
 \r
+        mouseOver += (int)value+"%";\r
+        annotations[i] = new Annotation(maxRes, mouseOver, ' ', value);\r
+\r
+    }\r
+\r
+     if(consensus==null)\r
+     {\r
+       consensus = new AlignmentAnnotation("Consensus",\r
+                                           "PID", annotations, 0f, 100f, 1);\r
+       if(showIdentity)\r
+         alignment.addAnnotation(consensus);\r
+     }\r
+     else\r
+       consensus.annotations = annotations;\r
 \r
-    return consensus;\r
   }\r
 \r
+\r
   public SequenceGroup getSelectionGroup()\r
   {\r
     return selectionGroup;\r
@@ -171,8 +331,8 @@ public class AlignViewport
   }\r
   public void setEndRes(int res) {\r
     if (res > alignment.getWidth()-1) {\r
-      System.out.println(" Corrected res from " + res + " to maximum " + (alignment.getWidth()-1));\r
-       res = alignment.getWidth() -1;\r
+      // log.System.out.println(" Corrected res from " + res + " to maximum " + (alignment.getWidth()-1));\r
+       res = alignment.getWidth()-1;\r
     }\r
     if (res < 0) {\r
       res = 0;\r
@@ -244,11 +404,6 @@ public class AlignViewport
 \r
   public void setRenderGaps(boolean state){\r
     renderGaps = state;\r
-    if(renderer instanceof SequenceRenderer)\r
-    {\r
-      SequenceRenderer sr = (SequenceRenderer)renderer;\r
-      sr.renderGaps(state);\r
-    }\r
   }\r
 \r
 \r
@@ -321,7 +476,6 @@ public class AlignViewport
   }\r
 \r
   public void resetSeqLimits(int height) {\r
-    setStartSeq(0);\r
     setEndSeq(height/getCharHeight());\r
   }\r
   public void setCurrentTree(NJTree tree) {\r
@@ -331,14 +485,6 @@ public class AlignViewport
     return currentTree;\r
   }\r
 \r
-    public void setRenderer(RendererI rend) {\r
-       this.renderer = rend;\r
-    }\r
-\r
-    public RendererI getRenderer() {\r
-       return renderer;\r
-    }\r
-\r
   public void setColourAppliesToAllGroups(boolean b)\r
   {   colourAppliesToAllGroups = b; }\r
 \r
@@ -354,4 +500,40 @@ public class AlignViewport
   {\r
     showFullId = b;\r
   }\r
+\r
+  public boolean getShowAnnotation()\r
+  {   return showAnnotation;  }\r
+\r
+  public void setShowAnnotation(boolean b)\r
+  {    showAnnotation = b;  }\r
+\r
+  public boolean getScaleAboveWrapped()\r
+  { return scaleAboveWrapped;}\r
+\r
+  public boolean getScaleLeftWrapped()\r
+  { return scaleLeftWrapped; }\r
+\r
+  public boolean getScaleRightWrapped()\r
+  { return scaleRightWrapped; }\r
+\r
+  public void setScaleAboveWrapped(boolean b)\r
+  { scaleAboveWrapped = b; }\r
+\r
+  public void setScaleLeftWrapped(boolean b)\r
+  { scaleLeftWrapped = b; }\r
+\r
+  public void setScaleRightWrapped(boolean b)\r
+  { scaleRightWrapped = b; }\r
+  // JBPNote Prolly only need this in the applet version.\r
+  private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(this);\r
+  public void addPropertyChangeListener(java.beans.PropertyChangeListener listener) {\r
+    changeSupport.addPropertyChangeListener(listener);\r
+  }\r
+\r
+  public void removePropertyChangeListener(java.beans.PropertyChangeListener listener) {\r
+    changeSupport.removePropertyChangeListener(listener);\r
+  }\r
+  public void firePropertyChange(String prop, Object oldvalue, Object newvalue) {\r
+    changeSupport.firePropertyChange(prop, oldvalue, newvalue);\r
+  }\r
 }\r