fixed end-residue bug and subjob panel names bug
[jalview.git] / src / jalview / datamodel / Sequence.java
index b5d5199..dee67d3 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
-import java.awt.*;\r
-\r
-import java.util.*;\r
-\r
-\r
-/**\r
- * DOCUMENT ME!\r
- *\r
- * @author $author$\r
- * @version $Revision$\r
- */\r
-public class Sequence implements SequenceI\r
-{\r
-    SequenceI datasetSequence;\r
-    String name;\r
-    private String sequence;\r
-    String description;\r
-    int start;\r
-    int end;\r
-    Color color = Color.white;\r
-    Vector pdbIds;\r
-    String vamsasId;\r
-    DBRefEntry [] dbrefs;\r
-\r
-    /** This annotation is displayed below the alignment but the\r
-     * positions are tied to the residues of this sequence */\r
-    Vector annotation;\r
-\r
-    /** DOCUMENT ME!! */\r
-    public SequenceFeature [] sequenceFeatures;\r
-\r
-    /** This array holds hidden sequences\r
-     * of which this sequence is the representitive member of a group\r
-     */\r
-    SequenceGroup hiddenSequences;\r
-\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
-      this.end = end;\r
-\r
-      parseId();\r
-\r
-      checkValidRange();\r
-    }\r
-\r
-    com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(\r
-                        "[/][0-9]{1,}[-][0-9]{1,}$");\r
-    com.stevesoft.pat.Regex endrx = new com.stevesoft.pat.Regex(\r
-                        "[0-9]{1,}$");\r
-\r
-    void parseId()\r
-    {\r
-        // Does sequence have the /start-end signiature?\r
-         if(limitrx.search(name))\r
-         {\r
-            name = limitrx.left();\r
-            endrx.search(limitrx.stringMatched());\r
-            setStart( Integer.parseInt( limitrx.stringMatched().substring(1,endrx.matchedFrom()-1 )));\r
-            setEnd(   Integer.parseInt( endrx.stringMatched() ));\r
-         }\r
-    }\r
-\r
-    void checkValidRange()\r
-    {\r
-      if (end < 1)\r
-      {\r
-        int endRes = 0;\r
-        char ch;\r
-        for (int j = 0; j < sequence.length(); j++)\r
-        {\r
-          ch = sequence.charAt(j);\r
-          if (!jalview.util.Comparison.isGap( (ch)))\r
-          {\r
-            endRes++;\r
-          }\r
-        }\r
-        if (endRes > 0)\r
-        {\r
-          endRes += start - 1;\r
-        }\r
-\r
-        this.end = endRes;\r
-      }\r
-\r
-    }\r
-\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, -1);\r
-    }\r
-\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
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param v DOCUMENT ME!\r
-     */\r
-    public void setSequenceFeatures(SequenceFeature [] features)\r
-    {\r
-        sequenceFeatures = features;\r
-    }\r
-\r
-    public synchronized void addSequenceFeature(SequenceFeature sf)\r
-    {\r
-      if(sequenceFeatures==null)\r
-      {\r
-        sequenceFeatures = new SequenceFeature[0];\r
-      }\r
-\r
-      for(int i=0; i<sequenceFeatures.length; i++)\r
-      {\r
-        if(sequenceFeatures[i].equals(sf))\r
-        {\r
-          return;\r
-        }\r
-      }\r
-\r
-      SequenceFeature [] temp = new SequenceFeature[sequenceFeatures.length+1];\r
-      System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length);\r
-      temp[sequenceFeatures.length] = sf;\r
-\r
-      sequenceFeatures = temp;\r
-    }\r
-\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public SequenceFeature [] getSequenceFeatures()\r
-    {\r
-        return sequenceFeatures;\r
-    }\r
-\r
-    public void addPDBId(PDBEntry entry)\r
-    {\r
-      if(pdbIds == null)\r
-        pdbIds = new Vector();\r
-\r
-      pdbIds.addElement(entry);\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param id DOCUMENT ME!\r
-     */\r
-    public void setPDBId(Vector id)\r
-    {\r
-        pdbIds = id;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public Vector getPDBId()\r
-    {\r
-        return pdbIds;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public String getDisplayId(boolean jvsuffix)\r
-    {\r
-      StringBuffer result = new StringBuffer(name);\r
-      if (jvsuffix)\r
-      {\r
-        result.append("/" + start + "-" + end);\r
-      }\r
-\r
-      return result.toString();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param name DOCUMENT ME!\r
-     */\r
-    public void setName(String name)\r
-    {\r
-      this.name = name;\r
-      this.parseId();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public String getName()\r
-    {\r
-       return this.name;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param start DOCUMENT ME!\r
-     */\r
-    public void setStart(int start)\r
-    {\r
-        this.start = start;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public int getStart()\r
-    {\r
-        return this.start;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param end DOCUMENT ME!\r
-     */\r
-    public void setEnd(int end)\r
-    {\r
-        this.end = end;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public int getEnd()\r
-    {\r
-        return this.end;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public int getLength()\r
-    {\r
-        return this.sequence.length();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param seq DOCUMENT ME!\r
-     */\r
-    public void setSequence(String seq)\r
-    {\r
-        this.sequence = seq;\r
-        checkValidRange();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public String getSequence()\r
-    {\r
-        return this.sequence;\r
-    }\r
-\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
-        {\r
-            return "";\r
-        }\r
-\r
-        if (end >= sequence.length())\r
-        {\r
-            end = sequence.length();\r
-        }\r
-\r
-        return this.sequence.substring(start, end);\r
-    }\r
-    /**\r
-     * make a new Sequence object from start to end (including gaps) over this seqeunce\r
-     * @param start int\r
-     * @param end int\r
-     * @return SequenceI\r
-     */\r
-    public SequenceI getSubSequence(int start, int end) {\r
-      if (start<0)\r
-        start = 0;\r
-      String seq = getSequence(start, end);\r
-      if (seq=="")\r
-        return null;\r
-      start = findPosition(start);\r
-      end=findPosition(end);\r
-      // JBPNote - this is an incomplete copy.\r
-      SequenceI nseq = new Sequence(this.getName(), seq, start, end);\r
-      nseq.setDatasetSequence(getDatasetSequence());\r
-      return nseq;\r
-    }\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
-        }\r
-        else\r
-        {\r
-            return ' ';\r
-        }\r
-    }\r
-\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
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public String getDescription()\r
-    {\r
-        return this.description;\r
-    }\r
-\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
-        {\r
-            if (!jalview.util.Comparison.isGap(sequence.charAt(i)))\r
-            {\r
-                j++;\r
-            }\r
-\r
-            i++;\r
-        }\r
-\r
-        if ((j == end) && (j < pos))\r
-        {\r
-            return end + 1;\r
-        }\r
-        else\r
-        {\r
-            return i;\r
-        }\r
-    }\r
-\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
-        {\r
-            if (!jalview.util.Comparison.isGap((sequence.charAt(j))))\r
-            {\r
-                pos++;\r
-            }\r
-\r
-            j++;\r
-        }\r
-\r
-        return pos;\r
-    }\r
-\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(jalview.util.Comparison.GapChars, sequence);\r
-        int[] map = new int[seq.length()];\r
-        int j = 0;\r
-        int p = 0;\r
-\r
-        while (j < sequence.length())\r
-        {\r
-            if (!jalview.util.Comparison.isGap(sequence.charAt(j)))\r
-            {\r
-                map[p++] = j;\r
-            }\r
-\r
-            j++;\r
-        }\r
-\r
-        return map;\r
-    }\r
-\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
-    /**\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
-        {\r
-            sequence = sequence.substring(0, i);\r
-        }\r
-        else\r
-        {\r
-            sequence = sequence.substring(0, i) + sequence.substring(j);\r
-        }\r
-    }\r
-\r
-\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)\r
-    {\r
-        String tmp = new String(sequence);\r
-\r
-        if (i < sequence.length())\r
-        {\r
-            sequence = tmp.substring(0, i) + String.valueOf(c) +\r
-                tmp.substring(i);\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
-            for (int j = 0, k = ch.length; j < k; j++)\r
-                ch[j] = c;\r
-\r
-            sequence = tmp + String.valueOf(ch);\r
-        }\r
-    }\r
-\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
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    public Color getColor()\r
-    {\r
-        return color;\r
-    }\r
-\r
-    public String getVamsasId()\r
-    {\r
-      return vamsasId;\r
-    }\r
-\r
-    public void setVamsasId(String id)\r
-    {\r
-      vamsasId = id;\r
-    }\r
-\r
-    public void setDBRef(DBRefEntry [] dbref)\r
-    {\r
-      dbrefs = dbref;\r
-    }\r
-\r
-    public DBRefEntry [] getDBRef()\r
-    {\r
-      return dbrefs;\r
-    }\r
-\r
-    public void addDBRef(DBRefEntry entry)\r
-    {\r
-      if(dbrefs == null)\r
-        dbrefs = new DBRefEntry[0];\r
-\r
-      DBRefEntry [] temp = new DBRefEntry[dbrefs.length+1];\r
-      System.arraycopy(dbrefs, 0, temp, 0, dbrefs.length);\r
-\r
-      temp[temp.length-1] = entry;\r
-\r
-      dbrefs = temp;\r
-    }\r
-\r
-    public void setDatasetSequence(SequenceI seq)\r
-    {\r
-      datasetSequence = seq;\r
-    }\r
-\r
-    public SequenceI getDatasetSequence()\r
-    {\r
-      return datasetSequence;\r
-    }\r
-\r
-    public AlignmentAnnotation [] getAnnotation()\r
-    {\r
-      if(annotation==null)\r
-        return null;\r
-\r
-      AlignmentAnnotation [] ret = new AlignmentAnnotation[annotation.size()];\r
-      for(int r = 0; r<ret.length; r++)\r
-        ret[r] = (AlignmentAnnotation)annotation.elementAt(r);\r
-\r
-      return ret;\r
-    }\r
-\r
-    public void addAlignmentAnnotation(AlignmentAnnotation annotation)\r
-    {\r
-      if(this.annotation==null)\r
-        this.annotation = new Vector();\r
-\r
-      this.annotation.addElement( annotation );\r
-    }\r
-\r
-    public SequenceGroup getHiddenSequences()\r
-    {\r
-      return hiddenSequences;\r
-    }\r
-\r
-    public void addHiddenSequence(SequenceI seq)\r
-    {\r
-      if(hiddenSequences==null)\r
-      {\r
-        hiddenSequences = new SequenceGroup();\r
-      }\r
-      hiddenSequences.addSequence(seq, false);\r
-    }\r
-\r
-    public void showHiddenSequence(SequenceI seq)\r
-    {\r
-      hiddenSequences.deleteSequence(seq, false);\r
-      if (hiddenSequences.getSize(false) < 1)\r
-      {\r
-        hiddenSequences = null;\r
-      }\r
-    }\r
-\r
-    public void changeCase(boolean toUpper, int start, int end)\r
-    {\r
-      StringBuffer newSeq = new StringBuffer();\r
-\r
-      if(end>sequence.length())\r
-        end = sequence.length();\r
-\r
-      if (start > 0)\r
-      {\r
-        newSeq.append(sequence.substring(0, start));\r
-      }\r
-\r
-      if (toUpper)\r
-        newSeq.append(sequence.substring(start, end).toUpperCase());\r
-      else\r
-        newSeq.append(sequence.substring(start, end).toLowerCase());\r
-\r
-      if (end < sequence.length())\r
-        newSeq.append(sequence.substring(end));\r
-\r
-      sequence = newSeq.toString();\r
-    }\r
-\r
-    public void toggleCase(int start, int end)\r
-    {\r
-      StringBuffer newSeq = new StringBuffer();\r
-\r
-     if(end>sequence.length())\r
-       end = sequence.length();\r
-\r
-     if (start > 0)\r
-     {\r
-       newSeq.append(sequence.substring(0, start));\r
-     }\r
-\r
-     char nextChar;\r
-     for(int c=start; c<end; c++)\r
-     {\r
-       nextChar = sequence.charAt(c);\r
-       if(Character.isLetter(nextChar))\r
-       {\r
-         if(Character.isUpperCase(nextChar))\r
-           nextChar = Character.toLowerCase(nextChar);\r
-         else\r
-           nextChar = Character.toUpperCase(nextChar);\r
-       }\r
-\r
-\r
-       newSeq.append(nextChar);\r
-     }\r
-\r
-     if (end < sequence.length())\r
-       newSeq.append(sequence.substring(end));\r
-\r
-     sequence = newSeq.toString();\r
-    }\r
-\r
-}\r
+/*
+* Jalview - A Sequence Alignment Editor and Viewer
+* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+*
+* This program 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 2
+* of the License, or (at your option) any later version.
+*
+* This program 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 this program; if not, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+*/
+package jalview.datamodel;
+
+import java.awt.*;
+
+import java.util.*;
+
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class Sequence implements SequenceI
+{
+    SequenceI datasetSequence;
+    String name;
+    private String sequence;
+    String description;
+    int start;
+    int end;
+    Color color = Color.white;
+    Vector pdbIds;
+    String vamsasId;
+    DBRefEntry [] dbrefs;
+
+    /** This annotation is displayed below the alignment but the
+     * positions are tied to the residues of this sequence */
+    Vector annotation;
+
+    /** DOCUMENT ME!! */
+    public SequenceFeature [] sequenceFeatures;
+
+    /** This array holds hidden sequences
+     * of which this sequence is the representitive member of a group
+     */
+    SequenceGroup hiddenSequences;
+
+    /**
+     * Creates a new Sequence object.
+     *
+     * @param name DOCUMENT ME!
+     * @param sequence DOCUMENT ME!
+     * @param start DOCUMENT ME!
+     * @param end DOCUMENT ME!
+     */
+    public Sequence(String name, String sequence, int start, int end)
+    {
+      this.name = name;
+      this.sequence = sequence;
+      this.start = start;
+      this.end = end;
+
+      parseId();
+
+      checkValidRange();
+    }
+
+    com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(
+                        "[/][0-9]{1,}[-][0-9]{1,}$");
+    com.stevesoft.pat.Regex endrx = new com.stevesoft.pat.Regex(
+                        "[0-9]{1,}$");
+
+    void parseId()
+    {
+        // Does sequence have the /start-end signiature?
+         if(limitrx.search(name))
+         {
+            name = limitrx.left();
+            endrx.search(limitrx.stringMatched());
+            setStart( Integer.parseInt( limitrx.stringMatched().substring(1,endrx.matchedFrom()-1 )));
+            setEnd(   Integer.parseInt( endrx.stringMatched() ));
+         }
+    }
+
+    void checkValidRange()
+    {
+      if (end < 1)
+      {
+        int endRes = 0;
+        char ch;
+        for (int j = 0; j < sequence.length(); j++)
+        {
+          ch = sequence.charAt(j);
+          if (!jalview.util.Comparison.isGap( (ch)))
+          {
+            endRes++;
+          }
+        }
+        if (endRes > 0)
+        {
+          endRes += start - 1;
+        }
+
+        this.end = endRes;
+      }
+
+    }
+
+    /**
+     * Creates a new Sequence object.
+     *
+     * @param name DOCUMENT ME!
+     * @param sequence DOCUMENT ME!
+     */
+    public Sequence(String name, String sequence)
+    {
+        this(name, sequence, 1, -1);
+    }
+
+    /**
+     * Creates a new Sequence object.
+     *
+     * @param seq DOCUMENT ME!
+     */
+    public Sequence(SequenceI seq)
+    {
+        this(seq.getName(), seq.getSequence(), seq.getStart(), seq.getEnd());
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param v DOCUMENT ME!
+     */
+    public void setSequenceFeatures(SequenceFeature [] features)
+    {
+        sequenceFeatures = features;
+    }
+
+    public synchronized void addSequenceFeature(SequenceFeature sf)
+    {
+      if(sequenceFeatures==null)
+      {
+        sequenceFeatures = new SequenceFeature[0];
+      }
+
+      for(int i=0; i<sequenceFeatures.length; i++)
+      {
+        if(sequenceFeatures[i].equals(sf))
+        {
+          return;
+        }
+      }
+
+      SequenceFeature [] temp = new SequenceFeature[sequenceFeatures.length+1];
+      System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length);
+      temp[sequenceFeatures.length] = sf;
+
+      sequenceFeatures = temp;
+    }
+
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public SequenceFeature [] getSequenceFeatures()
+    {
+        return sequenceFeatures;
+    }
+
+    public void addPDBId(PDBEntry entry)
+    {
+      if(pdbIds == null)
+        pdbIds = new Vector();
+
+      pdbIds.addElement(entry);
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param id DOCUMENT ME!
+     */
+    public void setPDBId(Vector id)
+    {
+        pdbIds = id;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Vector getPDBId()
+    {
+        return pdbIds;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public String getDisplayId(boolean jvsuffix)
+    {
+      StringBuffer result = new StringBuffer(name);
+      if (jvsuffix)
+      {
+        result.append("/" + start + "-" + end);
+      }
+
+      return result.toString();
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param name DOCUMENT ME!
+     */
+    public void setName(String name)
+    {
+      this.name = name;
+      this.parseId();
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public String getName()
+    {
+       return this.name;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param start DOCUMENT ME!
+     */
+    public void setStart(int start)
+    {
+        this.start = start;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getStart()
+    {
+        return this.start;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param end DOCUMENT ME!
+     */
+    public void setEnd(int end)
+    {
+        this.end = end;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getEnd()
+    {
+        return this.end;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getLength()
+    {
+        return this.sequence.length();
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param seq DOCUMENT ME!
+     */
+    public void setSequence(String seq)
+    {
+        this.sequence = seq;
+        checkValidRange();
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public String getSequence()
+    {
+        return this.sequence;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param start DOCUMENT ME!
+     * @param end DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public String getSequence(int start, int end)
+    {
+        // JBPNote - left to user to pad the result here (TODO:Decide on this policy)
+        if (start >= sequence.length())
+        {
+            return "";
+        }
+
+        if (end >= sequence.length())
+        {
+            end = sequence.length();
+        }
+
+        return this.sequence.substring(start, end);
+    }
+    /**
+     * make a new Sequence object from start to end (including gaps) over this seqeunce
+     * @param start int
+     * @param end int
+     * @return SequenceI
+     */
+    public SequenceI getSubSequence(int start, int end) {
+      if (start<0)
+        start = 0;
+      String seq = getSequence(start, end);
+      if (seq=="")
+        return null;
+      int nstart = findPosition(start);
+      int nend=findPosition(end-1)-1;
+      // JBPNote - this is an incomplete copy.
+      SequenceI nseq = new Sequence(this.getName(), seq, nstart, nend);
+      nseq.setDatasetSequence(getDatasetSequence());
+      return nseq;
+    }
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public char getCharAt(int i)
+    {
+        if (i < sequence.length())
+        {
+            return sequence.charAt(i);
+        }
+        else
+        {
+            return ' ';
+        }
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param desc DOCUMENT ME!
+     */
+    public void setDescription(String desc)
+    {
+        this.description = desc;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public String getDescription()
+    {
+        return this.description;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param pos DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int findIndex(int pos)
+    {
+        // returns the alignment position for a residue
+        int j = start;
+        int i = 0;
+
+        while ((i < sequence.length()) && (j <= end) && (j <= pos))
+        {
+            if (!jalview.util.Comparison.isGap(sequence.charAt(i)))
+            {
+                j++;
+            }
+
+            i++;
+        }
+
+        if ((j == end) && (j < pos))
+        {
+            return end + 1;
+        }
+        else
+        {
+            return i;
+        }
+    }
+
+    /**
+     * Returns the sequence position for an alignment position
+     *
+     * @param i column index in alignment (from 1)
+     *
+     * @return residue number for residue (left of and) nearest ith column
+     */
+    public int findPosition(int i)
+    {
+        int j = 0;
+        int pos = start;
+        int seqlen=sequence.length();
+        while ((j < i) && (j < seqlen))
+        {
+            if (!jalview.util.Comparison.isGap((sequence.charAt(j))))
+            {
+                pos++;
+            }
+
+            j++;
+        }
+
+        return pos;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int[] gapMap()
+    {
+        // Returns an int array giving the position of each residue in the sequence in the alignment
+        String seq = jalview.analysis.AlignSeq.extractGaps(jalview.util.Comparison.GapChars, sequence);
+        int[] map = new int[seq.length()];
+        int j = 0;
+        int p = 0;
+
+        while (j < sequence.length())
+        {
+            if (!jalview.util.Comparison.isGap(sequence.charAt(j)))
+            {
+                map[p++] = j;
+            }
+
+            j++;
+        }
+
+        return map;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     */
+    public void deleteCharAt(int i)
+    {
+        if (i >= sequence.length())
+        {
+            return;
+        }
+
+        sequence = sequence.substring(0, i) + sequence.substring(i + 1);
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     * @param j DOCUMENT ME!
+     */
+    public void deleteChars(int i, int j)
+    {
+        if (i >= sequence.length())
+        {
+            return;
+        }
+
+        if (j >= sequence.length())
+        {
+            sequence = sequence.substring(0, i);
+        }
+        else
+        {
+            sequence = sequence.substring(0, i) + sequence.substring(j);
+        }
+    }
+
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     * @param c DOCUMENT ME!
+     * @param chop DOCUMENT ME!
+     */
+    public void insertCharAt(int i, char c)
+    {
+        String tmp = new String(sequence);
+
+        if (i < sequence.length())
+        {
+            sequence = tmp.substring(0, i) + String.valueOf(c) +
+                tmp.substring(i);
+        }
+        else
+        {
+            // JBPNote : padding char at end of sequence. We'll not get away with this when we insert residues, I bet!
+            char[] ch = new char[(1 + i) - sequence.length()];
+
+            for (int j = 0, k = ch.length; j < k; j++)
+                ch[j] = c;
+
+            sequence = tmp + String.valueOf(ch);
+        }
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param c DOCUMENT ME!
+     */
+    public void setColor(Color c)
+    {
+        this.color = c;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Color getColor()
+    {
+        return color;
+    }
+
+    public String getVamsasId()
+    {
+      return vamsasId;
+    }
+
+    public void setVamsasId(String id)
+    {
+      vamsasId = id;
+    }
+
+    public void setDBRef(DBRefEntry [] dbref)
+    {
+      dbrefs = dbref;
+    }
+
+    public DBRefEntry [] getDBRef()
+    {
+      return dbrefs;
+    }
+
+    public void addDBRef(DBRefEntry entry)
+    {
+      if(dbrefs == null)
+        dbrefs = new DBRefEntry[0];
+
+      DBRefEntry [] temp = new DBRefEntry[dbrefs.length+1];
+      System.arraycopy(dbrefs, 0, temp, 0, dbrefs.length);
+
+      temp[temp.length-1] = entry;
+
+      dbrefs = temp;
+    }
+
+    public void setDatasetSequence(SequenceI seq)
+    {
+      datasetSequence = seq;
+    }
+
+    public SequenceI getDatasetSequence()
+    {
+      return datasetSequence;
+    }
+
+    public AlignmentAnnotation [] getAnnotation()
+    {
+      if(annotation==null)
+        return null;
+
+      AlignmentAnnotation [] ret = new AlignmentAnnotation[annotation.size()];
+      for(int r = 0; r<ret.length; r++)
+        ret[r] = (AlignmentAnnotation)annotation.elementAt(r);
+
+      return ret;
+    }
+
+    public void addAlignmentAnnotation(AlignmentAnnotation annotation)
+    {
+      if(this.annotation==null)
+        this.annotation = new Vector();
+
+      this.annotation.addElement( annotation );
+    }
+
+    public SequenceGroup getHiddenSequences()
+    {
+      return hiddenSequences;
+    }
+
+    public void addHiddenSequence(SequenceI seq)
+    {
+      if(hiddenSequences==null)
+      {
+        hiddenSequences = new SequenceGroup();
+      }
+      hiddenSequences.addSequence(seq, false);
+    }
+
+    public void showHiddenSequence(SequenceI seq)
+    {
+      hiddenSequences.deleteSequence(seq, false);
+      if (hiddenSequences.getSize(false) < 1)
+      {
+        hiddenSequences = null;
+      }
+    }
+
+    public void changeCase(boolean toUpper, int start, int end)
+    {
+      StringBuffer newSeq = new StringBuffer();
+
+      if(end>sequence.length())
+        end = sequence.length();
+
+      if (start > 0)
+      {
+        newSeq.append(sequence.substring(0, start));
+      }
+
+      if (toUpper)
+        newSeq.append(sequence.substring(start, end).toUpperCase());
+      else
+        newSeq.append(sequence.substring(start, end).toLowerCase());
+
+      if (end < sequence.length())
+        newSeq.append(sequence.substring(end));
+
+      sequence = newSeq.toString();
+    }
+
+    public void toggleCase(int start, int end)
+    {
+      StringBuffer newSeq = new StringBuffer();
+
+     if(end>sequence.length())
+       end = sequence.length();
+
+     if (start > 0)
+     {
+       newSeq.append(sequence.substring(0, start));
+     }
+
+     char nextChar;
+     for(int c=start; c<end; c++)
+     {
+       nextChar = sequence.charAt(c);
+       if(Character.isLetter(nextChar))
+       {
+         if(Character.isUpperCase(nextChar))
+           nextChar = Character.toLowerCase(nextChar);
+         else
+           nextChar = Character.toUpperCase(nextChar);
+       }
+
+
+       newSeq.append(nextChar);
+     }
+
+     if (end < sequence.length())
+       newSeq.append(sequence.substring(end));
+
+     sequence = newSeq.toString();
+    }
+
+}