X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequence.java;h=910c86df2bdb7dbc56363767d0ad42b116f3dd18;hb=b2f9a8d7bce642ff4011bc6d49e02bb0569fbb11;hp=56a829cae1c684ec029d8f7eaa16dc3127c731e8;hpb=ed9c5fe20f052a1003d27a2c114b9bbcaca80190;p=jalview.git diff --git a/src/jalview/datamodel/Sequence.java b/src/jalview/datamodel/Sequence.java index 56a829c..910c86d 100755 --- a/src/jalview/datamodel/Sequence.java +++ b/src/jalview/datamodel/Sequence.java @@ -1,26 +1,27 @@ /* - * 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 + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1) + * Copyright (C) 2014 The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview 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 3 of the License, or (at your option) any later version. + * + * Jalview 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 Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.datamodel; -import java.util.*; +import jalview.analysis.AlignSeq; -import jalview.analysis.*; +import java.util.Enumeration; +import java.util.Vector; /** * @@ -55,6 +56,11 @@ public class Sequence implements SequenceI */ Vector annotation; + /** + * The index of the sequence in a MSA + */ + int index = -1; + /** array of seuqence features - may not be null for a valid sequence object */ public SequenceFeature[] sequenceFeatures; @@ -62,14 +68,14 @@ public class Sequence implements SequenceI * Creates a new Sequence object. * * @param name - * display name string + * display name string * @param sequence - * string to form a possibly gapped sequence out of + * string to form a possibly gapped sequence out of * @param start - * first position of non-gap residue in the sequence + * first position of non-gap residue in the sequence * @param end - * last position of ungapped residues (nearly always only used - * for display purposes) + * last position of ungapped residues (nearly always only used for + * display purposes) */ public Sequence(String name, String sequence, int start, int end) { @@ -117,7 +123,8 @@ public class Sequence implements SequenceI void checkValidRange() { - if (end < 1) + // Note: JAL-774 : + // http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239 { int endRes = 0; for (int j = 0; j < sequence.length; j++) @@ -132,7 +139,10 @@ public class Sequence implements SequenceI endRes += start - 1; } - this.end = endRes; + if (end < endRes) + { + end = endRes; + } } } @@ -141,9 +151,9 @@ public class Sequence implements SequenceI * Creates a new Sequence object. * * @param name - * DOCUMENT ME! + * DOCUMENT ME! * @param sequence - * DOCUMENT ME! + * DOCUMENT ME! */ public Sequence(String name, String sequence) { @@ -156,7 +166,7 @@ public class Sequence implements SequenceI * reference. * * @param seq - * DOCUMENT ME! + * DOCUMENT ME! */ public Sequence(SequenceI seq) { @@ -169,9 +179,9 @@ public class Sequence implements SequenceI * annotation that is present in the given annotation array. * * @param seq - * the sequence to be copied + * the sequence to be copied * @param alAnnotation - * an array of annotation including some associated with seq + * an array of annotation including some associated with seq */ public Sequence(SequenceI seq, AlignmentAnnotation[] alAnnotation) { @@ -186,7 +196,7 @@ public class Sequence implements SequenceI } } setDatasetSequence(seq.getDatasetSequence()); - if (datasetSequence==null && seq.getDBRef() != null) + if (datasetSequence == null && seq.getDBRef() != null) { // only copy DBRefs if we really are a dataset sequence DBRefEntry[] dbr = seq.getDBRef(); @@ -235,7 +245,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param v - * DOCUMENT ME! + * DOCUMENT ME! */ public void setSequenceFeatures(SequenceFeature[] features) { @@ -331,7 +341,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param id - * DOCUMENT ME! + * DOCUMENT ME! */ public void setPDBId(Vector id) { @@ -368,7 +378,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param name - * DOCUMENT ME! + * DOCUMENT ME! */ public void setName(String name) { @@ -390,7 +400,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param start - * DOCUMENT ME! + * DOCUMENT ME! */ public void setStart(int start) { @@ -411,7 +421,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param end - * DOCUMENT ME! + * DOCUMENT ME! */ public void setEnd(int end) { @@ -442,7 +452,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param seq - * DOCUMENT ME! + * DOCUMENT ME! */ public void setSequence(String seq) { @@ -497,9 +507,9 @@ public class Sequence implements SequenceI * seqeunce * * @param start - * int + * int * @param end - * int + * int * @return SequenceI */ public SequenceI getSubSequence(int start, int end) @@ -533,7 +543,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param i - * DOCUMENT ME! + * DOCUMENT ME! * * @return DOCUMENT ME! */ @@ -553,7 +563,7 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param desc - * DOCUMENT ME! + * DOCUMENT ME! */ public void setDescription(String desc) { @@ -570,20 +580,17 @@ public class Sequence implements SequenceI return this.description; } - /** - * Return the alignment position for a sequence position - * - * @param pos - * lying from start to end + /* + * (non-Javadoc) * - * @return aligned position of residue pos + * @see jalview.datamodel.SequenceI#findIndex(int) */ public int findIndex(int pos) { // returns the alignment position for a residue int j = start; int i = 0; - + // Rely on end being at least as long as the length of the sequence. while ((i < sequence.length) && (j <= end) && (j <= pos)) { if (!jalview.util.Comparison.isGap(sequence[i])) @@ -608,7 +615,7 @@ public class Sequence implements SequenceI * Returns the sequence position for an alignment position * * @param i - * column index in alignment (from 1) + * column index in alignment (from 1) * * @return residue number for residue (left of and) nearest ith column */ @@ -657,6 +664,7 @@ public class Sequence implements SequenceI return map; } + /* * (non-Javadoc) * @@ -680,6 +688,7 @@ public class Sequence implements SequenceI } return map; } + /* * (non-Javadoc) * @@ -699,6 +708,7 @@ public class Sequence implements SequenceI { tmp = new char[i]; System.arraycopy(sequence, 0, tmp, 0, i); + j=sequence.length; } else { @@ -707,6 +717,9 @@ public class Sequence implements SequenceI System.arraycopy(sequence, j, tmp, i, sequence.length - j); } boolean createNewDs = false; + // TODO: take a look at the new dataset creation validation method below - + // this could become time comsuming for large sequences - consider making it + // more efficient for (int s = i; s < j; s++) { if (jalview.schemes.ResidueProperties.aaIndex[sequence[s]] != 23) @@ -738,7 +751,7 @@ public class Sequence implements SequenceI { createNewDs = true; newend--; // decrease end position by one for the deleted residue - // and search further + // and search further } } } @@ -763,11 +776,11 @@ public class Sequence implements SequenceI * DOCUMENT ME! * * @param i - * DOCUMENT ME! + * DOCUMENT ME! * @param c - * DOCUMENT ME! + * DOCUMENT ME! * @param chop - * DOCUMENT ME! + * DOCUMENT ME! */ public void insertCharAt(int i, int length, char c) { @@ -820,7 +833,8 @@ public class Sequence implements SequenceI public DBRefEntry[] getDBRef() { - if (dbrefs==null && datasetSequence!=null && this!=datasetSequence) + if (dbrefs == null && datasetSequence != null + && this != datasetSequence) { return datasetSequence.getDBRef(); } @@ -891,8 +905,10 @@ public class Sequence implements SequenceI { this.annotation = new Vector(); } - - this.annotation.addElement(annotation); + if (!this.annotation.contains(annotation)) + { + this.annotation.addElement(annotation); + } annotation.setSequenceRef(this); } @@ -981,6 +997,18 @@ public class Sequence implements SequenceI datasetSequence.setPDBId(getPDBId()); setPDBId(null); datasetSequence.updatePDBIds(); + if (annotation != null) + { + Vector _annot = annotation; + annotation = null; + for (AlignmentAnnotation aa : _annot) + { + aa.sequenceRef = datasetSequence; + aa.adjustForAlignment(); // uses annotation's own record of + // sequence-column mapping + datasetSequence.addAlignmentAnnotation(aa); + } + } } return datasetSequence; } @@ -988,8 +1016,9 @@ public class Sequence implements SequenceI /* * (non-Javadoc) * - * @see jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[] - * annotations) + * @see + * jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[] + * annotations) */ public void setAlignmentAnnotation(AlignmentAnnotation[] annotations) { @@ -1100,8 +1129,9 @@ public class Sequence implements SequenceI /* * (non-Javadoc) * - * @see jalview.datamodel.SequenceI#transferAnnotation(jalview.datamodel.SequenceI, - * jalview.datamodel.Mapping) + * @see + * jalview.datamodel.SequenceI#transferAnnotation(jalview.datamodel.SequenceI, + * jalview.datamodel.Mapping) */ public void transferAnnotation(SequenceI entry, Mapping mp) { @@ -1166,4 +1196,25 @@ public class Sequence implements SequenceI } } + /** + * @return The index (zero-based) on this sequence in the MSA. It returns + * {@code -1} if this information is not available. + */ + public int getIndex() + { + return index; + } + + /** + * Defines the position of this sequence in the MSA. Use the value {@code -1} + * if this information is undefined. + * + * @param The + * position for this sequence. This value is zero-based (zero for + * this first sequence) + */ + public void setIndex(int value) + { + index = value; + } }