Formatting changes
[jalview.git] / src / jalview / datamodel / Sequence.java
index 3853af9..34c1cd9 100755 (executable)
@@ -27,7 +27,14 @@ import java.awt.*;
 import java.util.*;\r
 \r
 \r
-public class Sequence implements SequenceI {\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class Sequence implements SequenceI\r
+{\r
     protected String name;\r
     protected String sequence;\r
     protected String description;\r
@@ -36,9 +43,20 @@ public class Sequence implements SequenceI {
     protected String displayId;\r
     protected Color color = Color.white;\r
     String pdbId;\r
+\r
+    /** DOCUMENT ME!! */\r
     public Vector sequenceFeatures = new Vector();\r
 \r
-    public Sequence(String name, String sequence, int start, int end) {\r
+    /**\r
+     * Creates a new Sequence object.\r
+     *\r
+     * @param name DOCUMENT ME!\r
+     * @param sequence DOCUMENT ME!\r
+     * @param start DOCUMENT ME!\r
+     * @param end DOCUMENT ME!\r
+     */\r
+    public Sequence(String name, String sequence, int start, int end)\r
+    {\r
         this.name = name;\r
         this.sequence = sequence;\r
         this.start = start;\r
@@ -47,137 +65,295 @@ public class Sequence implements SequenceI {
         setDisplayId();\r
     }\r
 \r
-    public Sequence(String name, String sequence) {\r
+    /**\r
+     * Creates a new Sequence object.\r
+     *\r
+     * @param name DOCUMENT ME!\r
+     * @param sequence DOCUMENT ME!\r
+     */\r
+    public Sequence(String name, String sequence)\r
+    {\r
         this(name, sequence, 1, sequence.length());\r
     }\r
 \r
-    public Sequence(SequenceI seq) {\r
+    /**\r
+     * Creates a new Sequence object.\r
+     *\r
+     * @param seq DOCUMENT ME!\r
+     */\r
+    public Sequence(SequenceI seq)\r
+    {\r
         this(seq.getName(), seq.getSequence(), seq.getStart(), seq.getEnd());\r
     }\r
 \r
-    public void setSequenceFeatures(Vector v) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param v DOCUMENT ME!\r
+     */\r
+    public void setSequenceFeatures(Vector v)\r
+    {\r
         sequenceFeatures = v;\r
     }\r
 \r
-    public Vector getSequenceFeatures() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public Vector getSequenceFeatures()\r
+    {\r
         return sequenceFeatures;\r
     }\r
 \r
-    public void setPDBId(String id) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param id DOCUMENT ME!\r
+     */\r
+    public void setPDBId(String id)\r
+    {\r
         pdbId = id;\r
     }\r
 \r
-    public String getPDBId() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getPDBId()\r
+    {\r
         return pdbId;\r
     }\r
 \r
-    public String getDisplayId() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getDisplayId()\r
+    {\r
         return displayId;\r
     }\r
 \r
-    public void setDisplayId() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     */\r
+    public void setDisplayId()\r
+    {\r
         displayId = name + "/" + start + "-" + end;\r
     }\r
 \r
-    public void setName(String name) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param name DOCUMENT ME!\r
+     */\r
+    public void setName(String name)\r
+    {\r
         this.name = name;\r
         setDisplayId();\r
     }\r
 \r
-    public String getName() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getName()\r
+    {\r
         return this.name;\r
     }\r
 \r
-    public void setStart(int start) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param start DOCUMENT ME!\r
+     */\r
+    public void setStart(int start)\r
+    {\r
         this.start = start;\r
         setDisplayId();\r
     }\r
 \r
-    public int getStart() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getStart()\r
+    {\r
         return this.start;\r
     }\r
 \r
-    public void setEnd(int end) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param end DOCUMENT ME!\r
+     */\r
+    public void setEnd(int end)\r
+    {\r
         this.end = end;\r
         setDisplayId();\r
     }\r
 \r
-    public int getEnd() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getEnd()\r
+    {\r
         return this.end;\r
     }\r
 \r
-    public int getLength() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getLength()\r
+    {\r
         return this.sequence.length();\r
     }\r
 \r
-    public void setSequence(String seq) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param seq DOCUMENT ME!\r
+     */\r
+    public void setSequence(String seq)\r
+    {\r
         this.sequence = seq;\r
     }\r
 \r
-    public String getSequence() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getSequence()\r
+    {\r
         return this.sequence;\r
     }\r
 \r
-    public String getSequence(int start, int end) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param start DOCUMENT ME!\r
+     * @param end DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getSequence(int start, int end)\r
+    {\r
         // JBPNote - left to user to pad the result here (TODO:Decide on this policy)\r
-        if (start >= sequence.length()) {\r
+        if (start >= sequence.length())\r
+        {\r
             return "";\r
         }\r
 \r
-        if (end >= sequence.length()) {\r
+        if (end >= sequence.length())\r
+        {\r
             end = sequence.length();\r
         }\r
 \r
         return this.sequence.substring(start, end);\r
     }\r
 \r
-    public char getCharAt(int i) {\r
-        if (i < sequence.length()) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param i DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public char getCharAt(int i)\r
+    {\r
+        if (i < sequence.length())\r
+        {\r
             return sequence.charAt(i);\r
-        } else {\r
+        }\r
+        else\r
+        {\r
             return ' ';\r
         }\r
     }\r
 \r
-    public void setDescription(String desc) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param desc DOCUMENT ME!\r
+     */\r
+    public void setDescription(String desc)\r
+    {\r
         this.description = desc;\r
     }\r
 \r
-    public String getDescription() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getDescription()\r
+    {\r
         return this.description;\r
     }\r
 \r
-    public int findIndex(int pos) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param pos DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int findIndex(int pos)\r
+    {\r
         // returns the alignment position for a residue\r
         int j = start;\r
         int i = 0;\r
 \r
-        while ((i < sequence.length()) && (j <= end) && (j <= pos)) {\r
+        while ((i < sequence.length()) && (j <= end) && (j <= pos))\r
+        {\r
             char c = sequence.charAt(i);\r
 \r
-            if (!jalview.util.Comparison.isGap((c))) {\r
+            if (!jalview.util.Comparison.isGap((c)))\r
+            {\r
                 j++;\r
             }\r
 \r
             i++;\r
         }\r
 \r
-        if ((j == end) && (j < pos)) {\r
+        if ((j == end) && (j < pos))\r
+        {\r
             return end + 1;\r
-        } else {\r
+        }\r
+        else\r
+        {\r
             return i;\r
         }\r
     }\r
 \r
-    public int findPosition(int i) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param i DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int findPosition(int i)\r
+    {\r
         // Returns the sequence position for an alignment position\r
         int j = 0;\r
         int pos = start;\r
 \r
-        while ((j < i) && (j < sequence.length())) {\r
+        while ((j < i) && (j < sequence.length()))\r
+        {\r
             char c = sequence.charAt(j);\r
 \r
-            if (!jalview.util.Comparison.isGap((c))) {\r
+            if (!jalview.util.Comparison.isGap((c)))\r
+            {\r
                 pos++;\r
             }\r
 \r
@@ -187,15 +363,23 @@ public class Sequence implements SequenceI {
         return pos;\r
     }\r
 \r
-    public int[] gapMap() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int[] gapMap()\r
+    {\r
         // Returns an int array giving the position of each residue in the sequence in the alignment\r
         String seq = jalview.analysis.AlignSeq.extractGaps("-. ", sequence);\r
         int[] map = new int[seq.length()];\r
         int j = 0;\r
         int p = 0;\r
 \r
-        while (j < sequence.length()) {\r
-            if (!jalview.util.Comparison.isGap(sequence.charAt(j))) {\r
+        while (j < sequence.length())\r
+        {\r
+            if (!jalview.util.Comparison.isGap(sequence.charAt(j)))\r
+            {\r
                 map[p++] = j;\r
             }\r
 \r
@@ -205,37 +389,73 @@ public class Sequence implements SequenceI {
         return map;\r
     }\r
 \r
-    public void deleteCharAt(int i) {\r
-        if (i >= sequence.length()) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param i DOCUMENT ME!\r
+     */\r
+    public void deleteCharAt(int i)\r
+    {\r
+        if (i >= sequence.length())\r
+        {\r
             return;\r
         }\r
 \r
         sequence = sequence.substring(0, i) + sequence.substring(i + 1);\r
     }\r
 \r
-    public void deleteChars(int i, int j) {\r
-        if (i >= sequence.length()) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param i DOCUMENT ME!\r
+     * @param j DOCUMENT ME!\r
+     */\r
+    public void deleteChars(int i, int j)\r
+    {\r
+        if (i >= sequence.length())\r
+        {\r
             return;\r
         }\r
 \r
-        if (j >= sequence.length()) {\r
+        if (j >= sequence.length())\r
+        {\r
             sequence = sequence.substring(0, i);\r
-        } else {\r
+        }\r
+        else\r
+        {\r
             sequence = sequence.substring(0, i) + sequence.substring(j);\r
         }\r
     }\r
 \r
-    public void insertCharAt(int i, char c) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param i DOCUMENT ME!\r
+     * @param c DOCUMENT ME!\r
+     */\r
+    public void insertCharAt(int i, char c)\r
+    {\r
         insertCharAt(i, c, true);\r
     }\r
 \r
-    public void insertCharAt(int i, char c, boolean chop) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param i DOCUMENT ME!\r
+     * @param c DOCUMENT ME!\r
+     * @param chop DOCUMENT ME!\r
+     */\r
+    public void insertCharAt(int i, char c, boolean chop)\r
+    {\r
         String tmp = new String(sequence);\r
 \r
-        if (i < sequence.length()) {\r
+        if (i < sequence.length())\r
+        {\r
             sequence = tmp.substring(0, i) + String.valueOf(c) +\r
                 tmp.substring(i);\r
-        } else {\r
+        }\r
+        else\r
+        {\r
             // JBPNote : padding char at end of sequence. We'll not get away with this when we insert residues, I bet!\r
             char[] ch = new char[(1 + i) - sequence.length()];\r
 \r
@@ -246,11 +466,23 @@ public class Sequence implements SequenceI {
         }\r
     }\r
 \r
-    public void setColor(Color c) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param c DOCUMENT ME!\r
+     */\r
+    public void setColor(Color c)\r
+    {\r
         this.color = c;\r
     }\r
 \r
-    public Color getColor() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public Color getColor()\r
+    {\r
         return color;\r
     }\r
 }\r