X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequenceI.java;h=38ae3721db1e9ef8715feea6694dc2e14461a0cd;hb=4ee76627c6ec3c5fcaa11527776d248948f22ce7;hp=46669ae037829c70f142e37799cd8c3a9e3e9db2;hpb=393316810f2e54f069863145fb35102c6e889d50;p=jalview.git diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java index 46669ae..38ae372 100755 --- a/src/jalview/datamodel/SequenceI.java +++ b/src/jalview/datamodel/SequenceI.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) - * Copyright (C) 2014 The Jalview Authors + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * @@ -134,12 +134,13 @@ public interface SequenceI public char[] getSequence(int start, int end); /** - * create a new sequence object from start to end of this sequence + * create a new sequence object with a subsequence of this one but sharing the + * same dataset sequence * * @param start - * int index for start position + * int index for start position (base 0, inclusive) * @param end - * int index for end position + * int index for end position (base 0, exclusive) * * @return SequenceI * @note implementations may use getSequence to get the sequence data @@ -147,12 +148,12 @@ public interface SequenceI public SequenceI getSubSequence(int start, int end); /** - * DOCUMENT ME! + * get the i'th character in this sequence's local reference frame (ie from + * 0-number of characters lying from start-end) * * @param i - * DOCUMENT ME! - * - * @return DOCUMENT ME! + * index + * @return character or ' ' */ public char getCharAt(int i); @@ -172,8 +173,7 @@ public interface SequenceI public String getDescription(); /** - * Return the alignment column for a sequence position * Return the alignment - * position for a sequence position + * Return the alignment column for a sequence position * * @param pos * lying from start to end @@ -220,9 +220,9 @@ public interface SequenceI * if necessary and adjusting start and end positions accordingly. * * @param i - * first column in range to delete + * first column in range to delete (inclusive) * @param j - * last column in range to delete + * last column in range to delete (exclusive) */ public void deleteChars(int i, int j); @@ -238,13 +238,12 @@ public interface SequenceI /** * DOCUMENT ME! - * - * @param i + * @param position * DOCUMENT ME! - * @param c + * @param ch * DOCUMENT ME! */ - public void insertCharAt(int i, int length, char c); + public void insertCharAt(int position, int count, char ch); /** * DOCUMENT ME! @@ -267,14 +266,14 @@ public interface SequenceI * @param id * DOCUMENT ME! */ - public void setPDBId(Vector ids); + public void setPDBId(Vector ids); /** - * DOCUMENT ME! + * Returns a list * * @return DOCUMENT ME! */ - public Vector getPDBId(); + public Vector getPDBId(); /** * add entry to the vector of PDBIds, if it isn't in the list already @@ -414,4 +413,10 @@ public interface SequenceI */ public void setRNA(RNA rna); + /** + * + * @return list of insertions (gap characters) in sequence + */ + public List getInsertions(); + }