X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fjalview%2Fdatamodel%2FSequenceI.java;h=8376047444fb4cff5840e33e4ec2d7c036f44554;hb=40d0dccb97f3e3fd9503ae7acc55e2a8ec85977d;hp=194f1445fb9618a72361b12d4da862ce1c0afacd;hpb=27e20b88d0c73ced06e9c20a6e0fa14e27fed179;p=jalview.git
diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java
index 194f144..8376047 100755
--- a/src/jalview/datamodel/SequenceI.java
+++ b/src/jalview/datamodel/SequenceI.java
@@ -1,23 +1,26 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * 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.
- *
+ * 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 .
+ * 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.List;
import java.util.Vector;
import fr.orsay.lri.varna.models.rna.RNA;
@@ -100,21 +103,21 @@ public interface SequenceI
public String getSequenceAsString();
/**
- * get a range on the seuqence as a string
+ * get a range on the sequence as a string
*
* @param start
- * DOCUMENT ME!
+ * position relative to start of sequence including gaps (from 0)
* @param end
- * DOCUMENT ME!
+ * position relative to start of sequence including gaps (from 0)
*
- * @return DOCUMENT ME!
+ * @return String containing all gap and symbols in specified range
*/
public String getSequenceAsString(int start, int end);
/**
- * DOCUMENT ME!
+ * Get the sequence as a character array
*
- * @return DOCUMENT ME!
+ * @return seqeunce and any gaps
*/
public char[] getSequence();
@@ -134,10 +137,12 @@ public interface SequenceI
* create a new sequence object from start to end of this sequence
*
* @param start
- * int
+ * int index for start position
* @param end
- * int
+ * int index for end position
+ *
* @return SequenceI
+ * @note implementations may use getSequence to get the sequence data
*/
public SequenceI getSubSequence(int start, int end);
@@ -167,14 +172,17 @@ 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 * Return the alignment
+ * position for a sequence position
*
* @param pos
* lying from start to end
*
- * @return aligned column for residue (0 if residue is upstream from alignment, -1 if residue is downstream from alignment)
- * note. Sequence object returns sequence.getEnd() for positions upstream currently. TODO: change sequence for assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
+ * @return aligned column for residue (0 if residue is upstream from
+ * alignment, -1 if residue is downstream from alignment) note.
+ * Sequence object returns sequence.getEnd() for positions upstream
+ * currently. TODO: change sequence for
+ * assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
*
*/
public int findIndex(int pos);
@@ -183,7 +191,7 @@ public interface SequenceI
* Returns the sequence position for an alignment position
*
* @param i
- * column index in alignment (from 1)
+ * column index in alignment (from 0.. getAlignmentAnnotations(String calcId,
+ String label);
+
+ /**
* create a new dataset sequence (if necessary) for this sequence and sets
* this sequence to refer to it. This call will move any features or
- * references on the sequence onto the dataset.
+ * references on the sequence onto the dataset. It will also make a duplicate
+ * of existing annotation rows for the dataset sequence, rather than relocate
+ * them in order to preserve external references (since 2.8.2).
*
* @return dataset sequence for this sequence
*/
@@ -347,34 +368,37 @@ public interface SequenceI
/**
* Transfer any database references or annotation from entry under a sequence
- * mapping.
+ * mapping.
+ * Note: DOES NOT transfer sequence associated alignment
+ * annotation
*
* @param entry
* @param mp
* null or mapping from entry's numbering to local start/end
*/
public void transferAnnotation(SequenceI entry, Mapping mp);
-
+
/**
- * @param index The sequence index in the MSA
+ * @param index
+ * The sequence index in the MSA
*/
public void setIndex(int index);
-
+
/**
* @return The index of the sequence in the alignment
*/
public int getIndex();
-
+
/**
* @return The RNA of the sequence in the alignment
*/
-
+
public RNA getRNA();
-
+
/**
- * @param rna The RNA.
+ * @param rna
+ * The RNA.
*/
public void setRNA(RNA rna);
-
}