JAL-1620 version bump and release notes

[jalview.git] / src / jalview / schemes / ResidueColourScheme.java

diff --git a/src/jalview/schemes/ResidueColourScheme.java b/src/jalview/schemes/ResidueColourScheme.java
index 90833c9..1064c38 100755 (executable)
--- a/src/jalview/schemes/ResidueColourScheme.java
+++ b/src/jalview/schemes/ResidueColourScheme.java
@@ -1,29 +1,35 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
+ * Copyright (C) 2014 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.
- * 
+ * 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/>.
+ * 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.schemes;
 
 import jalview.analysis.AAFrequency;
 import jalview.analysis.Conservation;
 import jalview.datamodel.AnnotatedCollectionI;
+import jalview.datamodel.SequenceCollectionI;
 import jalview.datamodel.SequenceI;
+import jalview.util.MessageManager;
 
 import java.awt.Color;
 import java.util.Hashtable;
+import java.util.Map;
 
 /**
  * DOCUMENT ME!
@@ -33,6 +39,7 @@ import java.util.Hashtable;
  */
 public class ResidueColourScheme implements ColourSchemeI
 {
+  final int[] symbolIndex;
 
   boolean conservationColouring = false;
 
@@ -57,22 +64,37 @@ public class ResidueColourScheme implements ColourSchemeI
   /**
    * Creates a new ResidueColourScheme object.
    * 
+   * @param final int[] index table into colors (ResidueProperties.naIndex or
+   *        ResidueProperties.aaIndex)
    * @param colors
-   *          DOCUMENT ME!
+   *          colours for symbols in sequences
    * @param threshold
-   *          DOCUMENT ME!
+   *          threshold for conservation shading
    */
-  public ResidueColourScheme(Color[] colours, int threshold)
+  public ResidueColourScheme(int[] aaOrnaIndex, Color[] colours,
+          int threshold)
   {
+    symbolIndex = aaOrnaIndex;
     this.colors = colours;
     this.threshold = threshold;
   }
 
   /**
-   * Creates a new ResidueColourScheme object.
+   * Creates a new ResidueColourScheme object with a lookup table for indexing
+   * the colour map
+   */
+  public ResidueColourScheme(int[] aaOrNaIndex)
+  {
+    symbolIndex = aaOrNaIndex;
+  }
+
+  /**
+   * Creates a new ResidueColourScheme object - default constructor for
+   * non-sequence dependent colourschemes
    */
   public ResidueColourScheme()
   {
+    symbolIndex = null;
   }
 
   /**
@@ -80,8 +102,7 @@ public class ResidueColourScheme implements ColourSchemeI
    */
   public Color findColour(char c)
   {
-    return colors == null ? Color.white
-            : colors[ResidueProperties.aaIndex[c]];
+    return colors == null ? Color.white : colors[symbolIndex[c]];
   }
 
   @Override
@@ -89,9 +110,10 @@ public class ResidueColourScheme implements ColourSchemeI
   {
     Color currentColour;
 
-    if ((threshold == 0) || aboveThreshold(c, j))
+    if (colors != null && symbolIndex != null && (threshold == 0)
+            || aboveThreshold(c, j))
     {
-      currentColour = colors[ResidueProperties.aaIndex[c]];
+      currentColour = colors[symbolIndex[c]];
     }
     else
     {
@@ -105,7 +127,6 @@ public class ResidueColourScheme implements ColourSchemeI
 
     return currentColour;
   }
-  @Override public void alignmentChanged(AnnotatedCollectionI alignment) {};
 
   /**
    * Get the percentage threshold for this colour scheme
@@ -177,6 +198,12 @@ public class ResidueColourScheme implements ColourSchemeI
     return conservationColouring;
   }
 
+  @Override
+  public void setConservationApplied(boolean conservationApplied)
+  {
+    conservationColouring = conservationApplied;
+  }
+
   public void setConservationInc(int i)
   {
     inc = i;
@@ -282,4 +309,22 @@ public class ResidueColourScheme implements ColourSchemeI
     return currentColour;
   }
 
+  @Override
+  public void alignmentChanged(AnnotatedCollectionI alignment,
+          Map<SequenceI, SequenceCollectionI> hiddenReps)
+  {
+  }
+
+  @Override
+  public ColourSchemeI applyTo(AnnotatedCollectionI sg,
+          Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
+  {
+    try
+    {
+      return getClass().newInstance();
+    } catch (Exception q)
+    {
+      throw new Error(MessageManager.formatMessage("error.implementation_error_cannot_duplicate_colour_scheme", new String[]{getClass().getName()}), q);
+    }
+  }
 }