X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequence.java;h=80dfda54c35e56f521e290d007226b9b0d011e0a;hb=d836fdf0564204d853e3ec844c8dbaec27d3cf23;hp=8928425f607b54b4cff148bc8d93d3b19ec9e921;hpb=58d43be1e7c0bcd32c567ec9dfafc3abee45e20c;p=jalview.git

diff --git a/src/jalview/datamodel/Sequence.java b/src/jalview/datamodel/Sequence.java
index 8928425..80dfda5 100755
--- a/src/jalview/datamodel/Sequence.java
+++ b/src/jalview/datamodel/Sequence.java
@@ -1,200 +1,577 @@
+/*
+* 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 jalview.analysis.*;
 import java.awt.*;
+
 import java.util.*;
-import MCview.*;
 
 
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
 public class Sequence implements SequenceI
 {
-  protected String name;
-  protected String sequence;
-  protected String description;
-  protected int start;
-  protected int end;
-  protected String displayId;
-  protected Color color = Color.white;
-  String pdbId;
-
-   public Vector sequenceFeatures = new Vector();
-   public void setSequenceFeatures(Vector v)
-   {
-     sequenceFeatures = v;
-   }
-
-   public Vector getSequenceFeatures()
-   {return sequenceFeatures; }
-
-   public void setPDBId(String id)
-   {
-     pdbId = id;
-   }
-   public String getPDBId()
-   {
-     return pdbId;
-   }
-
-
-  public Sequence(String name, String sequence, int start, int end)
-  {
-
-    this.name     = name;
-    this.sequence = sequence;
-    this.start    = start;
-    this.end      = end;
-
-    setDisplayId();
-
-  }
-
-  public Sequence(String name,String sequence) {
-    this(name,sequence,1,sequence.length());
-  }
-  public Sequence(SequenceI seq) {
-    this(seq.getName(),seq.getSequence(),seq.getStart(),seq.getEnd());
-  }
-  public String getDisplayId() {
-    return displayId;
-  }
-  public void setDisplayId() {
-    displayId = name + "/" + start + "-" + end;
-  }
-  public void setName(String name) {
-    this.name = name;
-    setDisplayId();
-  }
-  public String getName() {
-    return this.name;
-  }
-  public void setStart(int start) {
-    this.start = start;
-    setDisplayId();
-  }
-  public int getStart() {
-    return this.start;
-  }
-  public void setEnd(int end) {
-    this.end = end;
-    setDisplayId();
-  }
-  public int getEnd() {
-    return this.end;
-  }
-  public int getLength() {
-    return this.sequence.length();
-  }
-  public void setSequence(String seq) {
-    this.sequence = seq;
-  }
-  public String getSequence() {
-    return this.sequence;
-  }
-  public String getSequence(int start,int end) {
-    if(end>sequence.length())
-      end = sequence.length();
-    return this.sequence.substring(start,end);
-  }
-
-  public char getCharAt(int i) {
-    if (i < sequence.length()) {
-      return sequence.charAt(i);
-    } else {
-      return ' ';
-    }
-  }
-  public void setDescription(String desc) {
-    this.description = desc;
-  }
-  public String getDescription() {
-    return this.description;
-  }
-
-  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) {
-
-      char c = sequence.charAt(i);
-
-      if (!jalview.util.Comparison.isGap((c)))
-        j++;
-
-      i++;
-    }
-    if (j == end && j < pos)
-      return end+1;
-    else
-      return i;
-
-  }
-
-  public int findPosition(int i) {
-    // Returns the sequence position for an alignment position
-    int j   = 0;
-    int pos = start;
-
-    while (j < i && j<sequence.length())
-    {
-      char c = sequence.charAt(j);
-      if (!jalview.util.Comparison.isGap((c)))
-        pos++;
-
-      j++;
-    }
-    return pos;
-  }
-
-  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("-. ",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;
+    SequenceI datasetSequence;
+    String name;
+    String sequence;
+    String description;
+    int start;
+    int end;
+    Color color = Color.white;
+    Vector pdbIds;
+    String vamsasId;
+    Vector dbrefs;
+
+
+    /** DOCUMENT ME!! */
+    public Vector sequenceFeatures;
+
+    /**
+     * 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();
+    }
+
+    static com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(
+                        "[/][0-9]{1,}[-][0-9]{1,}$");
+    static 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(Vector v)
+    {
+        sequenceFeatures = v;
+    }
+
+    public void addSequenceFeature(SequenceFeature sf)
+    {
+      if(sequenceFeatures==null)
+        sequenceFeatures = new Vector();
+
+      sequenceFeatures.addElement(sf);
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Vector 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);
       }
-      j++;
+
+      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);
+    }
+
+    /**
+     * 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;
+        }
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int findPosition(int i)
+    {
+        // Returns the sequence position for an alignment position
+        int j = 0;
+        int pos = start;
+
+        while ((j < i) && (j < sequence.length()))
+        {
+            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("-. ", 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;
     }
-    return map;
-  }
 
-  public void deleteCharAt(int i)
-  {
-    sequence = sequence.substring(0,i) + sequence.substring(i+1);
-  }
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     */
+    public void deleteCharAt(int i)
+    {
+        if (i >= sequence.length())
+        {
+            return;
+        }
 
-  public void deleteChars(int i, int j)
-  {
-    sequence = sequence.substring(0,i) + sequence.substring(j);
-  }
+        sequence = sequence.substring(0, i) + sequence.substring(i + 1);
+    }
 
-  public void insertCharAt(int i, char c)
-  {
-    insertCharAt(i,c,true);
-  }
+    /**
+     * 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);
+        }
+    }
 
-  public void insertCharAt(int i,char c,boolean chop) {
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     * @param c DOCUMENT ME!
+     */
+    public void insertCharAt(int i, char c)
+    {
+        insertCharAt(i, c, true);
+    }
 
-    String tmp = new String(sequence);
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     * @param c DOCUMENT ME!
+     * @param chop DOCUMENT ME!
+     */
+    public void insertCharAt(int i, char c, boolean chop)
+    {
+        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);
+        }
+    }
 
-    if (i < sequence.length()) {
-      sequence = tmp.substring(0,i) + String.valueOf(c) + tmp.substring(i);
-    } else {
-      sequence = tmp + String.valueOf(c);
+    /**
+     * 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 void        setColor(Color c) {
-    this.color = c;
-  }
+    public String getVamsasId()
+    {
+      return vamsasId;
+    }
 
-  public Color       getColor() {
-    return color;
-  }
+    public void setVamsasId(String id)
+    {
+      vamsasId = id;
+    }
+
+    public void setDBRef(Vector dbref)
+    {
+      dbrefs = dbref;
+    }
+    public Vector getDBRef()
+    {
+      return dbrefs;
+    }
+
+    public void addDBRef(DBRefEntry entry)
+    {
+      if(dbrefs == null)
+        dbrefs = new Vector();
+
+      dbrefs.addElement(entry);
+    }
+
+    public void setDatasetSequence(SequenceI seq)
+    {
+      datasetSequence = seq;
+    }
+
+    public SequenceI getDatasetSequence()
+    {
+      return datasetSequence;
+    }
 
 }