Viewport now looks at preferences when loading up
[jalview.git] / src / jalview / gui / AlignViewport.java
index 2f40de4..a135620 100755 (executable)
@@ -1,11 +1,12 @@
 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
@@ -15,13 +16,17 @@ public class AlignViewport
   int startSeq;\r
   int endSeq;\r
 \r
-  boolean showScores=false;\r
+  boolean showFullId = false;\r
   boolean showText=true;\r
   boolean showColourText=false;\r
   boolean showBoxes=true;\r
   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
@@ -42,47 +47,77 @@ 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 showScores,\r
-                       boolean showText,\r
-                       boolean showBoxes,\r
-                       boolean wrapAlignment) {\r
-    this(0,da.getWidth()-1,0,da.getHeight()-1,showScores,\r
-         showText,\r
-         showBoxes,\r
-         wrapAlignment);\r
-\r
-    setAlignment(da);\r
-  }\r
 \r
-  public AlignViewport(int startRes, int endRes,\r
-                       int startSeq, int endSeq,\r
-                       boolean showScores,\r
-                       boolean showText,\r
-                       boolean showBoxes,\r
-                       boolean wrapAlignment) {\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
-    this.startRes = startRes;\r
-    this.endRes   = endRes;\r
-    this.startSeq = startSeq;\r
-    this.endSeq   = endSeq;\r
+    updateFromPreferences();\r
 \r
-    this.showScores    = showScores;\r
-    this.showText      = showText;\r
-    this.showBoxes     = showBoxes;\r
-    this.wrapAlignment = wrapAlignment;\r
+  }\r
 \r
-   // og  = new AlignmentOutputGenerator(this);\r
+  public void updateFromPreferences()\r
+  {\r
+    String string = Cache.getProperty("SHOW_FULL_ID");\r
+    if(string!=null)\r
+      showFullId = Boolean.valueOf(string).booleanValue();\r
+\r
+    string = Cache.getProperty("SHOW_ANNOTATIONS");\r
+        if(string!=null)\r
+      showAnnotation = Boolean.valueOf(string).booleanValue();\r
+\r
+    string = Cache.getProperty("SHOW_CONSERVATION");\r
+        if(string!=null)\r
+      showConservation = Boolean.valueOf(string).booleanValue();\r
+    string = Cache.getProperty("SHOW_QUALITY");\r
+        if(string!=null)\r
+      showQuality = Boolean.valueOf(string).booleanValue();\r
+    string = Cache.getProperty("SHOW_IDENTITY");\r
+        if(string!=null)\r
+      showIdentity = Boolean.valueOf(string).booleanValue();\r
+\r
+    string = Cache.getProperty("SHOW_FULL_ID");\r
+      if(string!=null)\r
+        showFullId = Boolean.valueOf(string).booleanValue();\r
+\r
+  String fontName = Cache.getProperty("FONT_NAME");\r
+  String fontStyle= Cache.getProperty("FONT_STYLE");\r
+  String fontSize = Cache.getProperty("FONT_SIZE");\r
+  if(fontName!=null && fontStyle!=null && fontSize!=null)\r
+      setFont( new Font(fontName,Integer.parseInt(fontStyle),Integer.parseInt(fontSize)) );\r
+  else\r
+      setFont( font );\r
+\r
+    string = Cache.getProperty("GAP_SYMBOL");\r
+    if(string!=null)\r
+      alignment.setGapCharacter( string.charAt(0) );\r
+\r
+\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
+    string = Cache.getProperty("DEFAULT_COLOUR");\r
+    if(string!=null)\r
+    {\r
+      globalColourScheme = ColourSchemeProperty.getColour(alignment, string);\r
+      if(globalColourScheme!=null)\r
+        globalColourScheme.setConsensus( vconsensus );\r
+   }\r
 \r
-    setFont( font );\r
  }\r
 \r
  public void showSequenceFeatures(boolean b)\r
@@ -90,31 +125,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
+                                      "Conservation graph", ' ', 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("% Identity",\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
@@ -178,7 +323,7 @@ public class AlignViewport
   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
+       res = alignment.getWidth()-1;\r
     }\r
     if (res < 0) {\r
       res = 0;\r
@@ -240,9 +385,7 @@ public class AlignViewport
   public void setAlignment(AlignmentI align) {\r
     this.alignment = align;\r
   }\r
-  public void setShowScores(boolean state) {\r
-    showScores = state;\r
-  }\r
+\r
   public void setWrapAlignment(boolean state) {\r
     wrapAlignment = state;\r
   }\r
@@ -273,9 +416,7 @@ public class AlignViewport
   public void setShowBoxes(boolean state) {\r
     showBoxes = state;\r
   }\r
-  public boolean getShowScores() {\r
-    return showScores;\r
-  }\r
+\r
   public boolean getWrapAlignment() {\r
       return wrapAlignment;\r
   }\r
@@ -331,7 +472,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
@@ -355,5 +495,43 @@ public class AlignViewport
   public boolean getColourAppliesToAllGroups()\r
   {return colourAppliesToAllGroups; }\r
 \r
+  public boolean getShowFullId()\r
+  {\r
+    return showFullId;\r
+  }\r
+\r
+  public void setShowFullId(boolean b)\r
+  {\r
+    showFullId = b;\r
+  }\r
+\r
+  public boolean getShowAnnotation()\r
+  {\r
+    return showAnnotation;\r
+  }\r
+\r
+  public void setShowAnnotation(boolean b)\r
+  {\r
+    showAnnotation = b;\r
+  }\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
+\r
 \r
 }\r