Formatting changes
[jalview.git] / src / jalview / datamodel / AlignmentAnnotation.java
index 8326c3a..9cfdff6 100755 (executable)
+/*\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
 package jalview.datamodel;\r
 \r
+\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
 public class AlignmentAnnotation\r
 {\r
-  public String label;\r
-  public String description;\r
-  public Annotation  [] annotations;\r
-  public boolean isGraph = false;\r
-  public float graphMin, graphMax;\r
-  public int windowLength;\r
-\r
-  // Graphical hints and tips\r
-  public boolean editable = false;\r
-  public boolean hasIcons; //\r
-  public boolean hasText;\r
-  public boolean visible = true;\r
-  public int height=0;\r
-\r
-  public AlignmentAnnotation(String label, String description, Annotation [] annotations)\r
-  {\r
-    // always editable?\r
-    editable = true;\r
-    this.label = label;\r
-    this.description = description;\r
-    this.annotations = annotations;\r
-    for(int i=0; i<annotations.length; i++)\r
+    /** DOCUMENT ME!! */\r
+    public String label;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public String description;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public Annotation[] annotations;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public boolean isGraph = false;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public float graphMin;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public float graphMax;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public int windowLength;\r
+\r
+    // Graphical hints and tips\r
+\r
+    /** DOCUMENT ME!! */\r
+    public boolean editable = false;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public boolean hasIcons; //\r
+\r
+    /** DOCUMENT ME!! */\r
+    public boolean hasText;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public boolean visible = true;\r
+\r
+    /** DOCUMENT ME!! */\r
+    public int height = 0;\r
+\r
+    /**\r
+     * Creates a new AlignmentAnnotation object.\r
+     *\r
+     * @param label DOCUMENT ME!\r
+     * @param description DOCUMENT ME!\r
+     * @param annotations DOCUMENT ME!\r
+     */\r
+    public AlignmentAnnotation(String label, String description,\r
+        Annotation[] annotations)\r
     {\r
-      if (annotations[i]!=null &&(\r
-          annotations[i].secondaryStructure == 'H' ||\r
-          annotations[i].secondaryStructure == 'E'))\r
-        hasIcons = true;\r
+        // always editable?\r
+        editable = true;\r
+        this.label = label;\r
+        this.description = description;\r
+        this.annotations = annotations;\r
 \r
-      if (annotations[i]!=null && annotations[i].displayCharacter.length()>0)\r
-        hasText = true;\r
+        for (int i = 0; i < annotations.length; i++)\r
+        {\r
+            if ((annotations[i] != null) &&\r
+                    ((annotations[i].secondaryStructure == 'H') ||\r
+                    (annotations[i].secondaryStructure == 'E')))\r
+            {\r
+                hasIcons = true;\r
+            }\r
+\r
+            if ((annotations[i] != null) &&\r
+                    (annotations[i].displayCharacter.length() > 0))\r
+            {\r
+                hasText = true;\r
+            }\r
+        }\r
     }\r
-  }\r
-\r
-  public AlignmentAnnotation(String label, String description, Annotation [] annotations, float min, float max, int winLength)\r
-  {\r
-    // graphs are not editable\r
-    this.label = label;\r
-    this.description = description;\r
-    this.annotations = annotations;\r
-    isGraph = true;\r
-    if(min==max)\r
+\r
+    /**\r
+     * Creates a new AlignmentAnnotation object.\r
+     *\r
+     * @param label DOCUMENT ME!\r
+     * @param description DOCUMENT ME!\r
+     * @param annotations DOCUMENT ME!\r
+     * @param min DOCUMENT ME!\r
+     * @param max DOCUMENT ME!\r
+     * @param winLength DOCUMENT ME!\r
+     */\r
+    public AlignmentAnnotation(String label, String description,\r
+        Annotation[] annotations, float min, float max, int winLength)\r
     {\r
-      for(int i=0; i<annotations.length; i++)\r
-      {\r
-        if(annotations[i]==null)\r
-          continue;\r
-        if(annotations[i].value>max)\r
-          max = annotations[i].value;\r
-        if(annotations[i].value<min)\r
-          min = annotations[i].value;\r
-      }\r
+        // graphs are not editable\r
+        this.label = label;\r
+        this.description = description;\r
+        this.annotations = annotations;\r
+        isGraph = true;\r
+\r
+        if (min == max)\r
+        {\r
+            for (int i = 0; i < annotations.length; i++)\r
+            {\r
+                if (annotations[i] == null)\r
+                {\r
+                    continue;\r
+                }\r
+\r
+                if (annotations[i].value > max)\r
+                {\r
+                    max = annotations[i].value;\r
+                }\r
+\r
+                if (annotations[i].value < min)\r
+                {\r
+                    min = annotations[i].value;\r
+                }\r
+            }\r
+        }\r
+\r
+        graphMin = min;\r
+        graphMax = max;\r
+        windowLength = winLength;\r
+\r
+        for (int i = 0; i < annotations.length; i++)\r
+        {\r
+            if ((annotations[i] != null) &&\r
+                    ((annotations[i].secondaryStructure == 'H') ||\r
+                    (annotations[i].secondaryStructure == 'E')))\r
+            {\r
+                hasIcons = true;\r
+            }\r
+\r
+            if ((annotations[i] != null) &&\r
+                    (annotations[i].displayCharacter.length() > 0))\r
+            {\r
+                hasText = true;\r
+            }\r
+        }\r
     }\r
 \r
-    graphMin = min;\r
-    graphMax = max;\r
-    windowLength = winLength;\r
-    for(int i=0; i<annotations.length; i++)\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String toString()\r
     {\r
-      if (annotations[i]!=null &&(\r
-          annotations[i].secondaryStructure == 'H' ||\r
-          annotations[i].secondaryStructure == 'E'))\r
-        hasIcons = true;\r
+        StringBuffer buffer = new StringBuffer();\r
 \r
-      if (annotations[i]!=null && annotations[i].displayCharacter.length()>0)\r
-        hasText = true;\r
-    }\r
-  }\r
-\r
-  public String toString()\r
-  {\r
-    StringBuffer buffer = new StringBuffer();\r
-    for(int i=0; i<annotations.length; i++)\r
-   {\r
-     buffer.append( annotations[i].value );\r
-     buffer.append(", ");\r
-   }\r
-   return buffer.toString();\r
-  }\r
+        for (int i = 0; i < annotations.length; i++)\r
+        {\r
+            if (annotations[i] != null)\r
+            {\r
+                if (isGraph)\r
+                {\r
+                    buffer.append(annotations[i].value);\r
+                }\r
+                else if (hasIcons)\r
+                {\r
+                    buffer.append(annotations[i].secondaryStructure);\r
+                }\r
+                else\r
+                {\r
+                    buffer.append(annotations[i].displayCharacter);\r
+                }\r
+            }\r
+\r
+            buffer.append(", ");\r
+        }\r
+\r
+        if (label.equals("Consensus"))\r
+        {\r
+            buffer.append("\n");\r
 \r
+            for (int i = 0; i < annotations.length; i++)\r
+            {\r
+                if (annotations[i] != null)\r
+                {\r
+                    buffer.append(annotations[i].description);\r
+                }\r
+\r
+                buffer.append(", ");\r
+            }\r
+        }\r
+\r
+        return buffer.toString();\r
+    }\r
 }\r