src/jalview/datamodel/AlignmentI.java

   1 /*\r
   2 * Jalview - A Sequence Alignment Editor and Viewer\r
   3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4 *\r
   5 * This program is free software; you can redistribute it and/or\r
   6 * modify it under the terms of the GNU General Public License\r
   7 * as published by the Free Software Foundation; either version 2\r
   8 * of the License, or (at your option) any later version.\r
   9 *\r
  10 * This program is distributed in the hope that it will be useful,\r
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 * GNU General Public License for more details.\r
  14 *\r
  15 * You should have received a copy of the GNU General Public License\r
  16 * along with this program; if not, write to the Free Software\r
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18 */\r
  19 package jalview.datamodel;\r
  20 \r
  21 import java.util.*;\r
  22 \r
  23 \r
  24 /** Data structure to hold and manipulate a multiple sequence alignment\r
  25  */\r
  26 public interface AlignmentI\r
  27 {\r
  28     /**\r
  29      *  Calculates the number of sequences in an alignment\r
  30      *\r
  31      * @return Number of sequences in alignment\r
  32      */\r
  33     public int getHeight();\r
  34 \r
  35     /**\r
  36      * Calculates the maximum width of the alignment, including gaps.\r
  37      *\r
  38      * @return Greatest sequence length within alignment.\r
  39      */\r
  40     public int getWidth();\r
  41 \r
  42     /**\r
  43      * Calculates the longest sequence Id of the alignment\r
  44      *\r
  45      * @return Number of characters in longest sequence Id.\r
  46      */\r
  47     public int getMaxIdLength();\r
  48 \r
  49     /**\r
  50      * Calculates if this set of sequences is all the same length\r
  51      *\r
  52      * @return true if all sequences in alignment are the same length\r
  53      */\r
  54     public boolean isAligned();\r
  55 \r
  56     /**\r
  57      * Gets sequences as a Vector\r
  58      *\r
  59      * @return All sequences in alignment.\r
  60      */\r
  61     public Vector getSequences();\r
  62 \r
  63     /**\r
  64      * Gets sequences as a SequenceI[]\r
  65      *\r
  66      * @return All sequences in alignment.\r
  67      */\r
  68     public SequenceI [] getSequencesArray();\r
  69 \r
  70     /**\r
  71      * Find a specific sequence in this alignment.\r
  72      *\r
  73      * @param i Index of required sequence.\r
  74      *\r
  75      * @return SequenceI at given index.\r
  76      */\r
  77     public SequenceI getSequenceAt(int i);\r
  78 \r
  79     /**\r
  80      * Add a new sequence to this alignment.\r
  81      *\r
  82      * @param seq New sequence will be added at end of alignment.\r
  83      */\r
  84     public void addSequence(SequenceI seq);\r
  85 \r
  86     /**\r
  87      * Used to set a particular index of the alignment with the given sequence.\r
  88      *\r
  89      * @param i Index of sequence to be updated.\r
  90      * @param seq New sequence to be inserted.\r
  91      */\r
  92     public void setSequenceAt(int i, SequenceI seq);\r
  93 \r
  94     /**\r
  95      * Deletes a sequence from the alignment.\r
  96      *\r
  97      * @param s Sequence to be deleted.\r
  98      */\r
  99     public void deleteSequence(SequenceI s);\r
 100 \r
 101     /**\r
 102      * Deletes a sequence from the alignment.\r
 103      *\r
 104      * @param i Index of sequence to be deleted.\r
 105      */\r
 106     public void deleteSequence(int i);\r
 107 \r
 108     /**\r
 109      * Deletes all residues in every sequence of alignment within given columns.\r
 110      *\r
 111      * @param start Start index of columns to delete.\r
 112      * @param end End index to columns to delete.\r
 113      */\r
 114     public void deleteColumns(SequenceI seqs [], int start, int end);\r
 115 \r
 116 \r
 117     /**\r
 118      * Finds sequence in alignment using sequence name as query.\r
 119      *\r
 120      * @param name Id of sequence to search for.\r
 121      *\r
 122      * @return Sequence matching query, if found. If not found returns null.\r
 123      */\r
 124     public SequenceI findName(String name);\r
 125 \r
 126     public SequenceI [] findSequenceMatch(String name);\r
 127 \r
 128     /**\r
 129      * Finds index of a given sequence in the alignment.\r
 130      *\r
 131      * @param s Sequence to look for.\r
 132      *\r
 133      * @return Index of sequence within the alignment.\r
 134      */\r
 135     public int findIndex(SequenceI s);\r
 136 \r
 137     /**\r
 138     * All sequences will be cut from beginning to given index.\r
 139     *\r
 140     * @param i Remove all residues in sequences up to this column.\r
 141      */\r
 142     public void trimLeft(int i);\r
 143 \r
 144     /**\r
 145      * All sequences will be cut from given index.\r
 146      *\r
 147      * @param i Remove all residues in sequences beyond this column.\r
 148      */\r
 149     public void trimRight(int i);\r
 150 \r
 151     /**\r
 152      * Removes all columns containing entirely gap characters.\r
 153      */\r
 154     public void removeGaps();\r
 155 \r
 156 \r
 157 \r
 158     /**\r
 159      * Finds group that given sequence is part of.\r
 160      *\r
 161      * @param s Sequence in alignment.\r
 162      *\r
 163      * @return First group found for sequence. WARNING :\r
 164      * Sequences may be members of several groups. This method is incomplete.\r
 165      */\r
 166     public SequenceGroup findGroup(SequenceI s);\r
 167 \r
 168     /**\r
 169      * Finds all groups that a given sequence is part of.\r
 170      *\r
 171      * @param s Sequence in alignment.\r
 172      *\r
 173      * @return All groups containing given sequence.\r
 174      */\r
 175     public SequenceGroup[] findAllGroups(SequenceI s);\r
 176 \r
 177     /**\r
 178      * Adds a new SequenceGroup to this alignment.\r
 179      *\r
 180      * @param sg New group to be added.\r
 181      */\r
 182     public void addGroup(SequenceGroup sg);\r
 183 \r
 184     /**\r
 185      * Deletes a specific SequenceGroup\r
 186      *\r
 187      * @param g Group will be deleted from alignment.\r
 188      */\r
 189     public void deleteGroup(SequenceGroup g);\r
 190 \r
 191     /**\r
 192      * Get all the groups associated with this alignment.\r
 193      *\r
 194      * @return All groups as a Vector.\r
 195      */\r
 196     public Vector getGroups();\r
 197 \r
 198     /**\r
 199      * Deletes all groups from this alignment.\r
 200      */\r
 201     public void deleteAllGroups();\r
 202 \r
 203 \r
 204     /**\r
 205      * Adds a new AlignmentAnnotation to this alignment\r
 206      */\r
 207     public void addAnnotation(AlignmentAnnotation aa);\r
 208 \r
 209 \r
 210     public void setAnnotationIndex(AlignmentAnnotation aa, int index);\r
 211 \r
 212     /**\r
 213      * Deletes a specific AlignmentAnnotation from the alignment.\r
 214      *\r
 215      * @param aa DOCUMENT ME!\r
 216      */\r
 217     public void deleteAnnotation(AlignmentAnnotation aa);\r
 218 \r
 219     /**\r
 220      * DOCUMENT ME!\r
 221      *\r
 222      * @return DOCUMENT ME!\r
 223      */\r
 224     public AlignmentAnnotation[] getAlignmentAnnotation();\r
 225 \r
 226     /**\r
 227      * DOCUMENT ME!\r
 228      *\r
 229      * @param gc DOCUMENT ME!\r
 230      */\r
 231     public void setGapCharacter(char gc);\r
 232 \r
 233     /**\r
 234      * DOCUMENT ME!\r
 235      *\r
 236      * @return DOCUMENT ME!\r
 237      */\r
 238     public char getGapCharacter();\r
 239 \r
 240     /**\r
 241      * DOCUMENT ME!\r
 242      *\r
 243      * @return DOCUMENT ME!\r
 244      */\r
 245     public Vector getAAFrequency();\r
 246 \r
 247     /**\r
 248      * Returns true if alignment is nucleotide sequence\r
 249      *\r
 250      * @return DOCUMENT ME!\r
 251      */\r
 252     public boolean isNucleotide();\r
 253 \r
 254     /**\r
 255      * Set true if the alignment is a nucleotide sequence\r
 256      *\r
 257      * @return\r
 258      */\r
 259     public void setNucleotide(boolean b);\r
 260 \r
 261 \r
 262     public Alignment getDataset();\r
 263 \r
 264     public void setDataset(Alignment dataset);\r
 265     /**\r
 266      * pads sequences with gaps (to ensure the set looks like an alignment)\r
 267      * @return boolean true if alignment was modified\r
 268      */\r
 269     public boolean padGaps();\r
 270 \r
 271     public void adjustSequenceAnnotations();\r
 272 \r
 273     public HiddenSequences getHiddenSequences();\r
 274     /**\r
 275      * Compact representation of alignment\r
 276      * @return CigarArray\r
 277      */\r
 278     public CigarArray getCompactAlignment();\r
 279 }\r