X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequence.java;h=2303d5d46fbc4de8a4f116899f1261f6210166a4;hb=7157dfd20efd2e1db47db1ac12e879eb51c67b92;hp=dee67d374f3d7e4111b645763fca0eb3e0f068c3;hpb=c431a65bbe794a0dd27f3f806d3c5cf37c53279c;p=jalview.git diff --git a/src/jalview/datamodel/Sequence.java b/src/jalview/datamodel/Sequence.java index dee67d3..2303d5d 100755 --- a/src/jalview/datamodel/Sequence.java +++ b/src/jalview/datamodel/Sequence.java @@ -1,27 +1,26 @@ /* -* 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 -*/ + * Jalview - A Sequence Alignment Editor and Viewer + * Copyright (C) 2007 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.*; +import jalview.analysis.*; /** * DOCUMENT ME! @@ -29,685 +28,744 @@ import java.util.*; * @author $author$ * @version $Revision$ */ -public class Sequence implements SequenceI +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) + SequenceI datasetSequence; + String name; + private char[] sequence; + String description; + int start; + int end; + 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; + + /** + * 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.toCharArray(); + this.start = start; + this.end = end; + parseId(); + checkValidRange(); + } + + public Sequence(String name, char[] 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; + for (int j = 0; j < sequence.length; j++) { - int endRes = 0; - char ch; - for (int j = 0; j < sequence.length(); j++) + if (!jalview.util.Comparison.isGap(sequence[j])) { - ch = sequence.charAt(j); - if (!jalview.util.Comparison.isGap( (ch))) - { - endRes++; - } + endRes++; } - if (endRes > 0) - { - endRes += start - 1; - } - - this.end = 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()); + description = seq.getDescription(); + } + + /** + * 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; + } } - /** - * Creates a new Sequence object. - * - * @param name DOCUMENT ME! - * @param sequence DOCUMENT ME! - */ - public Sequence(String name, String sequence) - { - this(name, sequence, 1, -1); - } + SequenceFeature[] temp = new SequenceFeature[sequenceFeatures.length + 1]; + System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length); + temp[sequenceFeatures.length] = sf; - /** - * Creates a new Sequence object. - * - * @param seq DOCUMENT ME! - */ - public Sequence(SequenceI seq) - { - this(seq.getName(), seq.getSequence(), seq.getStart(), seq.getEnd()); - } + sequenceFeatures = temp; + } - /** - * DOCUMENT ME! - * - * @param v DOCUMENT ME! - */ - public void setSequenceFeatures(SequenceFeature [] features) + public void deleteFeature(SequenceFeature sf) + { + if (sequenceFeatures == null) { - sequenceFeatures = features; + return; } - public synchronized void addSequenceFeature(SequenceFeature sf) + int index = 0; + for (index = 0; index < sequenceFeatures.length; index++) { - if(sequenceFeatures==null) + if (sequenceFeatures[index].equals(sf)) { - sequenceFeatures = new SequenceFeature[0]; + break; } - - for(int i=0; i= sequence.length) + { + return new char[0]; + } + + if (end >= sequence.length) + { + end = sequence.length; + } + + char[] reply = new char[end - start]; + System.arraycopy(sequence, start, reply, 0, end - start); + + return reply; + } + + /** + * 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; + } + char[] seq = getSequence(start, end); + if (seq.length == 0) + { + return null; + } + int nstart = findPosition(start); + int nend = findPosition(end) - 1; + // JBPNote - this is an incomplete copy. + SequenceI nseq = new Sequence(this.getName(), seq, nstart, nend); + nseq.setDescription(description); + if (datasetSequence != null) + { + nseq.setDatasetSequence(datasetSequence); + } + else + { + nseq.setDatasetSequence(this); + } + return nseq; + } + + /** + * DOCUMENT ME! + * + * @param i DOCUMENT ME! + * + * @return DOCUMENT ME! + */ + public char getCharAt(int i) + { + if (i < sequence.length) + { + return sequence[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; - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public String getDisplayId(boolean jvsuffix) + while ( (i < sequence.length) && (j <= end) && (j <= pos)) { - StringBuffer result = new StringBuffer(name); - if (jvsuffix) + if (!jalview.util.Comparison.isGap(sequence[i])) { - result.append("/" + start + "-" + end); + j++; } - return result.toString(); + i++; } - /** - * DOCUMENT ME! - * - * @param name DOCUMENT ME! - */ - public void setName(String name) + if ( (j == end) && (j < pos)) { - this.name = name; - this.parseId(); + return end + 1; } - - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public String getName() + else { - return this.name; + return i; } + } - /** - * DOCUMENT ME! - * - * @param start DOCUMENT ME! - */ - public void setStart(int start) + /** + * 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)) { - this.start = start; - } + if (!jalview.util.Comparison.isGap(sequence[j])) + { + pos++; + } - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public int getStart() - { - return this.start; + j++; } - /** - * DOCUMENT ME! - * - * @param end DOCUMENT ME! - */ - public void setEnd(int end) - { - this.end = end; - } + return pos; + } - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public int getEnd() - { - return this.end; - } + /** + * Returns an int array where indices correspond to each residue in the sequence and the element value gives its position in the alignment + * + * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no residues in SequenceI object + */ + public int[] gapMap() + { + String seq = jalview.analysis.AlignSeq.extractGaps(jalview.util.Comparison. + GapChars, new String(sequence)); + int[] map = new int[seq.length()]; + int j = 0; + int p = 0; - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public int getLength() + while (j < sequence.length) { - return this.sequence.length(); - } + if (!jalview.util.Comparison.isGap(sequence[j])) + { + map[p++] = j; + } - /** - * DOCUMENT ME! - * - * @param seq DOCUMENT ME! - */ - public void setSequence(String seq) - { - this.sequence = seq; - checkValidRange(); + j++; } - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public String getSequence() - { - return this.sequence; - } + return map; + } - /** - * DOCUMENT ME! - * - * @param start DOCUMENT ME! - * @param end DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public String getSequence(int start, int end) + /** + * DOCUMENT ME! + * + * @param i DOCUMENT ME! + * @param j DOCUMENT ME! + */ + public void deleteChars(int i, int j) + { + if (i >= sequence.length) { - // 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 ' '; - } + return; } - /** - * DOCUMENT ME! - * - * @param desc DOCUMENT ME! - */ - public void setDescription(String desc) - { - this.description = desc; - } + char[] tmp; - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public String getDescription() + if (j >= sequence.length) { - return this.description; + tmp = new char[i]; + System.arraycopy(sequence, 0, tmp, 0, i); } - - /** - * DOCUMENT ME! - * - * @param pos DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public int findIndex(int pos) + else { - // 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; - } + tmp = new char[sequence.length - j + i]; + System.arraycopy(sequence, 0, tmp, 0, i); + System.arraycopy(sequence, j, tmp, i, sequence.length - j); } - /** - * 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) + if (this.datasetSequence != null) { - int j = 0; - int pos = start; - int seqlen=sequence.length(); - while ((j < i) && (j < seqlen)) + for (int s = i; s < j; s++) + { + if (jalview.schemes.ResidueProperties.aaIndex[sequence[s]] != 23) { - if (!jalview.util.Comparison.isGap((sequence.charAt(j)))) - { - pos++; - } - j++; + Sequence ds = new Sequence(name, + AlignSeq.extractGaps( + jalview.util.Comparison.GapChars, + this.getSequenceAsString() + ), + start, + end); + ds.setDescription(description); } - - return pos; + break; + } } - /** - * 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; + sequence = tmp; - while (j < sequence.length()) - { - if (!jalview.util.Comparison.isGap(sequence.charAt(j))) - { - map[p++] = j; - } + } - j++; - } + /** + * DOCUMENT ME! + * + * @param i DOCUMENT ME! + * @param c DOCUMENT ME! + * @param chop DOCUMENT ME! + */ + public void insertCharAt(int i, int length, char c) + { + char[] tmp = new char[sequence.length + length]; - return map; + if (i >= sequence.length) + { + System.arraycopy(sequence, 0, tmp, 0, sequence.length); + i = sequence.length; } - - /** - * DOCUMENT ME! - * - * @param i DOCUMENT ME! - */ - public void deleteCharAt(int i) + else { - if (i >= sequence.length()) - { - return; - } - - sequence = sequence.substring(0, i) + sequence.substring(i + 1); + System.arraycopy(sequence, 0, tmp, 0, i); } - /** - * DOCUMENT ME! - * - * @param i DOCUMENT ME! - * @param j DOCUMENT ME! - */ - public void deleteChars(int i, int j) + int index = i; + while (length > 0) { - if (i >= sequence.length()) - { - return; - } - - if (j >= sequence.length()) - { - sequence = sequence.substring(0, i); - } - else - { - sequence = sequence.substring(0, i) + sequence.substring(j); - } + tmp[index++] = c; + length--; } - - /** - * DOCUMENT ME! - * - * @param i DOCUMENT ME! - * @param c DOCUMENT ME! - * @param chop DOCUMENT ME! - */ - public void insertCharAt(int i, char c) + if (i < sequence.length) { - String tmp = new String(sequence); + System.arraycopy(sequence, i, tmp, index, sequence.length - i); + } - 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()]; + sequence = tmp; + } - for (int j = 0, k = ch.length; j < k; j++) - ch[j] = c; + public void insertCharAt(int i, char c) + { + insertCharAt(i, 1, c); + } - sequence = tmp + String.valueOf(ch); - } - } + public String getVamsasId() + { + return vamsasId; + } - /** - * DOCUMENT ME! - * - * @param c DOCUMENT ME! - */ - public void setColor(Color c) - { - this.color = c; - } + public void setVamsasId(String id) + { + vamsasId = id; + } - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public Color getColor() - { - return color; - } + public void setDBRef(DBRefEntry[] dbref) + { + dbrefs = dbref; + } - public String getVamsasId() - { - return vamsasId; - } + public DBRefEntry[] getDBRef() + { + return dbrefs; + } - public void setVamsasId(String id) + public void addDBRef(DBRefEntry entry) + { + if (dbrefs == null) { - vamsasId = id; + dbrefs = new DBRefEntry[0]; } - public void setDBRef(DBRefEntry [] dbref) - { - dbrefs = dbref; - } + int i, iSize = dbrefs.length; - public DBRefEntry [] getDBRef() + for (i = 0; i < iSize; i++) { - return dbrefs; + if (dbrefs[i].getAccessionId().equals(entry.getAccessionId()) + && dbrefs[i].getSource().equals(entry.getSource()) + && dbrefs[i].getVersion().equals(entry.getVersion())) + { + return; + } } - public void addDBRef(DBRefEntry entry) - { - if(dbrefs == null) - dbrefs = new DBRefEntry[0]; + DBRefEntry[] temp = new DBRefEntry[iSize + 1]; + System.arraycopy(dbrefs, 0, temp, 0, iSize); + temp[temp.length - 1] = entry; - DBRefEntry [] temp = new DBRefEntry[dbrefs.length+1]; - System.arraycopy(dbrefs, 0, temp, 0, dbrefs.length); + dbrefs = temp; + } - temp[temp.length-1] = entry; + public void setDatasetSequence(SequenceI seq) + { + datasetSequence = seq; + } - dbrefs = temp; - } + public SequenceI getDatasetSequence() + { + return datasetSequence; + } - public void setDatasetSequence(SequenceI seq) + public AlignmentAnnotation[] getAnnotation() + { + if (annotation == null) { - datasetSequence = seq; + return null; } - public SequenceI getDatasetSequence() + AlignmentAnnotation[] ret = new AlignmentAnnotation[annotation.size()]; + for (int r = 0; r < ret.length; r++) { - return datasetSequence; + ret[r] = (AlignmentAnnotation) annotation.elementAt(r); } - public AlignmentAnnotation [] getAnnotation() - { - if(annotation==null) - return null; + return ret; + } - AlignmentAnnotation [] ret = new AlignmentAnnotation[annotation.size()]; - for(int r = 0; rsequence.length()) - end = sequence.length(); - - if (start > 0) + if (isValidDatasetSequence()) { - newSeq.append(sequence.substring(0, start)); + seq.setDatasetSequence(this); } - - 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