JAL-3210 Improvements to eclipse detection. New src tree and SwingJS updated from...
[jalview.git] / src / jalview / schemes / ColourSchemeProperty.java
index 8317bd7..0123384 100755 (executable)
-package jalview.schemes;\r
-\r
-public class ColourSchemeProperty\r
-{\r
-  public static final int CLUSTAL = 0;\r
-  public static final int BLOSUM = 1;\r
-  public static final int PID = 2;\r
-  public static final int ZAPPO = 3;\r
-  public static final int HYDROPHOBIC=4;\r
-  public static final int HELIX=5;\r
-  public static final int STRAND=6;\r
-  public static final int TURN = 7;\r
-  public static final int BURIED = 8;\r
-  public static final int NUCLEOTIDE = 9;\r
-  public static final int USER_DEFINED = 10;\r
-  public static final int NONE = 11;\r
-\r
-  public static int getColourIndexFromName(String name)\r
-  {\r
-    int ret=11;\r
-    if(name.equalsIgnoreCase("Clustal"))\r
-      ret = CLUSTAL;\r
-    else if(name.equalsIgnoreCase("Blosum62"))\r
-      ret = BLOSUM;\r
-    else if(name.equalsIgnoreCase("% Identity"))\r
-      ret = PID;\r
-    else if(name.equalsIgnoreCase("Zappo"))\r
-      ret = ZAPPO;\r
-    else if(name.equalsIgnoreCase("Hydrophobic"))\r
-      ret = HYDROPHOBIC;\r
-    else if(name.equalsIgnoreCase("Helix Propensity"))\r
-      ret = HELIX;\r
-    else if(name.equalsIgnoreCase("Strand Propensity"))\r
-      ret = STRAND;\r
-    else if(name.equalsIgnoreCase("Turn Propensity"))\r
-      ret = TURN;\r
-    else if(name.equalsIgnoreCase("Buried Index"))\r
-      ret = BURIED;\r
-    else if(name.equalsIgnoreCase("Nucleotide"))\r
-      ret = NUCLEOTIDE;\r
-    else if(name.equalsIgnoreCase("User Defined"))\r
-      ret =  USER_DEFINED;\r
-\r
-    return ret;\r
-  }\r
-\r
-  public static String getColourName(ColourSchemeI cs)\r
-  {\r
-    if(cs instanceof ConservationColourScheme)\r
-     cs = ((ConservationColourScheme)cs).cs;\r
-\r
-\r
-    int index = 11;\r
-    if(cs instanceof ClustalxColourScheme)\r
-      index = CLUSTAL;\r
-    else if(cs instanceof  Blosum62ColourScheme)\r
-      index = BLOSUM;\r
-    else if(cs instanceof  PIDColourScheme)\r
-      index = PID;\r
-    else if(cs instanceof  ZappoColourScheme)\r
-      index = ZAPPO;\r
-    else if(cs instanceof  HydrophobicColourScheme)\r
-      index = HYDROPHOBIC;\r
-    else if(cs instanceof  HelixColourScheme)\r
-      index = HELIX;\r
-    else if(cs instanceof  StrandColourScheme)\r
-      index = STRAND;\r
-    else if(cs instanceof  TurnColourScheme)\r
-      index = TURN;\r
-    else if(cs instanceof  BuriedColourScheme)\r
-      index = BURIED;\r
-    else if(cs instanceof  NucleotideColourScheme)\r
-      index = NUCLEOTIDE;\r
-    else if(cs instanceof  UserColourScheme)\r
-      index = USER_DEFINED;\r
-\r
-    return getColourName(index);\r
-  }\r
-\r
-  public static String getColourName(int index)\r
-  {\r
-    String ret=null;\r
-    switch(index)\r
-    {\r
-      case CLUSTAL: ret = "Clustal";    break;\r
-      case BLOSUM:  ret = "Blosum62";   break;\r
-      case PID:     ret = "% Identity"; break;\r
-      case ZAPPO:   ret = "Zappo";      break;\r
-      case HYDROPHOBIC: ret="Hydrophobic";break;\r
-      case HELIX:   ret="Helix Propensity";break;\r
-      case STRAND:  ret="Strand Propensity";break;\r
-      case TURN:    ret="Turn Propensity";break;\r
-      case BURIED:  ret="Buried Index";break;\r
-      case NUCLEOTIDE:ret="Nucleotide"; break;\r
-      case USER_DEFINED:ret="User Defined";break;\r
-      default: ret = "None"; break;\r
-    }\r
-    return ret;\r
-  }\r
-\r
-  public static ColourSchemeI getColour(jalview.datamodel.AlignmentI al, String name)\r
-  {\r
-    return getColour(al, getColourIndexFromName(name));\r
-  }\r
-\r
-  public static ColourSchemeI getColour(jalview.datamodel.AlignmentI al, int index)\r
-  {\r
-    ColourSchemeI cs = null;\r
-    switch(index)\r
-    {\r
-      case CLUSTAL: cs = new ClustalxColourScheme(al.getSequences(), al.getWidth()); break;\r
-      case BLOSUM: cs = new Blosum62ColourScheme(); break;\r
-      case PID: cs = new PIDColourScheme();  break;\r
-      case ZAPPO: cs = new ZappoColourScheme(); break;\r
-      case HYDROPHOBIC: cs = new HydrophobicColourScheme(); break;\r
-      case HELIX: cs = new HelixColourScheme(); break;\r
-      case STRAND: cs = new StrandColourScheme(); break;\r
-      case TURN: cs = new TurnColourScheme(); break;\r
-      case BURIED: cs = new BuriedColourScheme(); break;\r
-      case NUCLEOTIDE: cs = new NucleotideColourScheme(); break;\r
-      case USER_DEFINED: cs = new UserColourScheme(null);\r
-        break;\r
-\r
-      default: break;\r
-    }\r
-\r
-    return cs;\r
-  }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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.
+ *  
+ * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.schemes;
+
+import jalview.api.AlignViewportI;
+import jalview.datamodel.AnnotatedCollectionI;
+
+/**
+ * ColourSchemeProperty binds names to hardwired colourschemes and tries to deal
+ * intelligently with mapping unknown names to user defined colourschemes (that
+ * exist or can be created from the string representation of the colourscheme
+ * name - either a hex RGB triplet or a named colour under java.awt.color ). The
+ * values of the colourscheme constants is important for callers of
+ * getColourName(int i), since it can be used to enumerate the set of built in
+ * colours. The FIRST_COLOUR and LAST_COLOUR symbols are provided for this.
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class ColourSchemeProperty
+{
+
+  private ColourSchemeProperty()
+  {
+    // requires static call to getColourScheme(...).
+  }
+
+  /**
+   * Returns a colour scheme for the given name, with which the given data may
+   * be coloured. The name is not case-sensitive, and may be one of
+   * <ul>
+   * <li>any currently registered colour scheme; Jalview by default
+   * provides</li>
+   * <ul>
+   * <li>Clustal</li>
+   * <li>Blosum62</li>
+   * <li>% Identity</li>
+   * <li>Hydrophobic</li>
+   * <li>Zappo</li>
+   * <li>Taylor</li>
+   * <li>Helix Propensity</li>
+   * <li>Strand Propensity</li>
+   * <li>Turn Propensity</li>
+   * <li>Buried Index</li>
+   * <li>Nucleotide</li>
+   * <li>Purine/Pyrimidine</li>
+   * <li>T-Coffee Scores</li>
+   * <li>RNA Helices</li>
+   * </ul>
+   * <li>the name of a programmatically added colour scheme</li>
+   * <li>an AWT colour name e.g. red</li>
+   * <li>an AWT hex rgb colour e.g. ff2288</li>
+   * <li>residue colours list e.g. D,E=red;K,R,H=0022FF;c=yellow</li>
+   * </ul>
+   * 
+   * If none of these formats is matched, the string is converted to a colour
+   * using a hashing algorithm. For name "None", returns null.
+   * 
+   * @param forData
+   * @param name
+   * @return
+   */
+  public static ColourSchemeI getColourScheme(AlignViewportI view,
+          AnnotatedCollectionI forData,
+          String name)
+  {
+    if (ResidueColourScheme.NONE.equalsIgnoreCase(name))
+    {
+      return null;
+
+    }
+
+    /*
+     * if this is the name of a registered colour scheme, just
+     * create a new instance of it
+     */
+    ColourSchemeI scheme = ColourSchemes.getInstance().getColourScheme(name,
+            view,
+            forData, null);
+    if (scheme != null)
+    {
+      return scheme;
+    }
+
+    /*
+     * try to parse the string as a residues colour scheme
+     * e.g. A=red;T,G=blue etc
+     * else parse the name as a colour specification
+     * e.g. "red" or "ff00ed",
+     * or failing that hash the name to a colour
+     */
+    UserColourScheme ucs = new UserColourScheme(name);
+    return ucs;
+  }
+
+  /**
+   * Returns the name of the colour scheme (or "None" if it is null)
+   * 
+   * @param cs
+   * @return
+   */
+  public static String getColourName(ColourSchemeI cs)
+  {
+    return cs == null ? ResidueColourScheme.NONE : cs.getSchemeName();
+  }
+
+}