jalview 2.5 release banner
[jalview.git] / src / jalview / schemabinding / version2 / Colour.java
index c1c1751..1ebe7f7 100755 (executable)
@@ -1,26 +1,25 @@
 /*\r
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)\r
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, 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
+ * This file is part of Jalview.\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
+ * Jalview 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 3 of the License, or (at your option) any later version.\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
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE.  See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  */\r
 package jalview.schemabinding.version2;\r
 \r
-// ---------------------------------/\r
-// - Imported classes and packages -/\r
-// ---------------------------------/\r
+//---------------------------------/\r
+//- Imported classes and packages -/\r
+//---------------------------------/\r
 \r
 import org.exolab.castor.xml.Marshaller;\r
 import org.exolab.castor.xml.Unmarshaller;\r
@@ -47,6 +46,66 @@ public class Colour implements java.io.Serializable
    */\r
   private java.lang.String _RGB;\r
 \r
+  /**\r
+   * Field _minRGB.\r
+   */\r
+  private java.lang.String _minRGB;\r
+\r
+  /**\r
+   * loosely specified enumeration: NONE,ABOVE, or BELOW\r
+   */\r
+  private java.lang.String _threshType;\r
+\r
+  /**\r
+   * Field _threshold.\r
+   */\r
+  private float _threshold;\r
+\r
+  /**\r
+   * keeps track of state for field: _threshold\r
+   */\r
+  private boolean _has_threshold;\r
+\r
+  /**\r
+   * Field _max.\r
+   */\r
+  private float _max;\r
+\r
+  /**\r
+   * keeps track of state for field: _max\r
+   */\r
+  private boolean _has_max;\r
+\r
+  /**\r
+   * Field _min.\r
+   */\r
+  private float _min;\r
+\r
+  /**\r
+   * keeps track of state for field: _min\r
+   */\r
+  private boolean _has_min;\r
+\r
+  /**\r
+   * Field _colourByLabel.\r
+   */\r
+  private boolean _colourByLabel;\r
+\r
+  /**\r
+   * keeps track of state for field: _colourByLabel\r
+   */\r
+  private boolean _has_colourByLabel;\r
+\r
+  /**\r
+   * Field _autoScale.\r
+   */\r
+  private boolean _autoScale;\r
+\r
+  /**\r
+   * keeps track of state for field: _autoScale\r
+   */\r
+  private boolean _has_autoScale;\r
+\r
   // ----------------/\r
   // - Constructors -/\r
   // ----------------/\r
