X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fdatamodel%2FSequenceI.java;h=6e6d1aada4a1e4c5067ecda1dc3fd2e9d7444abd;hb=c55e1fa5d2782cc46e515c11a91cf502f37386ab;hp=cf9d6ad4b70a09908548842223e608932cddbf15;hpb=f41d78dbf890fbb7597f75019d05841312fa4f52;p=jalview.git diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java index cf9d6ad..6e6d1aa 100755 --- a/src/jalview/datamodel/SequenceI.java +++ b/src/jalview/datamodel/SequenceI.java @@ -119,9 +119,9 @@ public interface SequenceI extends ASequenceI public String getSequenceAsString(int start, int end); /** - * Get the sequence as a character array + * Answers a copy of the sequence as a character array * - * @return seqeunce and any gaps + * @return */ public char[] getSequence(); @@ -203,28 +203,14 @@ public interface SequenceI extends ASequenceI public int findPosition(int i); /** - * Returns the range of sequence positions included in the given alignment - * position range. If no positions are included (the range is entirely gaps), - * then returns null. - * - *
-   * Example: 
-   * >Seq/8-13
-   * ABC--DE-F
-   * findPositions(1, 4) returns Range(9, 9) // B only
-   * findPositions(3, 4) returns null // all gaps
-   * findPositions(2, 6) returns Range(10, 12) // CDE
-   * findPositions(3, 7) returns Range(11,12) // DE
-   * 
- * - * @param fromCol - * first aligned column position (base 0, inclusive) - * @param toCol - * last aligned column position (base 0, inclusive) + * Returns the from-to sequence positions (start..) for the given column + * positions (1..), or null if no residues are included in the range * + * @param fromColum + * @param toColumn * @return */ - public Range findPositions(int fromCol, int toCol); + public Range findPositions(int fromColum, int toColumn); /** * Returns an int array where indices correspond to each residue in the @@ -290,7 +276,7 @@ public interface SequenceI extends ASequenceI * Answers a list of all sequence features associated with this sequence. The * list may be held by the sequence's dataset sequence if that is defined. * - * @return hard reference to array + * @return */ public List getSequenceFeatures(); @@ -511,16 +497,27 @@ public interface SequenceI extends ASequenceI public List getPrimaryDBRefs(); /** - * Returns a (possibly empty) list of sequence features that overlap the range - * from-to (inclusive), optionally restricted to one or more specified feature - * types + * Returns a (possibly empty) list of sequence features that overlap the given + * alignment column range, optionally restricted to one or more specified + * feature types. If the range is all gaps, then features which enclose it are + * included (but not contact features). * - * @param from - * @param to + * @param fromCol + * start column of range inclusive (1..) + * @param toCol + * end column of range inclusive (1..) * @param types + * optional feature types to restrict results to * @return */ - List findFeatures(int from, int to, String... types); + List findFeatures(int fromCol, int toCol, String... types); + + /** + * Method to call to indicate that the sequence (characters or alignment/gaps) + * has been modified. Provided to allow any cursors on residue/column + * positions to be invalidated. + */ + void sequenceChanged(); /** * @@ -528,4 +525,13 @@ public interface SequenceI extends ASequenceI * returns true. */ BitSet getInsertionsAsBits(); + + /** + * Replaces every occurrence of c1 in the sequence with c2 and returns the + * number of characters changed + * + * @param c1 + * @param c2 + */ + public int replace(char c1, char c2); }