+
+ /**
+ * add a reference to a frame of aligned codons for this alignment
+ *
+ * @param codons
+ */
+ public void addCodonFrame(AlignedCodonFrame codons);
+
+ /**
+ * remove a particular codon frame reference from this alignment
+ *
+ * @param codons
+ * @return true if codon frame was removed.
+ */
+ public boolean removeCodonFrame(AlignedCodonFrame codons);
+
+ /**
+ * get all codon frames associated with this alignment
+ *
+ * @return
+ */
+ public AlignedCodonFrame[] getCodonFrames();
+
+ /**
+ * get a particular codon frame
+ *
+ * @param index
+ * @return
+ */
+ public AlignedCodonFrame getCodonFrame(int index);
+
+ /**
+ * get codon frames involving sequenceI
+ */
+ public AlignedCodonFrame[] getCodonFrame(SequenceI seq);
+
+ /**
+ * find sequence with given name in alignment
+ *
+ * @param token
+ * name to find
+ * @param b
+ * true implies that case insensitive matching will <em>also</em> be
+ * tried
+ * @return matched sequence or null
+ */
+ public SequenceI findName(String token, boolean b);
+
+ /**
+ * find next sequence with given name in alignment starting after a given
+ * sequence
+ *
+ * @param startAfter
+ * the sequence after which the search will be started (usually the
+ * result of the last call to findName)
+ * @param token
+ * name to find
+ * @param b
+ * true implies that case insensitive matching will <em>also</em> be
+ * tried
+ * @return matched sequence or null
+ */
+ public SequenceI findName(SequenceI startAfter, String token, boolean b);
+
+ /**
+ * find first sequence in alignment which is involved in the given search
+ * result object
+ *
+ * @param results
+ * @return -1 or index of sequence in alignment
+ */
+ public int findIndex(SearchResults results);
+
+ /**
+ * append sequences and annotation from another alignment object to this one.
+ * Note: this is a straight transfer of object references, and may result in
+ * toappend's dependent data being transformed to fit the alignment (changing
+ * gap characters, etc...). If you are uncertain, use the copy Alignment copy
+ * constructor to create a new version which can be appended without side
+ * effect.
+ *
+ * @param toappend
+ * - the alignment to be appended.
+ */
+ public void append(AlignmentI toappend);
+
+ /**
+ * Justify the sequences to the left or right by deleting and inserting gaps
+ * before the initial residue or after the terminal residue
+ *
+ * @param right
+ * true if alignment padded to right, false to justify to left
+ * @return true if alignment was changed TODO: return undo object
+ */
+ public boolean justify(boolean right);
+
+ /**
+ * add given annotation row at given position (0 is start, -1 is end)
+ *
+ * @param consensus
+ * @param i
+ */
+ public void addAnnotation(AlignmentAnnotation consensus, int i);
+
+ /**
+ * search for or create a specific annotation row on the alignment
+ *
+ * @param name
+ * name for annotation (must match)
+ * @param calcId
+ * calcId for the annotation (null or must match)
+ * @param autoCalc
+ * - value of autocalc flag for the annotation
+ * @param seqRef
+ * - null or specific sequence reference
+ * @param groupRef
+ * - null or specific group reference
+ * @param method
+ * - CalcId for the annotation (must match)
+ *
+ * @return existing annotation matching the given attributes
+ */
+ public AlignmentAnnotation findOrCreateAnnotation(String name,
+ String calcId, boolean autoCalc, SequenceI seqRef,
+ SequenceGroup groupRef);
+
+ /**
+ * move the given group up or down in the alignment by the given number of
+ * rows. Implementor assumes given group is already present on alignment - no
+ * recalculations are triggered.
+ *
+ * @param sg
+ * @param map
+ * @param up
+ * @param i
+ */
+ public void moveSelectedSequencesByOne(SequenceGroup sg,
+ Map<SequenceI, SequenceCollectionI> map, boolean up);
+
+ /**
+ * validate annotation after an edit and update any alignment state flags
+ * accordingly
+ *
+ * @param alignmentAnnotation
+ */
+ public void validateAnnotation(AlignmentAnnotation alignmentAnnotation);