@@ -61,6 +120,91 @@ public class Colour implements java.io.Serializable
   // -----------/\r
 \r
   /**\r
+     */\r
+  public void deleteAutoScale()\r
+  {\r
+    this._has_autoScale = false;\r
+  }\r
+\r
+  /**\r
+     */\r
+  public void deleteColourByLabel()\r
+  {\r
+    this._has_colourByLabel = false;\r
+  }\r
+\r
+  /**\r
+     */\r
+  public void deleteMax()\r
+  {\r
+    this._has_max = false;\r
+  }\r
+\r
+  /**\r
+     */\r
+  public void deleteMin()\r
+  {\r
+    this._has_min = false;\r
+  }\r
+\r
+  /**\r
+     */\r
+  public void deleteThreshold()\r
+  {\r
+    this._has_threshold = false;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'autoScale'.\r
+   * \r
+   * @return the value of field 'AutoScale'.\r
+   */\r
+  public boolean getAutoScale()\r
+  {\r
+    return this._autoScale;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'colourByLabel'.\r
+   * \r
+   * @return the value of field 'ColourByLabel'.\r
+   */\r
+  public boolean getColourByLabel()\r
+  {\r
+    return this._colourByLabel;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'max'.\r
+   * \r
+   * @return the value of field 'Max'.\r
+   */\r
+  public float getMax()\r
+  {\r
+    return this._max;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'min'.\r
+   * \r
+   * @return the value of field 'Min'.\r
+   */\r
+  public float getMin()\r
+  {\r
+    return this._min;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'minRGB'.\r
+   * \r
+   * @return the value of field 'MinRGB'.\r
+   */\r
+  public java.lang.String getMinRGB()\r
+  {\r
+    return this._minRGB;\r
+  }\r
+\r
+  /**\r
    * Returns the value of field 'name'.\r
    * \r
    * @return the value of field 'Name'.\r
@@ -81,6 +225,97 @@ public class Colour implements java.io.Serializable
   }\r
 \r
   /**\r
+   * Returns the value of field 'threshType'. The field 'threshType' has the\r
+   * following description: loosely specified enumeration: NONE,ABOVE, or BELOW\r
+   * \r
+   * @return the value of field 'ThreshType'.\r
+   */\r
+  public java.lang.String getThreshType()\r
+  {\r
+    return this._threshType;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'threshold'.\r
+   * \r
+   * @return the value of field 'Threshold'.\r
+   */\r
+  public float getThreshold()\r
+  {\r
+    return this._threshold;\r
+  }\r
+\r
+  /**\r
+   * Method hasAutoScale.\r
+   * \r
+   * @return true if at least one AutoScale has been added\r
+   */\r
+  public boolean hasAutoScale()\r
+  {\r
+    return this._has_autoScale;\r
+  }\r
+\r
+  /**\r
+   * Method hasColourByLabel.\r
+   * \r
+   * @return true if at least one ColourByLabel has been added\r
+   */\r
+  public boolean hasColourByLabel()\r
+  {\r
+    return this._has_colourByLabel;\r
+  }\r
+\r
+  /**\r
+   * Method hasMax.\r
+   * \r
+   * @return true if at least one Max has been added\r
+   */\r
+  public boolean hasMax()\r
+  {\r
+    return this._has_max;\r
+  }\r
+\r
+  /**\r
+   * Method hasMin.\r
+   * \r
+   * @return true if at least one Min has been added\r
+   */\r
+  public boolean hasMin()\r
+  {\r
+    return this._has_min;\r
+  }\r
+\r
+  /**\r
+   * Method hasThreshold.\r
+   * \r
+   * @return true if at least one Threshold has been added\r
+   */\r
+  public boolean hasThreshold()\r
+  {\r
+    return this._has_threshold;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'autoScale'.\r
+   * \r
+   * @return the value of field 'AutoScale'.\r
+   */\r
+  public boolean isAutoScale()\r
+  {\r
+    return this._autoScale;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'colourByLabel'.\r
+   * \r
+   * @return the value of field 'ColourByLabel'.\r
+   */\r
+  public boolean isColourByLabel()\r
+  {\r
+    return this._colourByLabel;\r
+  }\r
+\r
+  /**\r
    * Method isValid.\r
    * \r
    * @return true if this object is valid according to the schema\r
@@ -102,11 +337,10 @@ public class Colour implements java.io.Serializable
    * \r
    * @param out\r
    * @throws org.exolab.castor.xml.MarshalException\r
-   *                 if object is null or if any SAXException is thrown during\r
-   *                 marshaling\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    */\r
   public void marshal(final java.io.Writer out)\r
           throws org.exolab.castor.xml.MarshalException,\r
@@ -120,13 +354,12 @@ public class Colour implements java.io.Serializable
    * \r
    * @param handler\r
    * @throws java.io.IOException\r
-   *                 if an IOException occurs during marshaling\r
+   *           if an IOException occurs during marshaling\r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    * @throws org.exolab.castor.xml.MarshalException\r
-   *                 if object is null or if any SAXException is thrown during\r
-   *                 marshaling\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
    */\r
   public void marshal(final org.xml.sax.ContentHandler handler)\r
           throws java.io.IOException,\r
@@ -137,10 +370,69 @@ public class Colour implements java.io.Serializable
   }\r
 \r
   /**\r
+   * Sets the value of field 'autoScale'.\r
+   * \r
+   * @param autoScale\r
+   *          the value of field 'autoScale'.\r
+   */\r
+  public void setAutoScale(final boolean autoScale)\r
+  {\r
+    this._autoScale = autoScale;\r
+    this._has_autoScale = true;\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'colourByLabel'.\r
+   * \r
+   * @param colourByLabel\r
+   *          the value of field 'colourByLabel'.\r
+   */\r
+  public void setColourByLabel(final boolean colourByLabel)\r
+  {\r
+    this._colourByLabel = colourByLabel;\r
+    this._has_colourByLabel = true;\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'max'.\r
+   * \r
+   * @param max\r
+   *          the value of field 'max'.\r
+   */\r
+  public void setMax(final float max)\r
+  {\r
+    this._max = max;\r
+    this._has_max = true;\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'min'.\r
+   * \r
+   * @param min\r
+   *          the value of field 'min'.\r
+   */\r
+  public void setMin(final float min)\r
+  {\r
+    this._min = min;\r
+    this._has_min = true;\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'minRGB'.\r
+   * \r
+   * @param minRGB\r
+   *          the value of field 'minRGB'.\r
+   */\r
+  public void setMinRGB(final java.lang.String minRGB)\r
+  {\r
+    this._minRGB = minRGB;\r
+  }\r
+\r
+  /**\r
    * Sets the value of field 'name'.\r
    * \r
    * @param name\r
-   *                the value of field 'name'.\r
+   *          the value of field 'name'.\r
    */\r
   public void setName(final java.lang.String name)\r
   {\r
@@ -151,7 +443,7 @@ public class Colour implements java.io.Serializable
    * Sets the value of field 'RGB'.\r
    * \r
    * @param RGB\r
-   *                the value of field 'RGB'.\r
+   *          the value of field 'RGB'.\r
    */\r
   public void setRGB(final java.lang.String RGB)\r
   {\r
@@ -159,15 +451,38 @@ public class Colour implements java.io.Serializable
   }\r
 \r
   /**\r
+   * Sets the value of field 'threshType'. The field 'threshType' has the\r
+   * following description: loosely specified enumeration: NONE,ABOVE, or BELOW\r
+   * \r
+   * @param threshType\r
+   *          the value of field 'threshType'.\r
+   */\r
+  public void setThreshType(final java.lang.String threshType)\r
+  {\r
+    this._threshType = threshType;\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'threshold'.\r
+   * \r
+   * @param threshold\r
+   *          the value of field 'threshold'.\r
+   */\r
+  public void setThreshold(final float threshold)\r
+  {\r
+    this._threshold = threshold;\r
+    this._has_threshold = true;\r
+  }\r
+\r
+  /**\r
    * Method unmarshal.\r
    * \r
    * @param reader\r
    * @throws org.exolab.castor.xml.MarshalException\r
-   *                 if object is null or if any SAXException is thrown during\r
-   *                 marshaling\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    * @return the unmarshaled jalview.schemabinding.version2.Colour\r
    */\r
   public static jalview.schemabinding.version2.Colour unmarshal(\r
@@ -183,8 +498,7 @@ public class Colour implements java.io.Serializable
    * \r
    * \r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    */\r
   public void validate() throws org.exolab.castor.xml.ValidationException\r
   {\r